Interface nsITextToSubURIType

Hierarchy

Methods

AddRef ConvertAndEscape QueryInterface Release UnEscapeAndConvert unEscapeNonAsciiURI unEscapeURIForUI

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

ConvertAndEscape

  • Parameters

    • charset: string
    • text: string

    Returns string

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

UnEscapeAndConvert

  • Parameters

    • charset: string
    • text: string

    Returns string

unEscapeNonAsciiURI

  • Unescapes only non ASCII characters in the given URI fragment note: this method assumes the URI as UTF-8 and fallbacks to the given charset if the charset is an ASCII superset

    Returns

    Unescaped aURIFragment converted to unicode

    Throws

    NS_ERROR_UCONV_NOCONV when there is no decoder for aCharset or NS_ERROR_UDEC_ILLEGALINPUT in case of conversion failure

    Parameters

    • aCharset: string

      the charset to convert from

    • aURIFragment: string

      the URI (or URI fragment) to unescape

    Returns string

unEscapeURIForUI

  • Unescapes the given URI fragment (for UI purpose only) Note:

    • escaping back the result (unescaped string) is not guaranteed to give the original escaped string
    • The URI fragment (escaped) is assumed to be in UTF-8 and converted to AString (UTF-16)
    • In case of successful conversion any resulting character listed in netwerk/dns/IDNCharacterBlocklist.inc (except space) is escaped
    • Always succeeeds (callers don't need to do error checking)

    Returns

    Unescaped aURIFragment converted to unicode

    Parameters

    • aURIFragment: string

      the URI (or URI fragment) to unescape

    • aDontEscape: boolean

      whether to escape IDN blocklisted characters

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc