Interface nsIGleanDatetimeType

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

  • Set the datetime to the provided value, or the local now. The internal value will store the local timezone.

    Note: The metric's time_unit affects the resolution of the value, not the unit of this function's parameter (which is always PRTime/nanos).

    Parameters

    • aValue: number

      The (optional) time value as PRTime (nanoseconds since epoch). Defaults to local now.

    Returns void

  • Test-only API

    Gets the currently stored value as an integer.

    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 as a JS Date with timezone, 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

Generated using TypeDoc