Interface nsIFOGType

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 FOG.

    To be scheduled at some opportune time after the bulk of Firefox startup has completed.

    Parameters

    • aDataPathOverride: string

      The path of a custom Glean data path to use instead of the profile dir.

    • aAppIdOverride: string

      The application_id to use instead of "firefox.desktop".

    Returns void

  • Register custom pings.

    Ensure all custom pings are registered with Glean.

    Returns void

  • Indicate that an experiment is running. Glean will add an experiment annotation which is sent with pings. This information is not persisted between runs.

    See glean_core::Glean::set_experiment_active.

    Logs on error, but does not throw.

    Parameters

    • aExperimentId: string

      The id/slug of the experiment.

    • aBranch: string

      The name of the active branch of the experiment.

    • aExtra: any

      Optional string -> string dictionary of extra information.

    Returns void

  • Indicate that an experiment is no longer running.

    See glean_core::Glean::set_experiment_inactive.

    Logs on error, but does not throw.

    Parameters

    • aExperimentId: string

      The id/slug of the experiment from setExperimentActive.

    Returns void

  • Set remote-configuration for metrics' disabled property.

    See [glean_core::Glean::set_metrics_disabled_config]

    Logs on error, but does not throw.

    Parameters

    • aJsonConfig: string

      The stringified JSON object in the form {metric_base_identifier: boolean,} which may contain multiple metric object entries.

    Returns void

  • ** Test-only Method **

    Flush all data from all child processes.

    Returns

    A promise that resolves when the data's been stored.

    Returns any

  • Test-only API

    If the identified experiment was set active and hasn't been set inactive, this will give you the active branch and extra information.

    Returns

    an object of the form {branch: "branch-name", extra: {extra_key1: extra_value1, ...}} if there is an active experiment. Undefined, otherwise.

    Parameters

    • aExperimentId: string

      The id/slug of the experiment from setExperimentActive.

    Returns any

  • ** Test-only Method **

    Register a metric.

    This function is deliberately not too friendly to use. You probably aren't supposed to use it unless you're testing metric registration itself.

    Parameters

    • aType: string

      The metric's type.

    • aCategory: string

      The metric's category.

    • aName: string

      The metric's name.

    • aPings: invalid

      The pings to send it in.

    • aLifetime: string

      The metric's lifetime.

    • aDisabled: boolean

      Whether the metric, though existing, isn't enabled.

    • aExtraArgs: string

      Optional JSON string of extra args.

    Returns uint32_t

  • ** Test-only Method **

    Register a ping.

    This function is deliberately not too friendly to use. You probably aren't supposed to use it unless you're testing ping registration itself.

    Parameters

    • aName: string

      The ping's name.

    • aIncludeClientId: boolean

      Whether the ping should include the client_id.

    • aSendIfEmpty: boolean

      Whether the ping should send even if empty.

    • aReasonCodes: invalid

      The list of valid reasons for ping submission.

    Returns uint32_t

  • ** Test-only Method **

    Reset FOG and the Glean SDK, clearing storage.

    Parameters

    • aDataPathOverride: string
    • aAppIdOverride: string

    Returns void

  • ** Test-only Method **

    Trigger test metric instrumentation on the GPU, RDD or Socket process.

    Returns

    A promise that resolves when the test data has been added. The promise will be rejected if the process type is not supported or if sending the IPC to the child process fails.

    Parameters

    • aProcessType: number

      A PROCESS_TYPE_* value from the constants defined in the nsIXULRuntime interface.

    Returns any

Generated using TypeDoc