Revision 992919 of places/favicon

{{AddonSidebar}}

<div class="note">
<p>Unstable</p>
</div>

<p><span class="seoSummary">Helper functions for working with favicons.</span></p>

<h2 id="Globals">Globals</h2>

<h3 id="Functions">Functions</h3>

<h4 class="addon-sdk-api-name" id="getFavicon(object_callback)"><code>getFavicon(object, callback)</code></h4>

<p>Takes an <code>object</code> that represents a page's URL and returns a promise that resolves with the favicon URL for that page. The <code>object</code> can be a URL <code>String</code> or a <a href="/en-US/Add-ons/SDK/High-Level_APIs/tabs#Tab"><code>Tab</code></a>. The platform service (<a href="https://developer.mozilla.org/en-US/docs/XPCOM_Interface_Reference/mozIAsyncFavicons">mozIAsyncFavicons</a>) retrieves favicon data stored from previously visited sites, and as such, will only return favicon URLs for visited sites.</p>

<pre class="brush: js">
let { getFavicon } = require("sdk/places/favicon");

// String example
getFavicon("https://mozilla.org").then(function (url) {
  console.log(url); // https://mozorg.cdn.mozilla.net/media/img/favicon.ico
});

// Tab example
require("sdk/tabs").open({
  url: "https://mozilla.org",
  onReady: function (tab) {
    getFavicon(tab).then(function (url) {
      console.log(url); // https://mozorg.cdn.mozilla.net/media/img/favicon.ico
    });
  }
});

// An optional callback can be provided to handle
// the promise's resolve and reject states
getFavicon("https://mozilla.org", function (url) {
  console.log(url); // https://mozorg.cdn.mozilla.net/media/img/favicon.ico
});</pre>

<h5 id="Parameters">Parameters</h5>

<p><strong>object : string|tab</strong><br />
 A value that represents the URL of the page to get the favicon URL from. Can be a URL <code>String</code> or a <a href="/en-US/Add-ons/SDK/High-Level_APIs/tabs#Tab"><code>Tab</code></a>.</p>

<p><strong>callback : function</strong><br />
 An optional callback function that will be used in both resolve and reject cases.</p>

<h5 id="Returns">Returns</h5>

<p><strong>promise</strong> : A promise that resolves with the favicon URL.</p>