Enumerations

The following enumerations are available globally.

  • See more

    Declaration

    Swift

    public enum MozAdsCacheMode
    extension MozAdsCacheMode: Sendable
    extension MozAdsCacheMode: Equatable, Hashable
  • See more

    Declaration

    Swift

    public enum MozAdsClientApiError : Swift.Error
    extension MozAdsClientApiError: Equatable, Hashable
    extension MozAdsClientApiError: Foundation.LocalizedError
  • See more

    Declaration

    Swift

    public enum MozAdsEnvironment
    extension MozAdsEnvironment: Sendable
    extension MozAdsEnvironment: Equatable, Hashable
  • See more

    Declaration

    Swift

    public enum MozAdsIabContentTaxonomy
    extension MozAdsIabContentTaxonomy: Sendable
    extension MozAdsIabContentTaxonomy: Equatable, Hashable
  • See more

    Declaration

    Swift

    public enum OhttpError : Swift.Error
    extension OhttpError: Equatable, Hashable
    extension OhttpError: Foundation.LocalizedError
  • See more

    Declaration

    Swift

    public enum AutofillApiError : Swift.Error
    extension AutofillApiError: Equatable, Hashable
    extension AutofillApiError: Foundation.LocalizedError
  • See more

    Declaration

    Swift

    public enum ApiError : Swift.Error
    extension ApiError: Equatable, Hashable
    extension ApiError: Foundation.LocalizedError

  • An error that can be returned from Rust code.

    See more

    Declaration

    Swift

    public enum CrashTestError : Swift.Error
    extension CrashTestError: Equatable, Hashable
    extension CrashTestError: Foundation.LocalizedError

  • An event that happened on the user’s account.

    If the application has registered a [DevicePushSubscription] as part of its device record, then the Firefox Accounts server can send push notifications about important events that happen on the user’s account. This enum represents the different kinds of event that can occur.

    See more

    Declaration

    Swift

    public enum AccountEvent
    extension AccountEvent: Sendable
    extension AccountEvent: Equatable, Hashable

  • The result of invoking a “close tabs” command.

    If [FirefoxAccount::close_tabs] is called with more URLs than can fit into a single command payload, the URLs will be chunked and sent in multiple commands.

    Chunking breaks the atomicity of a “close tabs” command, but reduces the number of these commands that FxA sends to other devices. This is critical for platforms like iOS, where every command triggers a push message that must show a user-visible notification.

    See more

    Declaration

    Swift

    public enum CloseTabsResult
    extension CloseTabsResult: Sendable
    extension CloseTabsResult: Equatable, Hashable

  • A “capability” offered by a device.

    In the FxA ecosystem, connected devices may advertize their ability to respond to various “commands” that can be invoked by other devices. The details of executing these commands are encapsulated as part of the FxA Client component, so consumers simply need to select which ones they want to support, and can use the variants of this enum to do so.

    See more

    Declaration

    Swift

    public enum DeviceCapability
    extension DeviceCapability: Sendable
    extension DeviceCapability: Equatable, Hashable

  • Generic error type thrown by many [FirefoxAccount] operations.

    Precise details of the error are hidden from consumers, mostly due to limitations of how we expose this API to other languages. The type of the error indicates how the calling code should respond.

    See more

    Declaration

    Swift

    public enum FxaError : Swift.Error
    extension FxaError: Equatable, Hashable
    extension FxaError: Foundation.LocalizedError
  • See more

    Declaration

    Swift

    public enum FxaEvent
    extension FxaEvent: Sendable
    extension FxaEvent: Equatable, Hashable
  • See more

    Declaration

    Swift

    public enum FxaRustAuthState
    extension FxaRustAuthState: Sendable
    extension FxaRustAuthState: Equatable, Hashable

  • FxA server to connect to

    See more

    Declaration

    Swift

    public enum FxaServer
    extension FxaServer: Sendable
    extension FxaServer: Equatable, Hashable
  • See more

    Declaration

    Swift

    public enum FxaState
    extension FxaState: Sendable
    extension FxaState: Equatable, Hashable

  • A command invoked by another device.

    This enum represents all possible commands that can be invoked on the device. It is the responsibility of the application to interpret each command.

    See more

    Declaration

    Swift

    public enum IncomingDeviceCommand
    extension IncomingDeviceCommand: Sendable
    extension IncomingDeviceCommand: Equatable, Hashable

  • A bulk insert result entry, returned by add_many and add_many_with_meta

    See more

    Declaration

    Swift

    public enum BulkResultEntry
    extension BulkResultEntry: Sendable
    extension BulkResultEntry: Equatable, Hashable
  • See more

    Declaration

    Swift

    public enum LoginOrErrorMessage
    extension LoginOrErrorMessage: Sendable
    extension LoginOrErrorMessage: Equatable, Hashable

  • These are the errors returned by our public API.

    See more

    Declaration

    Swift

    public enum LoginsApiError : Swift.Error
    extension LoginsApiError: Equatable, Hashable
    extension LoginsApiError: Foundation.LocalizedError
  • See more

    Declaration

    Swift

    public enum CuratedRecommendationLocale
    extension CuratedRecommendationLocale: Sendable
    extension CuratedRecommendationLocale: Equatable, Hashable
  • See more

    Declaration

    Swift

    public enum CuratedRecommendationsApiError : Swift.Error
    extension CuratedRecommendationsApiError: Equatable, Hashable
    extension CuratedRecommendationsApiError: Foundation.LocalizedError
  • See more

    Declaration

    Swift

    public enum EnrollmentChangeEventType
    extension EnrollmentChangeEventType: Sendable
    extension EnrollmentChangeEventType: Equatable, Hashable
  • See more

    Declaration

    Swift

    public enum NimbusError : Swift.Error
    extension NimbusError: Equatable, Hashable
    extension NimbusError: Foundation.LocalizedError
  • See more

    Declaration

    Swift

    public enum PrefBranch
    extension PrefBranch: Sendable
    extension PrefBranch: Equatable, Hashable
  • See more

    Declaration

    Swift

    public enum PrefUnenrollReason
    extension PrefUnenrollReason: Sendable
    extension PrefUnenrollReason: Equatable, Hashable
  • See more

    Declaration

    Swift

    public enum BookmarkItem
    extension BookmarkItem: Sendable
    extension BookmarkItem: Equatable, Hashable

  • Where the item should be placed.

    See more

    Declaration

    Swift

    public enum BookmarkPosition
    extension BookmarkPosition: Sendable
    extension BookmarkPosition: Equatable, Hashable
  • See more

    Declaration

    Swift

    public enum ConnectionType
    extension ConnectionType: Sendable
    extension ConnectionType: Equatable, Hashable
  • See more

    Declaration

    Swift

    public enum DocumentType
    extension DocumentType: Sendable
    extension DocumentType: Equatable, Hashable

  • Frecency threshold options for fetching top frecent sites. Requests a page that was visited with a frecency score greater or equal to the value associated with the enums

    See more

    Declaration

    Swift

    public enum FrecencyThresholdOption
    extension FrecencyThresholdOption: Sendable
    extension FrecencyThresholdOption: Equatable, Hashable

  • The action to take when recording a history metadata observation for a page that doesn’t have an entry in the history database.

    See more

    Declaration

    Swift

    public enum HistoryMetadataPageMissingBehavior
    extension HistoryMetadataPageMissingBehavior: Sendable
    extension HistoryMetadataPageMissingBehavior: Equatable, Hashable
  • See more

    Declaration

    Swift

    public enum InsertableBookmarkItem
    extension InsertableBookmarkItem: Sendable
    extension InsertableBookmarkItem: Equatable, Hashable
  • See more

    Declaration

    Swift

    public enum PlacesApiError : Swift.Error
    extension PlacesApiError: Equatable, Hashable
    extension PlacesApiError: Foundation.LocalizedError
  • See more

    Declaration

    Swift

    public enum VisitType
    extension VisitType: Sendable
    extension VisitType: Equatable, Hashable

  • The types of supported native bridges.

    FCM = Google Android Firebase Cloud Messaging ADM = Amazon Device Messaging for FireTV APNS = Apple Push Notification System for iOS

    Please contact services back-end for any additional bridge protocols.

    See more

    Declaration

    Swift

    public enum BridgeType
    extension BridgeType: Sendable
    extension BridgeType: Equatable, Hashable

  • The main Error returned from the Push component, each variant describes a different error

    See more

    Declaration

    Swift

    public enum PushApiError : Swift.Error
    extension PushApiError: Equatable, Hashable
    extension PushApiError: Foundation.LocalizedError

  • Supported protocols for push “Https” is default, and “Http” is only supported for tests

    See more

    Declaration

    Swift

    public enum PushHttpProtocol
    extension PushHttpProtocol: Sendable
    extension PushHttpProtocol: Equatable, Hashable
  • See more

    Declaration

    Swift

    public enum RelayApiError : Swift.Error
    extension RelayApiError: Equatable, Hashable
    extension RelayApiError: Foundation.LocalizedError

  • Public error class, this is what we return to consumers

    See more

    Declaration

    Swift

    public enum RemoteSettingsError : Swift.Error
    extension RemoteSettingsError: Equatable, Hashable
    extension RemoteSettingsError: Foundation.LocalizedError

  • The Remote Settings server that the client should use.

    See more

    Declaration

    Swift

    public enum RemoteSettingsServer
    extension RemoteSettingsServer: Sendable
    extension RemoteSettingsServer: Equatable, Hashable
  • See more

    Declaration

    Swift

    public enum Level
    extension Level: Sendable
    extension Level: Equatable, Hashable

  • The list of possible submission methods for search engine urls.

    See more

    Declaration

    Swift

    public enum JsonEngineMethod
    extension JsonEngineMethod: Sendable
    extension JsonEngineMethod: Equatable, Hashable
  • See more

    Declaration

    Swift

    public enum SearchApiError : Swift.Error
    extension SearchApiError: Equatable, Hashable
    extension SearchApiError: Foundation.LocalizedError

  • The list of possible application names that are currently supported.

    See more

    Declaration

    Swift

    public enum SearchApplicationName
    extension SearchApplicationName: Sendable
    extension SearchApplicationName: Equatable, Hashable
  • See more

    Declaration

    Swift

    public enum SearchDeviceType
    extension SearchDeviceType: Sendable
    extension SearchDeviceType: Equatable, Hashable

  • The list of acceptable classifications for a search engine.

    See more

    Declaration

    Swift

    public enum SearchEngineClassification
    extension SearchEngineClassification: Sendable
    extension SearchEngineClassification: Equatable, Hashable

  • The list of possible update channels for a user’s build. Use default for a self-build or an unknown channel.

    See more

    Declaration

    Swift

    public enum SearchUpdateChannel
    extension SearchUpdateChannel: Sendable
    extension SearchUpdateChannel: Equatable, Hashable
  • See more

    Declaration

    Swift

    public enum AmpMatchingStrategy
    extension AmpMatchingStrategy: Sendable
    extension AmpMatchingStrategy: Equatable, Hashable
  • See more

    Declaration

    Swift

    public enum GeonameMatchType
    extension GeonameMatchType: Sendable
    extension GeonameMatchType: Equatable, Hashable

  • The type of a geoname.

    See more

    Declaration

    Swift

    public enum GeonameType
    extension GeonameType: Sendable
    extension GeonameType: Equatable, Hashable

  • What should be interrupted when [SuggestStore::interrupt] is called?

    See more

    Declaration

    Swift

    public enum InterruptKind
    extension InterruptKind: Sendable
    extension InterruptKind: Equatable, Hashable

  • The error type for all Suggest component operations. These errors are exposed to your application, which should handle them as needed.

    See more

    Declaration

    Swift

    public enum SuggestApiError : Swift.Error
    extension SuggestApiError: Equatable, Hashable
    extension SuggestApiError: Foundation.LocalizedError

  • Per-provider configuration data.

    See more

    Declaration

    Swift

    public enum SuggestProviderConfig
    extension SuggestProviderConfig: Sendable
    extension SuggestProviderConfig: Equatable, Hashable

  • A suggestion from the database to show in the address bar.

    See more

    Declaration

    Swift

    public enum Suggestion
    extension Suggestion: Sendable
    extension Suggestion: Equatable, Hashable

  • A provider is a source of search suggestions. Please preserve the integer values after removing or adding providers. Provider configs are associated with integer keys stored in the database.

    See more

    Declaration

    Swift

    public enum SuggestionProvider : UInt8
    extension SuggestionProvider: Sendable
    extension SuggestionProvider: Equatable, Hashable

  • Subject type for Yelp suggestion.

    See more

    Declaration

    Swift

    public enum YelpSubjectType : UInt8
    extension YelpSubjectType: Sendable
    extension YelpSubjectType: Equatable, Hashable

  • Enumeration for the different types of device.

    Firefox Accounts separates devices into broad categories for display purposes, such as distinguishing a desktop PC from a mobile phone. Upon signin, the application should inspect the device it is running on and select an appropriate [DeviceType] to include in its device registration record.

    See more

    Declaration

    Swift

    public enum DeviceType
    extension DeviceType: Sendable
    extension DeviceType: Equatable, Hashable
  • See more

    Declaration

    Swift

    public enum ServiceStatus
    extension ServiceStatus: Sendable
    extension ServiceStatus: Equatable, Hashable
  • See more

    Declaration

    Swift

    public enum SyncEngineSelection
    extension SyncEngineSelection: Sendable
    extension SyncEngineSelection: Equatable, Hashable
  • See more

    Declaration

    Swift

    public enum SyncManagerError : Swift.Error
    extension SyncManagerError: Equatable, Hashable
    extension SyncManagerError: Foundation.LocalizedError
  • See more

    Declaration

    Swift

    public enum SyncReason
    extension SyncReason: Sendable
    extension SyncReason: Equatable, Hashable

  • A command which should be sent to a remote device.

    See more

    Declaration

    Swift

    public enum RemoteCommand
    extension RemoteCommand: Sendable
    extension RemoteCommand: Equatable, Hashable
  • See more

    Declaration

    Swift

    public enum TabsApiError : Swift.Error
    extension TabsApiError: Equatable, Hashable
    extension TabsApiError: Foundation.LocalizedError
  • See more

    Declaration

    Swift

    public enum TracingLevel
    extension TracingLevel: Sendable
    extension TracingLevel: Equatable, Hashable

  • HTTP Methods.

    The supported methods are the limited to what’s supported by android-components.

    See more

    Declaration

    Swift

    public enum Method : UInt8
    extension Method: Sendable
    extension Method: Equatable, Hashable
  • See more

    Declaration

    Swift

    public enum ViaductError : Swift.Error
    extension ViaductError: Equatable, Hashable
    extension ViaductError: Foundation.LocalizedError