nsIStandardURL Interface Reference

nsIStandardURL defines the interface to an URL with the standard file path format common to protocols like http, ftp, and file. More...

import "nsIStandardURL.idl";

Inheritance diagram for nsIStandardURL:

Collaboration diagram for nsIStandardURL:

List of all members.

Public Member Functions
void	init (in unsigned long aUrlType, in long aDefaultPort, in AUTF8String aSpec, in string aOriginCharset, in nsIURI aBaseURI)
	Initialize a standard URL.
Public Attributes
const unsigned long	URLTYPE_STANDARD = 1
	blah:foo/bar => blah://foo/bar blah:/foo/bar => blah:///foo/bar blah://foo/bar => blah://foo/bar blah:///foo/bar => blah:///foo/bar
const unsigned long	URLTYPE_AUTHORITY = 2
	blah:foo/bar => blah://foo/bar blah:/foo/bar => blah://foo/bar blah://foo/bar => blah://foo/bar blah:///foo/bar => blah://foo/bar
const unsigned long	URLTYPE_NO_AUTHORITY = 3
	blah:foo/bar => blah:///foo/bar blah:/foo/bar => blah:///foo/bar blah://foo/bar => blah://foo/bar blah:///foo/bar => blah:///foo/bar

---

Detailed Description

nsIStandardURL defines the interface to an URL with the standard file path format common to protocols like http, ftp, and file.

It supports initialization from a relative path and provides some customization on how URLs are normalized.

Status:

UNDER_REVIEW

---

Member Function Documentation

void nsIStandardURL::init	(	in unsigned long	aUrlType,
		in long	aDefaultPort,
		in AUTF8String	aSpec,
		in string	aOriginCharset,
		in nsIURI	aBaseURI
	)

Initialize a standard URL.

Parameters:

	aUrlType	- one of the URLTYPE_ flags listed above.
	aDefaultPort	- if the port parsed from the URL string matches this port, then the port will be removed from the canonical form of the URL.
	aSpec	- URL string.
	aOriginCharset	- the charset from which this URI string originated. this corresponds to the charset that should be used when communicating this URI to an origin server, for example. if null, then provide aBaseURI implements this interface, the origin charset of aBaseURI will be assumed, otherwise defaulting to UTF-8 (i.e., no charset transformation from aSpec).
	aBaseURI	- if null, aSpec must specify an absolute URI. otherwise, aSpec will be resolved relative to aBaseURI.

---

Member Data Documentation

const unsigned long nsIStandardURL::URLTYPE_AUTHORITY = 2

blah:foo/bar => blah://foo/bar blah:/foo/bar => blah://foo/bar blah://foo/bar => blah://foo/bar blah:///foo/bar => blah://foo/bar

const unsigned long nsIStandardURL::URLTYPE_NO_AUTHORITY = 3

blah:foo/bar => blah:///foo/bar blah:/foo/bar => blah:///foo/bar blah://foo/bar => blah://foo/bar blah:///foo/bar => blah:///foo/bar

const unsigned long nsIStandardURL::URLTYPE_STANDARD = 1

blah:foo/bar => blah://foo/bar blah:/foo/bar => blah:///foo/bar blah://foo/bar => blah://foo/bar blah:///foo/bar => blah:///foo/bar

---

The documentation for this interface was generated from the following file:

• nsIStandardURL.idl