Renaming getThumbnailURI -> getThumbnail and updating docs accordingly.

mozilla · Dec 7, 2010 · c47ed8d · c47ed8d
1 parent ae8d08c
commit c47ed8d
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 8 deletions.
diff --git a/packages/addon-kit/docs/tabs.md b/packages/addon-kit/docs/tabs.md
@@ -191,19 +191,18 @@ The index of the tab relative to other tabs in the application window.
 This property can be set to change it's relative position.
 </api>
 
-<api name="thumbnail">
-@property {string}
-Data URI of a thumbnail of the page currently loaded in the tab.
-This property is read-only.
-</api>
-
 <api name="isPinned">
 @property {boolean}
 Whether or not tab is pinned as an [app tab].
 This property is read-only.
 [app tab]:http://blog.mozilla.com/faaborg/2010/07/28/app-tabs-in-firefox-4-beta-2/
 </api>
 
+<api name="getThumbnail">
+@property {method}
+Returns thumbnail data URI of the page currently loaded in this tab.
+</api>
+
 <api name="pin">
 @method
 Pins this tab as an [app tab].

diff --git a/packages/addon-kit/tests/test-tabs.js b/packages/addon-kit/tests/test-tabs.js
@@ -99,7 +99,7 @@ exports.testTabProperties = function(test) {
         test.assert(tab.favicon, "favicon of the new tab is not empty");
         test.assertEqual(tab.style, null, "style of the new tab matches");
         test.assertEqual(tab.index, 1, "index of the new tab matches");
-        test.assertNotEqual(tab.getThumbnailURL(), null, "thumbnail of the new tab matches");
+        test.assertNotEqual(tab.getThumbnail(), null, "thumbnail of the new tab matches");
         closeBrowserWindow(window, function() test.done());
       }
     });

diff --git a/packages/api-utils/lib/tabs/tab.js b/packages/api-utils/lib/tabs/tab.js
@@ -173,7 +173,7 @@ const TabTrait = Trait.compose(EventEmitter, {
    * Thumbnail data URI of the page currently loaded in this tab.
    * @type {String}
    */
-  getThumbnailURL: function getThumbnailURL()
+  getThumbnail: function getThumbnail()
     getThumbnailURIForWindow(this._contentWindow),
   /**
    * Whether or not tab is pinned (Is an app-tab).