Structures
The following structures are available globally.
-
Declaration
Swift
public struct MozAdextension MozAd: Sendableextension MozAd: Equatable, Hashable -
Declaration
Swift
public struct MozAdsCacheConfigextension MozAdsCacheConfig: Sendableextension MozAdsCacheConfig: Equatable, Hashable -
Declaration
Swift
public struct MozAdsCallbacksextension MozAdsCallbacks: Sendableextension MozAdsCallbacks: Equatable, Hashable -
Declaration
Swift
public struct MozAdsClientConfigextension MozAdsClientConfig: Sendableextension MozAdsClientConfig: Equatable, Hashable -
Declaration
Swift
public struct MozAdsContentCategoryextension MozAdsContentCategory: Sendableextension MozAdsContentCategory: Equatable, Hashable -
Declaration
Swift
public struct MozAdsIabContentextension MozAdsIabContent: Sendableextension MozAdsIabContent: Equatable, Hashable -
Declaration
Swift
public struct MozAdsPlacementRequestextension MozAdsPlacementRequest: Sendableextension MozAdsPlacementRequest: Equatable, Hashable -
Declaration
Swift
public struct MozAdsPlacementRequestWithCountextension MozAdsPlacementRequestWithCount: Sendableextension MozAdsPlacementRequestWithCount: Equatable, Hashable -
Declaration
Swift
public struct MozAdsRequestCachePolicyextension MozAdsRequestCachePolicy: Sendableextension MozAdsRequestCachePolicy: Equatable, Hashable -
Declaration
Swift
public struct MozAdsRequestOptionsextension MozAdsRequestOptions: Sendableextension MozAdsRequestOptions: Equatable, Hashable -
The decrypted response from the Gateway/Target
See moreDeclaration
Swift
public struct OhttpResponseextension OhttpResponse: Sendableextension OhttpResponse: Equatable, Hashable -
Declaration
Swift
public struct TestServerRequestextension TestServerRequest: Sendableextension TestServerRequest: Equatable, Hashable -
What you get back as an address.
See moreDeclaration
Swift
public struct Addressextension Address: Sendableextension Address: Equatable, Hashable -
What you get back as a credit-card.
See moreDeclaration
Swift
public struct CreditCardextension CreditCard: Sendableextension CreditCard: Equatable, Hashable -
Metrics tracking scrubbing of credit cards that cannot be decrypted, see
See moreDeclaration
Swift
public struct CreditCardsDeletionMetricsextension CreditCardsDeletionMetrics: Sendableextension CreditCardsDeletionMetrics: Equatable, Hashable -
What you pass to create or update an address.
See moreDeclaration
Swift
public struct UpdatableAddressFieldsextension UpdatableAddressFields: Sendableextension UpdatableAddressFields: Equatable, Hashable -
What you pass to create or update a credit-card.
See moreDeclaration
Swift
public struct UpdatableCreditCardFieldsextension UpdatableCreditCardFields: Sendableextension UpdatableCreditCardFields: Equatable, Hashable -
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 AccessTokenInfoextension AccessTokenInfo: Sendableextension AccessTokenInfo: Equatable, Hashable -
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 AttachedClientextension AttachedClient: Sendableextension AttachedClient: Equatable, Hashable -
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 AuthorizationInfoextension AuthorizationInfo: Sendableextension AuthorizationInfo: Equatable, Hashable -
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 AuthorizationParametersextension AuthorizationParameters: Sendableextension AuthorizationParameters: Equatable, Hashable -
The payload sent when invoking a “close tabs” command.
See moreDeclaration
Swift
public struct CloseTabsPayloadextension CloseTabsPayload: Sendableextension CloseTabsPayload: Equatable, Hashable -
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 Deviceextension Device: Sendableextension Device: Equatable, Hashable -
Device configuration
See moreDeclaration
Swift
public struct DeviceConfigextension DeviceConfig: Sendableextension DeviceConfig: Equatable, Hashable -
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 DevicePushSubscriptionextension DevicePushSubscription: Sendableextension DevicePushSubscription: Equatable, Hashable -
Declaration
Swift
public struct FxaConfigextension FxaConfig: Sendableextension FxaConfig: Equatable, Hashable -
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 LocalDeviceextension LocalDevice: Sendableextension LocalDevice: Equatable, Hashable -
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 Profileextension Profile: Sendableextension Profile: Equatable, Hashable -
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 ScopedKeyextension ScopedKey: Sendableextension ScopedKey: Equatable, Hashable -
The payload sent when invoking a “send tab” command.
See moreDeclaration
Swift
public struct SendTabPayloadextension SendTabPayload: Sendableextension SendTabPayload: Equatable, Hashable -
An individual entry in the navigation history of a sent tab.
See moreDeclaration
Swift
public struct TabHistoryEntryextension TabHistoryEntry: Sendableextension TabHistoryEntry: Equatable, Hashable -
Declaration
Swift
public struct UserDataextension UserData: Sendableextension UserData: Equatable, Hashable -
A login stored in the database
See moreDeclaration
Swift
public struct Loginextension Login: Sendableextension Login: Equatable, Hashable -
A login entry from the user, not linked to any database record. The add/update APIs input these.
See moreDeclaration
Swift
public struct LoginEntryextension LoginEntry: Sendableextension LoginEntry: Equatable, Hashable -
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 LoginEntryWithMetaextension LoginEntryWithMeta: Sendableextension LoginEntryWithMeta: Equatable, Hashable -
Login data specific to database records. The add_with_record API inputs this.
See moreDeclaration
Swift
public struct LoginMetaextension LoginMeta: Sendableextension LoginMeta: Equatable, Hashable -
Metrics tracking deletion of logins that cannot be decrypted, see
See moredelete_undecryptable_records_for_remote_replacementfor more detailsDeclaration
Swift
public struct LoginsDeletionMetricsextension LoginsDeletionMetrics: Sendableextension LoginsDeletionMetrics: Equatable, Hashable -
Declaration
Swift
public struct CuratedRecommendationsBucketextension CuratedRecommendationsBucket: Sendableextension CuratedRecommendationsBucket: Equatable, Hashable -
Declaration
Swift
public struct CuratedRecommendationsConfigextension CuratedRecommendationsConfig: Sendableextension CuratedRecommendationsConfig: Equatable, Hashable -
Declaration
Swift
public struct CuratedRecommendationsRequestextension CuratedRecommendationsRequest: Sendableextension CuratedRecommendationsRequest: Equatable, Hashable -
Declaration
Swift
public struct CuratedRecommendationsResponseextension CuratedRecommendationsResponse: Sendableextension CuratedRecommendationsResponse: Equatable, Hashable -
Declaration
Swift
public struct FakespotCtaextension FakespotCta: Sendableextension FakespotCta: Equatable, Hashable -
Declaration
Swift
public struct FakespotFeedextension FakespotFeed: Sendableextension FakespotFeed: Equatable, Hashable -
Declaration
Swift
public struct FakespotProductextension FakespotProduct: Sendableextension FakespotProduct: Equatable, Hashable -
Declaration
Swift
public struct FeedSectionextension FeedSection: Sendableextension FeedSection: Equatable, Hashable -
Declaration
Swift
public struct Feedsextension Feeds: Sendableextension Feeds: Equatable, Hashable -
Declaration
Swift
public struct InterestPickerextension InterestPicker: Sendableextension InterestPicker: Equatable, Hashable -
Declaration
Swift
public struct InterestPickerSectionextension InterestPickerSection: Sendableextension InterestPickerSection: Equatable, Hashable -
Declaration
Swift
public struct Layoutextension Layout: Sendableextension Layout: Equatable, Hashable -
Declaration
Swift
public struct RecommendationDataItemextension RecommendationDataItem: Sendableextension RecommendationDataItem: Equatable, Hashable -
Declaration
Swift
public struct ResponsiveLayoutextension ResponsiveLayout: Sendableextension ResponsiveLayout: Equatable, Hashable -
Declaration
Swift
public struct SectionSettingsextension SectionSettings: Sendableextension SectionSettings: Equatable, Hashable -
Declaration
Swift
public struct Tileextension Tile: Sendableextension Tile: Equatable, Hashable -
Declaration
Swift
public struct AppContextextension AppContext: Sendableextension AppContext: Equatable, Hashable -
Declaration
Swift
public struct AvailableExperimentextension AvailableExperiment: Sendableextension AvailableExperiment: Equatable, Hashable -
Declaration
Swift
public struct CalculatedAttributesextension CalculatedAttributes: Sendableextension CalculatedAttributes: Equatable, Hashable -
Declaration
Swift
public struct EnrolledExperimentextension EnrolledExperiment: Sendableextension EnrolledExperiment: Equatable, Hashable -
Declaration
Swift
public struct EnrollmentChangeEventextension EnrollmentChangeEvent: Sendableextension EnrollmentChangeEvent: Equatable, Hashable -
Declaration
Swift
public struct EnrollmentStatusExtraDefextension EnrollmentStatusExtraDef: Sendableextension EnrollmentStatusExtraDef: Equatable, Hashable -
Declaration
Swift
public struct ExperimentBranchextension ExperimentBranch: Sendableextension ExperimentBranch: Equatable, Hashable -
Declaration
Swift
public struct FeatureExposureExtraDefextension FeatureExposureExtraDef: Sendableextension FeatureExposureExtraDef: Equatable, Hashable -
Declaration
Swift
public struct GeckoPrefextension GeckoPref: Sendableextension GeckoPref: Equatable, Hashable -
Declaration
Swift
public struct GeckoPrefStateextension GeckoPrefState: Sendableextension GeckoPrefState: Equatable, Hashable -
Declaration
Swift
public struct MalformedFeatureConfigExtraDefextension MalformedFeatureConfigExtraDef: Sendableextension MalformedFeatureConfigExtraDef: Equatable, Hashable -
Declaration
Swift
public struct PrefEnrollmentDataextension PrefEnrollmentData: Sendableextension PrefEnrollmentData: Equatable, Hashable -
Declaration
Swift
public struct BookmarkDataextension BookmarkData: Sendableextension BookmarkData: Equatable, Hashable -
Declaration
Swift
public struct BookmarkFolderextension BookmarkFolder: Sendableextension BookmarkFolder: Equatable, Hashable -
Declaration
Swift
public struct BookmarkSeparatorextension BookmarkSeparator: Sendableextension BookmarkSeparator: Equatable, Hashable -
Declaration
Swift
public struct BookmarkUpdateInfoextension BookmarkUpdateInfo: Sendableextension BookmarkUpdateInfo: Equatable, Hashable -
Exists just to convince uniffi to generate
See moreliftSequence*helpers!Declaration
Swift
public struct Dummyextension Dummy: Sendableextension Dummy: Equatable, Hashable -
Declaration
Swift
public struct HistoryHighlightextension HistoryHighlight: Sendableextension HistoryHighlight: Equatable, Hashable -
Declaration
Swift
public struct HistoryHighlightWeightsextension HistoryHighlightWeights: Sendableextension HistoryHighlightWeights: Equatable, Hashable -
This is what is returned.
See moreDeclaration
Swift
public struct HistoryMetadataextension HistoryMetadata: Sendableextension HistoryMetadata: Equatable, Hashable -
This is used as an “input” to the api.
See moreDeclaration
Swift
public struct HistoryMetadataObservationextension HistoryMetadataObservation: Sendableextension HistoryMetadataObservation: Equatable, Hashable -
Declaration
Swift
public struct HistoryMigrationResultextension HistoryMigrationResult: Sendableextension HistoryMigrationResult: Equatable, Hashable -
Declaration
Swift
public struct HistoryVisitInfoextension HistoryVisitInfo: Sendableextension HistoryVisitInfo: Equatable, Hashable -
Declaration
Swift
public struct HistoryVisitInfosWithBoundextension HistoryVisitInfosWithBound: Sendableextension HistoryVisitInfosWithBound: Equatable, Hashable -
Declaration
Swift
public struct InsertableBookmarkextension InsertableBookmark: Sendableextension InsertableBookmark: Equatable, Hashable -
Declaration
Swift
public struct InsertableBookmarkFolderextension InsertableBookmarkFolder: Sendableextension InsertableBookmarkFolder: Equatable, Hashable -
Declaration
Swift
public struct InsertableBookmarkSeparatorextension InsertableBookmarkSeparator: Sendableextension InsertableBookmarkSeparator: Equatable, Hashable -
Options for recording history metadata observations.
See moreDeclaration
Swift
public struct NoteHistoryMetadataObservationOptionsextension NoteHistoryMetadataObservationOptions: Sendableextension NoteHistoryMetadataObservationOptions: Equatable, Hashable -
Declaration
Swift
public struct RunMaintenanceMetricsextension RunMaintenanceMetrics: Sendableextension RunMaintenanceMetrics: Equatable, Hashable -
Declaration
Swift
public struct SearchResultextension SearchResult: Sendableextension SearchResult: Equatable, Hashable -
Declaration
Swift
public struct TopFrecentSiteInfoextension TopFrecentSiteInfo: Sendableextension TopFrecentSiteInfo: Equatable, Hashable -
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 VisitObservationextension VisitObservation: Sendableextension VisitObservation: Equatable, Hashable -
Declaration
Swift
public struct DecryptResponseextension DecryptResponse: Sendableextension DecryptResponse: Equatable, Hashable -
Key Information that can be used to encrypt payloads
See moreDeclaration
Swift
public struct KeyInfoextension KeyInfo: Sendableextension KeyInfo: Equatable, Hashable -
Declaration
Swift
public struct PushConfigurationextension PushConfiguration: Sendableextension PushConfiguration: Equatable, Hashable -
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 PushSubscriptionChangedextension PushSubscriptionChanged: Sendableextension PushSubscriptionChanged: Equatable, Hashable -
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 SubscriptionInfoextension SubscriptionInfo: Sendableextension SubscriptionInfo: Equatable, Hashable -
The subscription response object returned from [
See morePushManager::subscribe]Declaration
Swift
public struct SubscriptionResponseextension SubscriptionResponse: Sendableextension SubscriptionResponse: Equatable, Hashable -
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 RelayAddressextension RelayAddress: Sendableextension RelayAddress: Equatable, Hashable -
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 Attachmentextension Attachment: Sendableextension Attachment: Equatable, Hashable -
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 RemoteSettingsConfigextension RemoteSettingsConfig: Sendableextension RemoteSettingsConfig: Equatable, Hashable -
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 RemoteSettingsConfig2extension RemoteSettingsConfig2: Sendableextension RemoteSettingsConfig2: Equatable, Hashable -
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 RemoteSettingsContextextension RemoteSettingsContext: Sendableextension RemoteSettingsContext: Equatable, Hashable -
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 RemoteSettingsRecordextension RemoteSettingsRecord: Sendableextension RemoteSettingsRecord: Equatable, Hashable -
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 RemoteSettingsResponseextension RemoteSettingsResponse: Sendableextension RemoteSettingsResponse: Equatable, Hashable -
Declaration
Swift
public struct Recordextension Record: Sendableextension Record: Equatable, Hashable -
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 JsonEngineUrlextension JsonEngineUrl: Sendableextension JsonEngineUrl: Equatable, Hashable -
Reflects
See moretypes::SearchEngineUrls, but usingEngineUrl.Declaration
Swift
public struct JsonEngineUrlsextension JsonEngineUrls: Sendableextension JsonEngineUrls: Equatable, Hashable -
Details of the search engines to display to the user, generated as a result of processing the search configuration.
See moreDeclaration
Swift
public struct RefinedSearchConfigextension RefinedSearchConfig: Sendableextension RefinedSearchConfig: Equatable, Hashable -
A definition for an individual search engine to be presented to the user.
See moreDeclaration
Swift
public struct SearchEngineDefinitionextension SearchEngineDefinition: Sendableextension SearchEngineDefinition: Equatable, Hashable -
Defines an individual search engine URL.
See moreDeclaration
Swift
public struct SearchEngineUrlextension SearchEngineUrl: Sendableextension SearchEngineUrl: Equatable, Hashable -
The URLs associated with the search engine.
See moreDeclaration
Swift
public struct SearchEngineUrlsextension SearchEngineUrls: Sendableextension SearchEngineUrls: Equatable, Hashable -
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 SearchUrlParamextension SearchUrlParam: Sendableextension SearchUrlParam: Equatable, Hashable -
The user’s environment that is used for filtering the search configuration.
See moreDeclaration
Swift
public struct SearchUserEnvironmentextension SearchUserEnvironment: Sendableextension SearchUserEnvironment: Equatable, Hashable -
A set of names for a single entity.
See moreDeclaration
Swift
public struct AlternateNamesextension AlternateNames: Sendableextension AlternateNames: Equatable, Hashable -
Additional data about how an FTS match was made
See moreDeclaration
Swift
public struct FtsMatchInfoextension FtsMatchInfo: Sendableextension FtsMatchInfo: Equatable, Hashable -
Alternate names for a geoname and its country and admin divisions.
See moreDeclaration
Swift
public struct GeonameAlternatesextension GeonameAlternates: Sendableextension GeonameAlternates: Equatable, Hashable -
A fetched geoname with info on how it was matched.
See moreDeclaration
Swift
public struct GeonameMatchextension GeonameMatch: Sendableextension GeonameMatch: Equatable, Hashable -
Single sample for a Glean labeled_timing_distribution
See moreDeclaration
Swift
public struct LabeledTimingSampleextension LabeledTimingSample: Sendableextension LabeledTimingSample: Equatable, Hashable -
Declaration
Swift
public struct QueryWithMetricsResultextension QueryWithMetricsResult: Sendableextension QueryWithMetricsResult: Equatable, Hashable -
Global Suggest configuration data.
See moreDeclaration
Swift
public struct SuggestGlobalConfigextension SuggestGlobalConfig: Sendableextension SuggestGlobalConfig: Equatable, Hashable -
Constraints limit which suggestions to ingest from Remote Settings.
See moreDeclaration
Swift
public struct SuggestIngestionConstraintsextension SuggestIngestionConstraints: Sendableextension SuggestIngestionConstraints: Equatable, Hashable -
Ingestion metrics
These are recorded during [crate::Store::ingest] and returned to the consumer to record.
See moreDeclaration
Swift
public struct SuggestIngestionMetricsextension SuggestIngestionMetrics: Sendableextension SuggestIngestionMetrics: Equatable, Hashable -
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 SuggestionProviderConstraintsextension SuggestionProviderConstraints: Sendableextension SuggestionProviderConstraints: Equatable, Hashable -
A query for suggestions to show in the address bar.
See moreDeclaration
Swift
public struct SuggestionQueryextension SuggestionQuery: Sendableextension SuggestionQuery: Equatable, Hashable -
Declaration
Swift
public struct DeviceSettingsextension DeviceSettings: Sendableextension DeviceSettings: Equatable, Hashable -
Declaration
Swift
public struct SyncAuthInfoextension SyncAuthInfo: Sendableextension SyncAuthInfo: Equatable, Hashable -
Declaration
Swift
public struct SyncParamsextension SyncParams: Sendableextension SyncParams: Equatable, Hashable -
Declaration
Swift
public struct SyncResultextension SyncResult: Sendableextension SyncResult: Equatable, Hashable -
Declaration
Swift
public struct ClientRemoteTabsextension ClientRemoteTabs: Sendableextension ClientRemoteTabs: Equatable, Hashable -
Represents a “pending” command.
See moreDeclaration
Swift
public struct PendingCommandextension PendingCommand: Sendableextension PendingCommand: Equatable, Hashable -
Declaration
Swift
public struct RemoteTabRecordextension RemoteTabRecord: Sendableextension RemoteTabRecord: Equatable, Hashable -
Declaration
Swift
public struct TracingEventextension TracingEvent: Sendableextension TracingEvent: Equatable, Hashable -
Declaration
Swift
public struct ClientSettingsextension ClientSettings: Sendableextension ClientSettings: Equatable, Hashable -
Configuration for an OHTTP channel
See moreDeclaration
Swift
public struct OhttpConfigextension OhttpConfig: Sendableextension OhttpConfig: Equatable, Hashable -
Declaration
Swift
public struct Requestextension Request: Sendableextension Request: Equatable, Hashable -
A response from the server.
See moreDeclaration
Swift
public struct Responseextension Response: Sendableextension Response: Equatable, Hashable
Structures Reference