Interface nsIURIType

nsIURI - interface for an uniform resource identifier w/ i18n support.

AUTF8String attributes may contain unescaped UTF-8 characters. Consumers should be careful to escape the UTF-8 strings as necessary, but should always try to "display" the UTF-8 version as provided by this interface.

AUTF8String attributes may also contain escaped characters.

Unescaping URI segments is unadvised unless there is intimate knowledge of the underlying charset or there is no plan to display (or otherwise enforce a charset on) the resulting URI substring.

The correct way to create an nsIURI from a string is via nsIIOService.newURI.

NOTE: nsBinaryInputStream::ReadObject contains a hackaround to intercept the old (pre-gecko6) nsIURI IID and swap in the current IID instead, in order for sessionstore to work after an upgrade. If this IID is revved further, we will need to add additional checks there for all intermediate IIDs, until ContentPrincipal is fixed to serialize its URIs as nsISupports (bug 662693).

Hierarchy

Properties

asciiHost asciiHostPort asciiSpec displayHost displayHostPort displayPrePath displaySpec filePath hasRef host hostPort password pathQueryRef port prePath query ref scheme spec specIgnoringRef userPass username

Methods

AddRef QueryInterface Release equals equalsExceptRef mutate resolve schemeIs serialize

Properties

Readonly asciiHost

asciiHost: string

The URI host with an ASCII compatible encoding. Follows the IDNA draft spec for converting internationalized domain names (UTF-8) to ASCII for compatibility with existing internet infrasture.

Readonly asciiHostPort

asciiHostPort: string

The host:port (or simply the host, if port == -1), with an ASCII compatible encoding. Host portion follows the IDNA draft spec. The result is strictly ASCII.

Readonly asciiSpec

asciiSpec: string

Additional attributes: The URI spec with an ASCII compatible encoding. Host portion follows the IDNA draft spec. Other parts are URL-escaped per the rules of RFC2396. The result is strictly ASCII.

Readonly displayHost

displayHost: string

If the URI has a punycode encoded hostname, this will hold the UTF8 representation of that hostname (if that representation doesn't contain blacklisted characters, and the network.IDN_show_punycode pref is false) Otherwise, if the hostname is ASCII, it will return the same as .asciiHost

Readonly displayHostPort

displayHostPort: string

The displayHost:port (or simply the displayHost, if port == -1).

Readonly displayPrePath

displayPrePath: string

Returns the same as calling .prePath, only with a UTF8 encoded hostname (if that hostname doesn't contain blacklisted characters, and the network.IDN_show_punycode pref is false)

Readonly displaySpec

displaySpec: string

Returns the same as calling .spec, only with a UTF8 encoded hostname (if that hostname doesn't contain blacklisted characters, and the network.IDN_show_punycode pref is false)

Readonly filePath

filePath: string

Additional attributes added for .query support: Returns a path including the directory and file portions of a URL. For example, the filePath of "http://host/foo/bar.html#baz" is "/foo/bar.html".

Some characters may be escaped.

Readonly hasRef

hasRef: boolean

Returns if there is a reference portion (the part after the "#") of the URI.

Readonly host

host: string

The host is the internet domain name to which this URI refers. It could be an IPv4 (or IPv6) address literal. Otherwise it is an ASCII or punycode encoded string.

Readonly hostPort

hostPort: string

The host:port (or simply the host, if port == -1).

Readonly password

password: string

Readonly pathQueryRef

pathQueryRef: string

The path, typically including at least a leading '/' (but may also be empty, depending on the protocol).

Some characters may be escaped.

This attribute contains query and ref parts for historical reasons. Use the 'filePath' attribute if you do not want those parts included.

Readonly port

port: number

A port value of -1 corresponds to the protocol's default port (eg. -1 implies port 80 for http URIs).

Readonly prePath

prePath: string

The prePath (eg. scheme://user:password@host:port) returns the string before the path. This is useful for authentication or managing sessions.

Some characters may be escaped.

Readonly query

query: string

Returns the query portion (the part after the "?") of the URL. If there isn't one, an empty string is returned.

Some characters may be escaped.

Readonly ref

ref: string

Additional attribute & methods added for .ref support: Returns the reference portion (the part after the "#") of the URI. If there isn't one, an empty string is returned.

Some characters may be escaped.

Readonly scheme

scheme: string

The Scheme is the protocol to which this URI refers. The scheme is restricted to the US-ASCII charset per RFC3986.

Readonly spec

spec: string

The URI is broken down into the following principal components: Returns a string representation of the URI.

Some characters may be escaped.

Readonly specIgnoringRef

specIgnoringRef: string

returns a string for the current URI with the ref element cleared.

Readonly userPass

userPass: string

The username:password (or username only if value doesn't contain a ':')

Some characters may be escaped.

Readonly username

username: string

The optional username and password, assuming the preHost consists of username:password.

Some characters may be escaped.

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

equals

  • An URI supports the following methods:

    URI equivalence test (not a strict string comparison).

    eg. http://foo.com:80/ == http://foo.com/

    Parameters

    • other: nsIURI

    Returns boolean

equalsExceptRef

mutate

  • Returns an nsIURIMutator that can be used to make changes to the URI. After performing the setter operations on the mutator, one may call mutator.finalize() to get a new immutable URI with the desired properties.

    Returns nsIURIMutator

resolve

  • This method resolves a relative string into an absolute URI string, using this URI as the base.

    NOTE: some implementations may have no concept of a relative URI.

    Parameters

    • relativePath: string

    Returns string

schemeIs

  • An optimization to do scheme checks without requiring the users of nsIURI to GetScheme, thereby saving extra allocating and freeing. Returns true if the schemes match (case ignored).

    Parameters

    • scheme: string

    Returns boolean

serialize

  • Serializes a URI object to a URIParams data structure in order for being passed over IPC. For deserialization, see nsIURIMutator.

    Parameters

    • aParams: URIParams

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc