Interface nsIURLFormatterType

Hierarchy

Methods

AddRef QueryInterface Release formatURL formatURLPref trimSensitiveURLs

Methods

AddRef

  • 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

QueryInterface

  • 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

Release

  • 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

formatURL

  • formatURL - Formats a string URL

    The set of known variables is predefined. If a variable is unknown, it is left unchanged and a non-fatal error is reported.

    Returns

    The formatted URL.

    Parameters

    • aFormat: string

      string Unformatted URL.

    Returns string

formatURLPref

  • formatURLPref - Formats a string URL stored in a preference

    If the preference value cannot be retrieved, a fatal error is reported and the "about:blank" URL is returned.

    Returns

    The formatted URL returned by formatURL(), or "about:blank".

    Parameters

    • aPref: string

      string Preference name.

    Returns string

trimSensitiveURLs

  • Remove all of the sensitive query parameter strings from URLs in |aMsg|.

    Parameters

    • aMsg: string

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc