Structures
The following structures are available globally.
-
Declaration
Swift
public struct MozAdsCacheConfig : Equatable, Hashableextension MozAdsCacheConfig: Sendable -
Declaration
Swift
public struct MozAdsCallbacks : Equatable, Hashableextension MozAdsCallbacks: Sendable -
Declaration
Swift
public struct MozAdsContentCategory : Equatable, Hashableextension MozAdsContentCategory: Sendable -
Declaration
Swift
public struct MozAdsIabContent : Equatable, Hashableextension MozAdsIabContent: Sendable -
Declaration
Swift
public struct MozAdsImage : Equatable, Hashableextension MozAdsImage: Sendable -
Declaration
Swift
public struct MozAdsPlacementRequest : Equatable, Hashableextension MozAdsPlacementRequest: Sendable -
Declaration
Swift
public struct MozAdsPlacementRequestWithCount : Equatable, Hashableextension MozAdsPlacementRequestWithCount: Sendable -
Declaration
Swift
public struct MozAdsRequestCachePolicy : Equatable, Hashableextension MozAdsRequestCachePolicy: Sendable -
Declaration
Swift
public struct MozAdsRequestOptions : Equatable, Hashableextension MozAdsRequestOptions: Sendable -
Declaration
Swift
public struct MozAdsSpoc : Equatable, Hashableextension MozAdsSpoc: Sendable -
Declaration
Swift
public struct MozAdsSpocFrequencyCaps : Equatable, Hashableextension MozAdsSpocFrequencyCaps: Sendable -
Declaration
Swift
public struct MozAdsSpocRanking : Equatable, Hashableextension MozAdsSpocRanking: Sendable -
Declaration
Swift
public struct MozAdsTile : Equatable, Hashableextension MozAdsTile: Sendable -
The decrypted response from the Gateway/Target
See moreDeclaration
Swift
public struct OhttpResponse : Equatable, Hashableextension OhttpResponse: Sendable -
Declaration
Swift
public struct TestServerRequest : Equatable, Hashableextension TestServerRequest: Sendable -
What you get back as an address.
See moreDeclaration
Swift
public struct Address : Equatable, Hashableextension Address: Sendable -
What you get back as a credit-card.
See moreDeclaration
Swift
public struct CreditCard : Equatable, Hashableextension CreditCard: Sendable -
Metrics tracking scrubbing of credit cards that cannot be decrypted, see
See moreDeclaration
Swift
public struct CreditCardsDeletionMetrics : Equatable, Hashableextension CreditCardsDeletionMetrics: Sendable -
What you pass to create or update an address.
See moreDeclaration
Swift
public struct UpdatableAddressFields : Equatable, Hashableextension UpdatableAddressFields: Sendable -
What you pass to create or update a credit-card.
See moreDeclaration
Swift
public struct UpdatableCreditCardFields : Equatable, Hashableextension UpdatableCreditCardFields: Sendable -
An OAuth access token, with its associated keys and metadata.
This struct represents an FxA OAuth access token, which can be used to access a resource or service on behalf of the user. For example, accessing the user’s data in Firefox Sync an access token for the scope
See morehttps:///identity.mozilla.com/apps/syncalong with the associated encryption key.Declaration
Swift
public struct AccessTokenInfo : Equatable, Hashableextension AccessTokenInfo: Sendable -
A client connected to the user’s account.
This struct provides metadata about a client connected to the user’s account. Unlike the [
Device] struct, “clients” encompasses both client-side and server-side applications - basically anything where the user is able to sign in with their Firefox Account.This data would typically be used for targeted messaging purposes, catering the contents of the message to what other applications the user has on their account.
See moreDeclaration
Swift
public struct AttachedClient : Equatable, Hashableextension AttachedClient: Sendable -
Information about the authorization state of the application.
This struct represents metadata about whether the application is currently connected to the user’s account.
See moreDeclaration
Swift
public struct AuthorizationInfo : Equatable, Hashableextension AuthorizationInfo: Sendable -
Parameters provided in an incoming OAuth request.
This struct represents parameters obtained from an incoming OAuth request - that is, the values that an OAuth client would append to the authorization URL when initiating an OAuth sign-in flow.
See moreDeclaration
Swift
public struct AuthorizationParameters : Equatable, Hashableextension AuthorizationParameters: Sendable -
The payload sent when invoking a “close tabs” command.
See moreDeclaration
Swift
public struct CloseTabsPayload : Equatable, Hashableextension CloseTabsPayload: Sendable -
A device connected to the user’s account.
This struct provides metadata about a device connected to the user’s account. This data would typically be used to display e.g. the list of candidate devices in a “send tab” menu.
See moreDeclaration
Swift
public struct Device : Equatable, Hashableextension Device: Sendable -
Device configuration
See moreDeclaration
Swift
public struct DeviceConfig : Equatable, Hashableextension DeviceConfig: Sendable -
Details of a web-push subscription endpoint.
This struct encapsulates the details of a web-push subscription endpoint, including all the information necessary to send a notification to its owner. Devices attached to the user’s account may register one of these in order to receive timely updates about account-related events.
Managing a web-push subscription is outside of the scope of this component.
See moreDeclaration
Swift
public struct DevicePushSubscription : Equatable, Hashableextension DevicePushSubscription: Sendable -
Declaration
Swift
public struct FxaConfig : Equatable, Hashableextension FxaConfig: Sendable -
Local device that’s connecting to FxA
This is returned by the device update methods and represents the server’s view of the local device.
See moreDeclaration
Swift
public struct LocalDevice : Equatable, Hashableextension LocalDevice: Sendable -
Information about the user that controls a Firefox Account.
This struct represents details about the user themselves, and would typically be used to customize account-related UI in the browser so that it is personalize for the current user.
See moreDeclaration
Swift
public struct Profile : Equatable, Hashableextension Profile: Sendable -
A cryptographic key associated with an OAuth scope.
Some OAuth scopes have a corresponding client-side encryption key that is required in order to access protected data. This struct represents such key material in a format compatible with the common “JWK” standard.
See moreDeclaration
Swift
public struct ScopedKey : Equatable, Hashableextension ScopedKey: Sendable -
The payload sent when invoking a “send tab” command.
See moreDeclaration
Swift
public struct SendTabPayload : Equatable, Hashableextension SendTabPayload: Sendable -
A received tab. Mis-named as the original intent was to keep the full “back” history for a tab, where this would be one such entry - but that never happened.
See moreDeclaration
Swift
public struct TabHistoryEntry : Equatable, Hashableextension TabHistoryEntry: Sendable -
Declaration
Swift
public struct UserData : Equatable, Hashableextension UserData: Sendable -
A login stored in the database
See moreDeclaration
Swift
public struct Login : Equatable, Hashableextension Login: Sendable -
A login entry from the user, not linked to any database record. The add/update APIs input these.
See moreDeclaration
Swift
public struct LoginEntry : Equatable, Hashableextension LoginEntry: Sendable -
A login together with record fields, handed over to the store API; ie a login persisted elsewhere, useful for migrations
See moreDeclaration
Swift
public struct LoginEntryWithMeta : Equatable, Hashableextension LoginEntryWithMeta: Sendable -
Metadata fields managed internally by the library. These are automatically set on
See moreadd()and updated on operations liketouch()andupdate(). Not included in LoginEntry; useadd_with_meta()when importing records with existing metadata.Declaration
Swift
public struct LoginMeta : Equatable, Hashableextension LoginMeta: Sendable -
Metrics tracking deletion of logins that cannot be decrypted, see
See moredelete_undecryptable_records_for_remote_replacementfor more detailsDeclaration
Swift
public struct LoginsDeletionMetrics : Equatable, Hashableextension LoginsDeletionMetrics: Sendable -
Declaration
Swift
public struct CuratedRecommendationsBucket : Equatable, Hashable, Codableextension CuratedRecommendationsBucket: Sendable -
Declaration
Swift
public struct CuratedRecommendationsConfig : Equatable, Hashable, Codableextension CuratedRecommendationsConfig: Sendable -
Declaration
Swift
public struct CuratedRecommendationsRequest : Equatable, Hashable, Codableextension CuratedRecommendationsRequest: Sendable -
Declaration
Swift
public struct CuratedRecommendationsResponse : Equatable, Hashable, Codableextension CuratedRecommendationsResponse: Sendable -
Declaration
Swift
public struct FakespotCta : Equatable, Hashable, Codableextension FakespotCta: Sendable -
Declaration
Swift
public struct FakespotFeed : Equatable, Hashable, Codableextension FakespotFeed: Sendable -
Declaration
Swift
public struct FakespotProduct : Equatable, Hashable, Codableextension FakespotProduct: Sendable -
Declaration
Swift
public struct FeedSection : Equatable, Hashable, Codableextension FeedSection: Sendable -
Declaration
Swift
public struct Feeds : Equatable, Hashable, Codableextension Feeds: Sendable -
Declaration
Swift
public struct InterestPicker : Equatable, Hashable, Codableextension InterestPicker: Sendable -
Declaration
Swift
public struct InterestPickerSection : Equatable, Hashable, Codableextension InterestPickerSection: Sendable -
Declaration
Swift
public struct Layout : Equatable, Hashable, Codableextension Layout: Sendable -
Declaration
Swift
public struct RecommendationDataItem : Equatable, Hashable, Codableextension RecommendationDataItem: Sendable -
Declaration
Swift
public struct ResponsiveLayout : Equatable, Hashable, Codableextension ResponsiveLayout: Sendable -
Declaration
Swift
public struct SectionSettings : Equatable, Hashable, Codableextension SectionSettings: Sendable -
Declaration
Swift
public struct Tile : Equatable, Hashable, Codableextension Tile: Sendable -
Declaration
Swift
public struct AppContext : Equatable, Hashableextension AppContext: Sendable -
Declaration
Swift
public struct AvailableExperiment : Equatable, Hashableextension AvailableExperiment: Sendable -
Declaration
Swift
public struct CalculatedAttributes : Equatable, Hashableextension CalculatedAttributes: Sendable -
Declaration
Swift
public struct EnrolledExperiment : Equatable, Hashableextension EnrolledExperiment: Sendable -
Declaration
Swift
public struct EnrollmentChangeEvent : Equatable, Hashableextension EnrollmentChangeEvent: Sendable -
Declaration
Swift
public struct EnrollmentStatusExtraDef : Equatable, Hashableextension EnrollmentStatusExtraDef: Sendable -
Declaration
Swift
public struct ExperimentBranch : Equatable, Hashableextension ExperimentBranch: Sendable -
Declaration
Swift
public struct FeatureExposureExtraDef : Equatable, Hashableextension FeatureExposureExtraDef: Sendable -
Declaration
Swift
public struct GeckoPref : Equatable, Hashableextension GeckoPref: Sendable -
Declaration
Swift
public struct GeckoPrefState : Equatable, Hashableextension GeckoPrefState: Sendable -
Declaration
Swift
public struct MalformedFeatureConfigExtraDef : Equatable, Hashableextension MalformedFeatureConfigExtraDef: Sendable -
Declaration
Swift
public struct NimbusServerSettingsextension NimbusServerSettings: Sendable -
Declaration
Swift
public struct OriginalGeckoPref : Equatable, Hashableextension OriginalGeckoPref: Sendable -
Declaration
Swift
public struct PrefEnrollmentData : Equatable, Hashableextension PrefEnrollmentData: Sendable -
Declaration
Swift
public struct PreviousGeckoPrefState : Equatable, Hashableextension PreviousGeckoPrefState: Sendable -
Declaration
Swift
public struct BookmarkData : Equatable, Hashableextension BookmarkData: Sendable -
Declaration
Swift
public struct BookmarkFolder : Equatable, Hashableextension BookmarkFolder: Sendable -
Declaration
Swift
public struct BookmarkSeparator : Equatable, Hashableextension BookmarkSeparator: Sendable -
Declaration
Swift
public struct BookmarkUpdateInfo : Equatable, Hashableextension BookmarkUpdateInfo: Sendable -
Exists just to convince uniffi to generate
See moreliftSequence*helpers!Declaration
Swift
public struct Dummy : Equatable, Hashableextension Dummy: Sendable -
Declaration
Swift
public struct HistoryHighlight : Equatable, Hashableextension HistoryHighlight: Sendable -
Declaration
Swift
public struct HistoryHighlightWeights : Equatable, Hashableextension HistoryHighlightWeights: Sendable -
This is what is returned.
See moreDeclaration
Swift
public struct HistoryMetadata : Equatable, Hashableextension HistoryMetadata: Sendable -
This is used as an “input” to the api.
See moreDeclaration
Swift
public struct HistoryMetadataObservation : Equatable, Hashableextension HistoryMetadataObservation: Sendable -
Declaration
Swift
public struct HistoryMigrationResult : Equatable, Hashableextension HistoryMigrationResult: Sendable -
Declaration
Swift
public struct HistoryVisitInfo : Equatable, Hashableextension HistoryVisitInfo: Sendable -
Declaration
Swift
public struct HistoryVisitInfosWithBound : Equatable, Hashableextension HistoryVisitInfosWithBound: Sendable -
Declaration
Swift
public struct InsertableBookmark : Equatable, Hashableextension InsertableBookmark: Sendable -
Declaration
Swift
public struct InsertableBookmarkFolder : Equatable, Hashableextension InsertableBookmarkFolder: Sendable -
Declaration
Swift
public struct InsertableBookmarkSeparator : Equatable, Hashableextension InsertableBookmarkSeparator: Sendable -
Options for recording history metadata observations.
See moreDeclaration
Swift
public struct NoteHistoryMetadataObservationOptions : Equatable, Hashableextension NoteHistoryMetadataObservationOptions: Sendable -
Declaration
Swift
public struct RunMaintenanceMetrics : Equatable, Hashableextension RunMaintenanceMetrics: Sendable -
Declaration
Swift
public struct SearchResult : Equatable, Hashableextension SearchResult: Sendable -
Declaration
Swift
public struct TopFrecentSiteInfo : Equatable, Hashableextension TopFrecentSiteInfo: Sendable -
Encapsulates either information about a visit to a page, or meta information about the page, or both. Use [VisitType.UPDATE_PLACE] to differentiate an update from a visit.
See moreDeclaration
Swift
public struct VisitObservation : Equatable, Hashableextension VisitObservation: Sendable -
Declaration
Swift
public struct DecryptResponse : Equatable, Hashableextension DecryptResponse: Sendable -
Key Information that can be used to encrypt payloads
See moreDeclaration
Swift
public struct KeyInfo : Equatable, Hashableextension KeyInfo: Sendable -
Declaration
Swift
public struct PushConfiguration : Equatable, Hashableextension PushConfiguration: Sendable -
An dictionary describing the push subscription that changed, the caller will receive a list of [
See morePushSubscriptionChanged] when calling [PushManager::verify_connection], one entry for each channel that the caller should resubscribe toDeclaration
Swift
public struct PushSubscriptionChanged : Equatable, Hashableextension PushSubscriptionChanged: Sendable -
Subscription Information, the endpoint to send push messages to and the key information that can be used to encrypt payloads
See moreDeclaration
Swift
public struct SubscriptionInfo : Equatable, Hashableextension SubscriptionInfo: Sendable -
The subscription response object returned from [
See morePushManager::subscribe]Declaration
Swift
public struct SubscriptionResponse : Equatable, Hashableextension SubscriptionResponse: Sendable -
Represents a bounce status object nested within the profile.
See moreDeclaration
Swift
public struct BounceStatus : Equatable, Hashableextension BounceStatus: Sendable -
Represents a Relay email address object returned by the Relay API.
Includes metadata and statistics for an alias, such as its status, usage stats, and identifying information.
See: https://mozilla.github.io/fx-private-relay/api_docs.html
See moreDeclaration
Swift
public struct RelayAddress : Equatable, Hashableextension RelayAddress: Sendable -
Represents a Relay user profile returned by the Relay API.
Contains information about the user’s subscription status, usage statistics, and account settings.
See moreDeclaration
Swift
public struct RelayProfile : Equatable, Hashableextension RelayProfile: Sendable -
Attachment metadata that can be optionally attached to a [Record]. The [location] should included in calls to [Client::get_attachment].
See moreDeclaration
Swift
public struct Attachment : Equatable, Hashableextension Attachment: Sendable -
Custom configuration for the client. Currently includes the following:
server: The Remote Settings server to use. If not specified, defaults to the production server (RemoteSettingsServer::Prod).server_url: An optional custom Remote Settings server URL. Deprecated; please useserverinstead.bucket_name: The optional name of the bucket containing the collection on the server. If not specified, the standard bucket will be used.collection_name: The name of the collection for the settings server.
Declaration
Swift
public struct RemoteSettingsConfig : Equatable, Hashableextension RemoteSettingsConfig: Sendable -
Remote settings configuration
This is the version used in the new API, hence the
See more2at the end. The plan is to move consumers to the new API, remove the RemoteSettingsConfig struct, then remove the2from this name.Declaration
Swift
public struct RemoteSettingsConfig2 : Equatable, Hashableextension RemoteSettingsConfig2: Sendable -
Remote settings context object
This is used to filter the records returned. We always fetch all
recordsfrom the remote-settings storage. Some records could have afilter_expression. If this is passed in and the record has afilter_expression, then only returns where the expression is true will be returned.See https://remote-settings.readthedocs.io/en/latest/target-filters.html for details.
See moreDeclaration
Swift
public struct RemoteSettingsContext : Equatable, Hashableextension RemoteSettingsContext: Sendable -
A parsed Remote Settings record. Records can contain arbitrary fields, so clients are required to further extract expected values from the [fields] member.
See moreDeclaration
Swift
public struct RemoteSettingsRecord : Equatable, Hashableextension RemoteSettingsRecord: Sendable -
Data structure representing the top-level response from the Remote Settings. [last_modified] will be extracted from the etag header of the response.
See moreDeclaration
Swift
public struct RemoteSettingsResponse : Equatable, Hashableextension RemoteSettingsResponse: Sendable -
Declaration
Swift
public struct Record : Equatable, Hashableextension Record: Sendable -
Defines an individual search engine URL. This is defined separately to
See moretypes::SearchEngineUrlas various fields may be optional in the supplied configuration.Declaration
Swift
public struct JsonEngineUrl : Equatable, Hashableextension JsonEngineUrl: Sendable -
Reflects
See moretypes::SearchEngineUrls, but usingEngineUrl.Declaration
Swift
public struct JsonEngineUrls : Equatable, Hashableextension JsonEngineUrls: Sendable -
Details of the search engines to display to the user, generated as a result of processing the search configuration.
See moreDeclaration
Swift
public struct RefinedSearchConfig : Equatable, Hashableextension RefinedSearchConfig: Sendable -
A definition for an individual search engine to be presented to the user.
See moreDeclaration
Swift
public struct SearchEngineDefinition : Equatable, Hashableextension SearchEngineDefinition: Sendable -
Defines an individual search engine URL.
See moreDeclaration
Swift
public struct SearchEngineUrl : Equatable, Hashableextension SearchEngineUrl: Sendable -
The URLs associated with the search engine.
See moreDeclaration
Swift
public struct SearchEngineUrls : Equatable, Hashableextension SearchEngineUrls: Sendable -
Parameter definitions for search engine URLs. The name property is always specified, along with one of value, experiment_config or search_access_point.
See moreDeclaration
Swift
public struct SearchUrlParam : Equatable, Hashableextension SearchUrlParam: Sendable -
The user’s environment that is used for filtering the search configuration.
See moreDeclaration
Swift
public struct SearchUserEnvironment : Equatable, Hashableextension SearchUserEnvironment: Sendable -
A set of names for a single entity.
See moreDeclaration
Swift
public struct AlternateNames : Equatable, Hashableextension AlternateNames: Sendable -
Additional data about how an FTS match was made
See moreDeclaration
Swift
public struct FtsMatchInfo : Equatable, Hashableextension FtsMatchInfo: Sendable -
Alternate names for a geoname and its country and admin divisions.
See moreDeclaration
Swift
public struct GeonameAlternates : Equatable, Hashableextension GeonameAlternates: Sendable -
A fetched geoname with info on how it was matched.
See moreDeclaration
Swift
public struct GeonameMatch : Equatable, Hashableextension GeonameMatch: Sendable -
Single sample for a Glean labeled_timing_distribution
See moreDeclaration
Swift
public struct LabeledTimingSample : Equatable, Hashableextension LabeledTimingSample: Sendable -
Declaration
Swift
public struct QueryWithMetricsResult : Equatable, Hashableextension QueryWithMetricsResult: Sendable -
Global Suggest configuration data.
See moreDeclaration
Swift
public struct SuggestGlobalConfig : Equatable, Hashableextension SuggestGlobalConfig: Sendable -
Constraints limit which suggestions to ingest from Remote Settings.
See moreDeclaration
Swift
public struct SuggestIngestionConstraints : Equatable, Hashableextension SuggestIngestionConstraints: Sendable -
Ingestion metrics
These are recorded during [crate::Store::ingest] and returned to the consumer to record.
See moreDeclaration
Swift
public struct SuggestIngestionMetrics : Equatable, Hashableextension SuggestIngestionMetrics: Sendable -
Some providers manage multiple suggestion subtypes. Queries, ingests, and other operations on those providers must be constrained to a desired subtype.
See moreDeclaration
Swift
public struct SuggestionProviderConstraints : Equatable, Hashableextension SuggestionProviderConstraints: Sendable -
A query for suggestions to show in the address bar.
See moreDeclaration
Swift
public struct SuggestionQuery : Equatable, Hashableextension SuggestionQuery: Sendable -
Declaration
Swift
public struct DeviceSettings : Equatable, Hashableextension DeviceSettings: Sendable -
Declaration
Swift
public struct SyncAuthInfo : Equatable, Hashableextension SyncAuthInfo: Sendable -
Declaration
Swift
public struct SyncParams : Equatable, Hashableextension SyncParams: Sendable -
Declaration
Swift
public struct SyncResult : Equatable, Hashableextension SyncResult: Sendable -
Declaration
Swift
public struct ClientRemoteTabs : Equatable, Hashableextension ClientRemoteTabs: Sendable -
Declaration
Swift
public struct LocalTabsInfo : Equatable, Hashableextension LocalTabsInfo: Sendable -
Represents a “pending” command.
See moreDeclaration
Swift
public struct PendingCommand : Equatable, Hashableextension PendingCommand: Sendable -
Declaration
Swift
public struct RemoteTabRecord : Equatable, Hashableextension RemoteTabRecord: Sendable -
A tab-group, representing a session store
See moreTabGroupStateData.Declaration
Swift
public struct TabGroup : Equatable, Hashableextension TabGroup: Sendable -
Declaration
Swift
public struct Window : Equatable, Hashableextension Window: Sendable -
Describes which events to an EventSink
See moreDeclaration
Swift
public struct EventSinkSpecification : Equatable, Hashableextension EventSinkSpecification: Sendable -
Declaration
Swift
public struct EventTarget : Equatable, Hashableextension EventTarget: Sendable -
Declaration
Swift
public struct TracingEvent : Equatable, Hashableextension TracingEvent: Sendable -
Declaration
Swift
public struct ClientSettings : Equatable, Hashableextension ClientSettings: Sendable -
Configuration for an OHTTP channel
See moreDeclaration
Swift
public struct OhttpConfig : Equatable, Hashableextension OhttpConfig: Sendable -
Declaration
Swift
public struct Request : Equatable, Hashableextension Request: Sendable -
A response from the server.
See moreDeclaration
Swift
public struct Response : Equatable, Hashableextension Response: Sendable
Structures Reference