Interface nsIFaviconDataCallbackType

Hierarchy

Methods

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

  • Called when the required favicon's information is available.

    It's up to the invoking method to state if the callback is always invoked, or called on success only. Check the method documentation to ensure that.

    The caller will receive the most information we can gather on the icon, but it's not guaranteed that all of them will be set. For some method we could not know the favicon's data (it could just be too expensive to get it, or the method does not require we actually have any data). It's up to the caller to check aDataLen > 0 before using any data-related information like mime-type or data itself.

    Note

    If you want to open a network channel to access the favicon, it's recommended that you call the getFaviconLinkForIcon method to convert the "favicon URI" into a "favicon link URI".

    Parameters

    • aFaviconURI: nsIURI

      Receives the "favicon URI" (not the "favicon link URI") associated to the requested page. This can be null if there is no associated favicon URI, or the callback is notifying a failure.

    • aDataLen: number

      Size of the icon data in bytes. Notice that a value of 0 does not necessarily mean that we don't have an icon.

    • aData: number

      Icon data, or an empty array if aDataLen is 0.

    • aMimeType: string

      Mime type of the icon, or an empty string if aDataLen is 0.

    • aWidth: number

      Width of the icon. 0 if the width is unknown or if the icon is vectorial.

    Returns void

Generated using TypeDoc