Readonly defaultReadonly defaultThe default favicon mimeType
Optional aInstancePtr: objectA run time mechanism for interface discovery.
NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.
aInstancePtr must not be null.
[in] A requested interface IID
[out] A pointer to an interface pointer to receive the result.
Copies cached favicons from a page to another one.
URI of the originating page.
URI of the destination page.
Set to FAVICON_LOAD_PRIVATE if the copy is started from a private browsing window. Set to FAVICON_LOAD_NON_PRIVATE otherwise.
Retrieves the favicon URI and data associated to the given page, if any. If the page icon is not available, it will try to return the root domain icon data, when it's known.
If a favicon specific to this page cannot be found, this will try to fallback to the /favicon.ico for the root domain.
nsIFaviconDataCallback in nsIFaviconService.idl.
URI of the page whose favicon URI and data we're looking up.
This callback is always invoked to notify the result of the lookup. The aURI parameter will be the favicon URI, or null when no favicon is associated with the page or an error occurred while fetching it. If aURI is not null, the other parameters may contain the favicon data. However, if no favicon data is currently associated with the favicon URI, aDataLen will be 0, aData will be an empty array, and aMimeType will be an empty string.
For a given icon URI, this will return a URI that will result in the image. In most cases, this is an annotation URI. For chrome URIs, this will do nothing but returning the input URI.
No validity checking is done. If you pass an icon URI that we've never seen, you'll get back a URI that references an invalid icon. The moz-anno protocol handler's special case for "favicon" annotations will resolve invalid icons to the default icon, although without caching. For invalid chrome URIs, you'll get a broken image.
A URI that will give you the icon image. This is NOT the URI of the icon as set on the page, but a URI that will give you the data out of the favicon service. For a normal page with a favicon we've stored, this will be an annotation URI which will then cause the corresponding favicon data to be loaded async from this service. For pages where we don't have a favicon, this will be a chrome URI of the default icon. For chrome URIs, the output will be the same as the input.
The URI of an icon in the favicon service.
Retrieves the favicon URI associated to the given page, if any.
If a favicon specific to this page cannot be found, this will try to fallback to the /favicon.ico for the root domain.
nsIFaviconDataCallback in nsIFaviconService.idl.
URI of the page whose favicon URI we're looking up.
This callback is always invoked to notify the result of the lookup. The aURI parameter will be the favicon URI, or null when no favicon is associated with the page or an error occurred while fetching it. aDataLen will be always 0, aData will be an empty array, and aMimeType will be an empty string, regardless of whether a favicon was found.
Sets the data for a given favicon URI either by replacing existing data in the database or taking the place of otherwise fetched icon data when calling setAndFetchFaviconForPage later.
Favicon data for favicon URIs that are not associated with a page URI via setAndFetchFaviconForPage will be stored in memory, but may be expired at any time, so you should make an effort to associate favicon URIs with page URIs as soon as possible.
It's better to not use this function for chrome: icon URIs since you can reference the chrome image yourself. getFaviconLinkForIcon/Page will ignore any associated data if the favicon URI is "chrome:" and just return the same chrome URI.
This function does NOT send out notifications that the data has changed. Pages using this favicons that are visible in history or bookmarks views will keep the old icon until they have been refreshed by other means.
This function tries to optimize the favicon size, if it is bigger than a defined limit we will try to convert it to a 16x16 png image. If the conversion fails and favicon is still bigger than our max accepted size it won't be saved.
NS_ERROR_FAILURE Thrown if the favicon is overbloated and won't be saved to the db.
URI of the favicon whose data is being set.
Binary contents of the favicon to save
MIME type of the data to store. This is important so that we know what to report when the favicon is used. You should always set this param unless you are clearing an icon.
Same as replaceFaviconData but the data is provided by a string containing a data URL.
replaceFaviconData
NS_ERROR_FAILURE Thrown if the favicon is overbloated and won't be saved to the db.
URI of the favicon whose data is being set.
string containing a data URL that represents the contents of the favicon to save
Declares that a given page uses a favicon with the given URI and attempts to fetch and save the icon data by loading the favicon URI through an async network request.
If the icon data already exists, we won't try to reload the icon unless aForceReload is true. Similarly, if the icon is in the failed favicon cache we won't do anything unless aForceReload is true, in which case we'll try to reload the favicon.
This function will only save favicons for pages that are already stored in the database, like visited pages or bookmarks. For any other URIs, it will succeed but do nothing. This function will also ignore the error page favicon URI (see FAVICON_ERRORPAGE_URL below).
Icons that fail to load will automatically be added to the failed favicon cache, and this function will not save favicons for non-bookmarked URIs when history is disabled.
This function is identical to nsIFaviconService::setAndLoadFaviconForPage.
nsIFaviconDataCallback in nsIFaviconService.idl.
URI of the page whose favicon is being set.
URI of the favicon to associate with the page.
If aForceReload is false, we try to reload the favicon only if we don't have it or it has expired from the cache. Setting aForceReload to true causes us to reload the favicon even if we have a usable copy.
Set to FAVICON_LOAD_PRIVATE if the favicon is loaded from a private browsing window. Set to FAVICON_LOAD_NON_PRIVATE otherwise.
Sets the default size returned by preferredSizeFromURI when the uri doesn't specify a size ref. If this is not invoked first, or 0 is passed to it, preferredSizeFromURI() will return UINT16_MAX, that matches the biggest icon available.
Generated using TypeDoc
The default favicon URI