Interface nsIGleanStringListType

Hierarchy

Methods

AddRef QueryInterface Release add set testGetValue

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

add

  • Adds a new string to the list.

    Truncates the value and logs an error if it is longer than 50 bytes.

    Parameters

    • value: string

      The string to add.

    Returns void

set

  • Sets to a specific list of strings.

    Truncates the list and logs an error if longer than 20 items. Truncates any item longer than 50 bytes and logs an error.

    Parameters

    • value: invalid

      The list of strings to set.

    Returns void

testGetValue

  • Test-only API

    Gets the currently stored value.

    This function will attempt to await the last parent-process task (if any) writing to the the metric's storage engine before returning a value. This function will not wait for data from child processes.

    This doesn't clear the stored value. Parent process only. Panics in child processes.

    Returns

    value of the stored metric, or undefined if there is no value.

    Parameters

    • aPingName: string

      The (optional) name of the ping to retrieve the metric for. Defaults to the first value in send_in_pings.

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc