Optional
aInstancePtr: objectA run time mechanism for interface discovery.
NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.
aInstancePtr must not be null.
[in] A requested interface IID
[out] A pointer to an interface pointer to receive the result.
Initialize FOG.
To be scheduled at some opportune time after the bulk of Firefox startup has completed.
The path of a custom Glean data path to use instead of the profile dir.
The application_id to use instead of "firefox.desktop".
Send the named ping. See https://firefox-source-docs.mozilla.org/toolkit/components/glean/testing.html for details.
The name of the ping to send. If no ping of that name exists, or the ping is known but cannot be assembled (e.g if it is empty), no ping will be sent.
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.
The id/slug of the experiment.
The name of the active branch of the experiment.
Optional string -> string dictionary of extra information.
Enable or Disable the logging of pings in the Glean SDK. See https://firefox-source-docs.mozilla.org/toolkit/components/glean/testing.html for details.
true to enable logging, false to disable.
Set remote-configuration for metrics' disabled property.
See [glean_core::Glean::set_metrics_disabled_config
]
Logs on error, but does not throw.
The stringified JSON object in the form {metric_base_identifier: boolean,} which may contain multiple metric object entries.
Set the tag to be applied to pings assembled from now on. See https://firefox-source-docs.mozilla.org/toolkit/components/glean/testing.html for details.
The string tag to apply. If it cannot be applied (e.g it contains characters that are forbidden in HTTP headers) the old value will remain.
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.
an object of the form {branch: "branch-name", extra: {extra_key1: extra_value1, ...}} if there is an active experiment. Undefined, otherwise.
The id/slug of the experiment from setExperimentActive.
** 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.
The metric's type.
The metric's category.
The metric's name.
The pings to send it in.
The metric's lifetime.
Whether the metric, though existing, isn't enabled.
Optional JSON string of extra args.
** 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.
The ping's name.
Whether the ping should include the client_id.
Whether the ping should send even if empty.
The list of valid reasons for ping submission.
** Test-only Method **
Trigger test metric instrumentation on the GPU, RDD or Socket process.
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.
A PROCESS_TYPE_* value from the constants defined in the nsIXULRuntime interface.
Generated using TypeDoc
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.