This interface provides support for a uniform resource identifier (URI) w/ i18n support. It is scriptable.
URIs are essentially structured names for things -- anything. This interface provides accessors to set and query the most basic components of an URI. Subclasses, including
nsIURL, impose greater structure on the URI.
This interface follows Tim Berners-Lee's URI spec (RFC2396) , where the basic URI components are defined as such:
The definition of the URI components has been extended to allow for internationalized domain names  and the more generic IRI structure .
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 not advised 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.
Performs a URI equivalence test (not a strict string comparison), eg. http://foo.com:80/ == http://foo.com/ between this URI and another URI.
boolean nsIURI::equals(in nsIURI other)
if the URIs are equivalent.
Does scheme checks without requiring the users of
GetScheme, thereby saving extra allocating and freeing.
boolean nsIURI::schemeIs(in string scheme)
The scheme to be checked.
if the schemes match (case ignored).
Clones the current URI. For some protocols, this is more than just an optimization. For example, under MacOS, the spec of a file URL does not necessarily uniquely identify a file since two volumes could share the same name.
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.
AUTF8String nsIURI::resolve(in AUTF8String relativePath)
: The string to be resolved.
attribute AUTF8String nsIURI::spec
Gets and sets a string representation of the URI. Setting the spec causes the new spec to be parsed, initializing the URI. Some characters may be escaped.
readonly attribute AUTF8String nsIURI::prePath
Gets the prePath (eg. scheme://user:password@host:port), ie, the string before the path. This is useful for authentication or managing sessions. Some characters may be escaped.
attribute ACString nsIURI::scheme
Gets and sets the Scheme, which is the protocol to which this URI refers. The scheme is restricted to the US-ASCII charset per RFC2396.
attribute AUTF8String nsIURI::userPass
Gets and sets the username:password (or username only if the value doesn't contain a ':'). Some characters may be escaped.
attribute AUTF8String nsIURI::username
attribute AUTF8String nsIURI::password
Gets and sets the username or password, assuming the
preHost consists of username:password. Some characters may be escaped.
attribute AUTF8String nsIURI::hostPort
Gets and sets the host:port (or simply the host, if port == -1). Characters are NOT escaped.
attribute AUTF8String nsIURI::host
Gets and sets the host, the internet domain name to which this URI refers. It could be an IPv4 (or IPv6) address literal. If supported, it could be a non-ASCII internationalized domain name. Characters are NOT escaped.
attribute long nsIURI::port
Gets and sets the port. A port value of -1 corresponds to the protocol's default port (eg. -1 implies port 80 for http URIs).
attribute AUTF8String nsIURI::path
Gets and sets the path, typically including at least a leading '/' (but may also be empty, depending on the protocol). Some characters may be escaped.
readonly attribute ACString nsIURI::asciiSpec
Gets 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 attribute ACString nsIUIRI::asciiHost
Gets 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.
Gets the charset of the document from which this URI originated. An empty value implies UTF-8. If this value is something other than UTF-8 then the URI components (e.g., spec, prePath, username, etc.) will all be fully URL-escaped. Otherwise, the URI components may contain unescaped multibyte UTF-8 characters.