Interface nsIStandardURLMutatorType

Hierarchy

Methods

  • 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

  • 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

  • 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

  • Initialize a standard URL.

    Parameters

    • aUrlType: number

      one of the URLTYPE_ flags listed above.

    • aDefaultPort: number

      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: string

      URL string.

    • aOriginCharset: string

      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: nsIURI

      if null, aSpec must specify an absolute URI. otherwise, aSpec will be resolved relative to aBaseURI.

    Returns nsIURIMutator

  • Set the default port.

    Note: If this object is already using its default port (i.e. if it has mPort == -1), then it will now implicitly be using the new default port.

    Parameters

    • aNewDefaultPort: number

      if the URI has (or is later given) a port that matches this default, then we won't include a port number in the canonical form of the URL.

    Returns nsIURIMutator

Generated using TypeDoc