Extensions
The following extensions are available globally.
-
-
-
-
-
-
-
The expiry time of the token, in seconds.
This is the timestamp at which the token is set to expire, in seconds since unix epoch. Note that it is a signed integer, for compatibility with languages that do not have an unsigned integer type.
This timestamp is for guidance only. Access tokens are not guaranteed to remain value for any particular lengthof time, and consumers should be prepared to handle auth failures even if the token has not yet expired.
-
-
-
-
The URLs of the tabs to close.
-
-
-
-
URL for the user’s Sync Tokenserver. This can be used to support users who self-host their sync data. If
None
then it will default to the Mozilla-hosted Sync server. -
-
Whether the
avatar
URL represents the default avatar image. -
An opaque unique identifier for this key.
Unlike the
k
field, this value is not secret and may be revealed to the server. -
A unique identifier to be included in send-tab metrics.
The application should treat this as opaque.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
App context to use for JEXL filtering (when the
jexl
feature is present). -
Extra attributes to add to the env for JEXL filtering.
Use this for prototyping / testing new features. In the long-term, new fields should be added to the official list and supported by both the Rust and Gecko clients.
-
-
-
The target field from the Rust log crate. Usually the Rust module name, however log! calls can manually override the target name.
-
-
The name of the query parameter for the search term. Automatically appended to the end of the query. This may be skipped if
{searchTerm}
is included in the base. -
The URL of the search engine homepage.
-
If specified, the identifier of the engine that should be used for the application default engine in private browsing mode. Only desktop uses this currently.
-
The url used for reporting clicks.
-
The name of the query parameter for the search term. Automatically appended to the end of the query. This may be skipped if
{searchTerm}
is included in the base. -
The URL of the search engine homepage.
-
The value for the parameter will be derived from the equivalent experiment configuration value. Only desktop uses this currently.
-
The device type that the user is using.
-
-
-
-
-
-
Did the match require stemming? (
run shoes
matched againstrunning shoes
) -
Population size.
-
Whether the name was matched by prefix.
-
Time in microseconds
-
Samples for the
suggest.query_time
metric -
-
Only run ingestion if the table
suggestions
is empty -
Samples for the
suggest.ingestion_download_time
metric -
Which strategy should we use for the AMP queries? Use None for the default strategy.
-
-
-
-
-
-
Threshold for weather keyword prefix matching when a weather keyword is the first term in a query. Zero means prefix matching is disabled and weather keywords must be typed in full when they are first in the query. (Ideally this would be an
Option
andNone
would mean full keywords are required, but it’s probably not worth the breaking API change.) This threshold does not apply to city and region names. -
This value is optionally defined in the suggestion’s remote settings data and is an opaque token used for dismissing the suggestion in lieu of a URL. If
Some
, the suggestion can be dismissed by passing the wrapped string to [crate::SuggestStore::dismiss_suggestion]. -
-
-
-
-
Information about the current device, such as its name, formfactor and FxA device ID.
-
JSON string encoding a
SyncTelemetryPing
object -
-
-
-
Number of ms since the unix epoch (as reported by the server’s clock)
-
-
Number of ms since the unix epoch (as reported by the client’s clock)
-