Structures

The following structures are available globally.

  • The decrypted response from the Gateway/Target

    See more

    Declaration

    Swift

    public struct OhttpResponse
    extension OhttpResponse: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct TestServerRequest
    extension TestServerRequest: Equatable, Hashable

  • What you get back as an address.

    See more

    Declaration

    Swift

    public struct Address
    extension Address: Equatable, Hashable

  • What you get back as a credit-card.

    See more

    Declaration

    Swift

    public struct CreditCard
    extension CreditCard: Equatable, Hashable

  • What you pass to create or update an address.

    See more

    Declaration

    Swift

    public struct UpdatableAddressFields
    extension UpdatableAddressFields: Equatable, Hashable

  • What you pass to create or update a credit-card.

    See more

    Declaration

    Swift

    public struct UpdatableCreditCardFields
    extension 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 https:///identity.mozilla.com/apps/sync along with the associated encryption key.

    See more

    Declaration

    Swift

    public struct AccessTokenInfo
    extension 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 more

    Declaration

    Swift

    public struct AttachedClient
    extension 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 more

    Declaration

    Swift

    public struct AuthorizationInfo
    extension 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 more

    Declaration

    Swift

    public struct AuthorizationParameters
    extension AuthorizationParameters: Equatable, Hashable

  • The payload sent when invoking a “close tabs” command.

    See more

    Declaration

    Swift

    public struct CloseTabsPayload
    extension 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 more

    Declaration

    Swift

    public struct Device
    extension Device: Equatable, Hashable

  • Device configuration

    See more

    Declaration

    Swift

    public struct DeviceConfig
    extension 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 more

    Declaration

    Swift

    public struct DevicePushSubscription
    extension DevicePushSubscription: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct FxaConfig
    extension 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 more

    Declaration

    Swift

    public struct LocalDevice
    extension 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 more

    Declaration

    Swift

    public struct Profile
    extension 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 more

    Declaration

    Swift

    public struct ScopedKey
    extension ScopedKey: Equatable, Hashable

  • The payload sent when invoking a “send tab” command.

    See more

    Declaration

    Swift

    public struct SendTabPayload
    extension SendTabPayload: Equatable, Hashable

  • An individual entry in the navigation history of a sent tab.

    See more

    Declaration

    Swift

    public struct TabHistoryEntry
    extension TabHistoryEntry: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct UserData
    extension UserData: Equatable, Hashable

  • An encrypted version of [Login]. This is what we return for all the “read” APIs - we never return the cleartext of encrypted fields.

    See more

    Declaration

    Swift

    public struct EncryptedLogin
    extension EncryptedLogin: Equatable, Hashable

  • A login stored in the database

    See more

    Declaration

    Swift

    public struct Login
    extension Login: Equatable, Hashable

  • A login entry from the user, not linked to any database record. The add/update APIs input these, alongside an encryption key.

    See more

    Declaration

    Swift

    public struct LoginEntry
    extension LoginEntry: Equatable, Hashable

  • The fields you can add or update.

    See more

    Declaration

    Swift

    public struct LoginFields
    extension LoginFields: Equatable, Hashable

  • Fields specific to database records

    See more

    Declaration

    Swift

    public struct RecordFields
    extension RecordFields: Equatable, Hashable

  • Fields available only while the encryption key is known.

    See more

    Declaration

    Swift

    public struct SecureLoginFields
    extension SecureLoginFields: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct AppContext
    extension AppContext: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct AvailableExperiment
    extension AvailableExperiment: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct CalculatedAttributes
    extension CalculatedAttributes: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct EnrolledExperiment
    extension EnrolledExperiment: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct EnrollmentChangeEvent
    extension EnrollmentChangeEvent: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct EnrollmentStatusExtraDef
    extension EnrollmentStatusExtraDef: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct ExperimentBranch
    extension ExperimentBranch: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct FeatureExposureExtraDef
    extension FeatureExposureExtraDef: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct MalformedFeatureConfigExtraDef
    extension MalformedFeatureConfigExtraDef: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct BookmarkData
    extension BookmarkData: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct BookmarkFolder
    extension BookmarkFolder: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct BookmarkSeparator
    extension BookmarkSeparator: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct BookmarkUpdateInfo
    extension BookmarkUpdateInfo: Equatable, Hashable

  • Exists just to convince uniffi to generate liftSequence* helpers!

    See more

    Declaration

    Swift

    public struct Dummy
    extension Dummy: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct HistoryHighlight
    extension HistoryHighlight: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct HistoryHighlightWeights
    extension HistoryHighlightWeights: Equatable, Hashable

  • This is what is returned.

    See more

    Declaration

    Swift

    public struct HistoryMetadata
    extension HistoryMetadata: Equatable, Hashable

  • This is used as an “input” to the api.

    See more

    Declaration

    Swift

    public struct HistoryMetadataObservation
    extension HistoryMetadataObservation: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct HistoryMigrationResult
    extension HistoryMigrationResult: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct HistoryVisitInfo
    extension HistoryVisitInfo: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct HistoryVisitInfosWithBound
    extension HistoryVisitInfosWithBound: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct InsertableBookmark
    extension InsertableBookmark: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct InsertableBookmarkFolder
    extension InsertableBookmarkFolder: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct InsertableBookmarkSeparator
    extension InsertableBookmarkSeparator: Equatable, Hashable

  • Options for recording history metadata observations.

    See more

    Declaration

    Swift

    public struct NoteHistoryMetadataObservationOptions
    extension NoteHistoryMetadataObservationOptions: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct RunMaintenanceMetrics
    extension RunMaintenanceMetrics: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct SearchResult
    extension SearchResult: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct TopFrecentSiteInfo
    extension 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 more

    Declaration

    Swift

    public struct VisitObservation
    extension VisitObservation: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct DecryptResponse
    extension DecryptResponse: Equatable, Hashable

  • Key Information that can be used to encrypt payloads

    See more

    Declaration

    Swift

    public struct KeyInfo
    extension KeyInfo: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct PushConfiguration
    extension PushConfiguration: Equatable, Hashable

  • An dictionary describing the push subscription that changed, the caller will receive a list of [PushSubscriptionChanged] when calling [PushManager::verify_connection], one entry for each channel that the caller should resubscribe to

    See more

    Declaration

    Swift

    public struct PushSubscriptionChanged
    extension PushSubscriptionChanged: Equatable, Hashable

  • Subscription Information, the endpoint to send push messages to and the key information that can be used to encrypt payloads

    See more

    Declaration

    Swift

    public struct SubscriptionInfo
    extension SubscriptionInfo: Equatable, Hashable

  • The subscription response object returned from [PushManager::subscribe]

    See more

    Declaration

    Swift

    public struct SubscriptionResponse
    extension SubscriptionResponse: Equatable, Hashable

  • Attachment metadata that can be optionally attached to a [Record]. The [location] should included in calls to [Client::get_attachment].

    See more

    Declaration

    Swift

    public struct Attachment
    extension 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 use server instead.
    • 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.
    See more

    Declaration

    Swift

    public struct RemoteSettingsConfig
    extension RemoteSettingsConfig: Equatable, Hashable

  • Remote settings configuration

    This is the version used in the new API, hence the 2 at the end. The plan is to move consumers to the new API, remove the RemoteSettingsConfig struct, then remove the 2 from this name.

    See more

    Declaration

    Swift

    public struct RemoteSettingsConfig2
    extension RemoteSettingsConfig2: Equatable, Hashable

  • The RemoteSettingsContext object represents the parameters and characteristics of the consuming application. For remote-settings, it is used to filter locally stored records.

    We always fetch all records from the remote-settings storage. Some records could have a filter_expression attached to them, which will be matched against the RemoteSettingsContext.

    When set, only records where the expression is true will be returned.

    See more

    Declaration

    Swift

    public struct RemoteSettingsContext
    extension 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 more

    Declaration

    Swift

    public struct RemoteSettingsRecord
    extension 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 more

    Declaration

    Swift

    public struct RemoteSettingsResponse
    extension RemoteSettingsResponse: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct Record
    extension Record: Equatable, Hashable

  • A single geographic place.

    This corresponds to a single row in the main “geoname” table described in the GeoNames documentation 1. We exclude fields we don’t need.

    See more

    Declaration

    Swift

    public struct Geoname
    extension Geoname: Equatable, Hashable

  • A fetched geoname with info on how it was matched.

    See more

    Declaration

    Swift

    public struct GeonameMatch
    extension GeonameMatch: Equatable, Hashable

  • Single sample for a Glean labeled_timing_distribution

    See more

    Declaration

    Swift

    public struct LabeledTimingSample
    extension LabeledTimingSample: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct QueryWithMetricsResult
    extension QueryWithMetricsResult: Equatable, Hashable

  • Global Suggest configuration data.

    See more

    Declaration

    Swift

    public struct SuggestGlobalConfig
    extension SuggestGlobalConfig: Equatable, Hashable

  • Constraints limit which suggestions to ingest from Remote Settings.

    See more

    Declaration

    Swift

    public struct SuggestIngestionConstraints
    extension SuggestIngestionConstraints: Equatable, Hashable

  • Ingestion metrics

    These are recorded during [crate::Store::ingest] and returned to the consumer to record.

    See more

    Declaration

    Swift

    public struct SuggestIngestionMetrics
    extension 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 more

    Declaration

    Swift

    public struct SuggestionProviderConstraints
    extension SuggestionProviderConstraints: Equatable, Hashable

  • A query for suggestions to show in the address bar.

    See more

    Declaration

    Swift

    public struct SuggestionQuery
    extension SuggestionQuery: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct DeviceSettings
    extension DeviceSettings: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct SyncAuthInfo
    extension SyncAuthInfo: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct SyncParams
    extension SyncParams: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct SyncResult
    extension SyncResult: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct ClientRemoteTabs
    extension ClientRemoteTabs: Equatable, Hashable

  • Represents a “pending” command.

    See more

    Declaration

    Swift

    public struct PendingCommand
    extension PendingCommand: Equatable, Hashable
  • See more

    Declaration

    Swift

    public struct RemoteTabRecord
    extension RemoteTabRecord: Equatable, Hashable