Interface nsIGleanPingType

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

  • Collect and submit the ping for eventual upload.

    This will collect all stored data to be included in the ping. Data with lifetime ping will then be reset.

    If the ping is configured with send_if_empty = false and the ping currently contains no content, it will not be queued for upload. If the ping is configured with send_if_empty = true it will be queued for upload even if empty.

    Pings always contain the ping_info and client_info sections. See ping sections for details.

    Parameters

    • aReason: string

      Optional. The reason the ping is being submitted. Must match one of the configured reason_codes.

    Returns void

  • Test-only API

    Register a callback to be called right before this ping is next submitted. The provided function is called exactly once before submitting.

    Note: The callback will be called on any call to submit. A ping might not be sent afterwards, e.g. if the ping is empty and send_if_empty is false.

    Parameters

    • aCallback: nsIGleanPingTestCallback

      The callback to call on the next submit.

    Returns void

Generated using TypeDoc