Interface nsISFVServiceType

nsISFVService provides a set of functions for working with HTTP header value as an object. It exposes functions for creating object from string containing header value, as well as individual components for manual structured header object creation.

Hierarchy

Methods

AddRef QueryInterface Release newBool newByteSequence newDecimal newDictionary newInnerList newInteger newItem newList newParameters newString newToken parseDictionary parseItem parseList

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

newBool

  • Parameters

    • value: bool

    Returns nsISFVBool

newByteSequence

  • Parameters

    • value: string

    Returns nsISFVByteSeq

newDecimal

  • Parameters

    • value: number

    Returns nsISFVDecimal

newDictionary

  • Creates nsISFVDictionary representing Dictionary header value. It is empty by default.

    Returns nsISFVDictionary

newInnerList

  • Creates nsISFVInnerList from nsISFVItem array and nsISFVParams.

    Parameters

    • items: invalid
    • params: nsISFVParams

    Returns nsISFVInnerList

newInteger

  • The following functions create bare item of specific type.

    Parameters

    • value: number

    Returns nsISFVInteger

newItem

  • Creates nsISFVItem, which represents Item header value, from nsISFVBareItem and associated nsISFVParams.

    Parameters

    • value: nsISFVBareItem
    • params: nsISFVParams

    Returns nsISFVItem

newList

  • Creates nsISFVList, which represents List header value, from array of nsISFVItemOrInnerList. nsISFVItemOrInnerList represens either Item (nsISFVItem) or Inner List (nsISFVInnerList).

    Parameters

    • members: invalid

    Returns nsISFVList

newParameters

  • Creates nsISFVParams with no parameters. In other words, it's an empty map byt default.

    Returns nsISFVParams

newString

  • Parameters

    • value: string

    Returns nsISFVString

newToken

  • Parameters

    • value: string

    Returns nsISFVToken

parseDictionary

  • Parses provided string into Dictionary header value (nsISFVDictionary).

    Throws

    NS_ERROR_FAILURE if parsing fails.

    Parameters

    • header: string

    Returns nsISFVDictionary

parseItem

  • Parses provided string into Item header value (nsISFVItem).

    Throws

    NS_ERROR_FAILURE if parsing fails.

    Parameters

    • header: string

    Returns nsISFVItem

parseList

  • Parses provided string into List header value (nsISFVList).

    Throws

    NS_ERROR_FAILURE if parsing fails.

    Parameters

    • header: string

    Returns nsISFVList

Settings

Member Visibility

Theme

Generated using TypeDoc