Enumerations

The following enumerations are available globally.

  • See more

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

  • An error that can be returned from Rust code.

    See more

    Declaration

    Swift

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

  • 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 : Equatable, Hashable
    extension AccountEvent: Sendable

  • 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 : Equatable, Hashable
    extension CloseTabsResult: Sendable

  • 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 : Equatable, Hashable
    extension DeviceCapability: Sendable

  • 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, Equatable, Hashable, Foundation.LocalizedError
    extension FxaError: Sendable
  • See more

    Declaration

    Swift

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

    Declaration

    Swift

    public enum FxaRustAuthState : Equatable, Hashable
    extension FxaRustAuthState: Sendable

  • FxA server to connect to

    See more

    Declaration

    Swift

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

    Declaration

    Swift

    public enum FxaState : Equatable, Hashable
    extension FxaState: Sendable

  • 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 : Equatable, Hashable
    extension IncomingDeviceCommand: Sendable

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

    See more

    Declaration

    Swift

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

    Declaration

    Swift

    public enum LoginOrErrorMessage : Equatable, Hashable
    extension LoginOrErrorMessage: Sendable

  • These are the errors returned by our public API.

    See more

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

    public enum BookmarkItem : Equatable, Hashable
    extension BookmarkItem: Sendable

  • Where the item should be placed.

    See more

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

    public enum DocumentType : Equatable, Hashable
    extension DocumentType: Sendable

  • 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 : Equatable, Hashable
    extension FrecencyThresholdOption: Sendable

  • 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 : Equatable, Hashable
    extension HistoryMetadataPageMissingBehavior: Sendable
  • See more

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

    public enum VisitType : Equatable, Hashable
    extension VisitType: Sendable

  • 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 : Equatable, Hashable
    extension BridgeType: Sendable

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

    See more

    Declaration

    Swift

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

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

    See more

    Declaration

    Swift

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

    Declaration

    Swift

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

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

    See more

    Declaration

    Swift

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

  • The Remote Settings server that the client should use.

    See more

    Declaration

    Swift

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

    Declaration

    Swift

    public enum Level : Equatable, Hashable
    extension Level: Sendable

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

    See more

    Declaration

    Swift

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

    Declaration

    Swift

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

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

    See more

    Declaration

    Swift

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

    Declaration

    Swift

    public enum SearchDeviceType : Equatable, Hashable
    extension SearchDeviceType: Sendable

  • The list of acceptable classifications for a search engine.

    See more

    Declaration

    Swift

    public enum SearchEngineClassification : Equatable, Hashable
    extension SearchEngineClassification: Sendable

  • 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 : Equatable, Hashable
    extension SearchUpdateChannel: Sendable
  • See more

    Declaration

    Swift

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

    Declaration

    Swift

    public enum GeonameMatchType : Equatable, Hashable
    extension GeonameMatchType: Sendable

  • The type of a geoname.

    See more

    Declaration

    Swift

    public enum GeonameType : Equatable, Hashable
    extension GeonameType: Sendable

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

    See more

    Declaration

    Swift

    public enum InterruptKind : Equatable, Hashable
    extension InterruptKind: Sendable

  • 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, Equatable, Hashable, Foundation.LocalizedError
    extension SuggestApiError: Sendable

  • Per-provider configuration data.

    See more

    Declaration

    Swift

    public enum SuggestProviderConfig : Equatable, Hashable
    extension SuggestProviderConfig: Sendable

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

    See more

    Declaration

    Swift

    public enum Suggestion : Equatable, Hashable
    extension Suggestion: Sendable

  • 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, Equatable, Hashable
    extension SuggestionProvider: Sendable

  • Subject type for Yelp suggestion.

    See more

    Declaration

    Swift

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

  • 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 : Equatable, Hashable
    extension DeviceType: Sendable
  • See more

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

    public enum SyncReason : Equatable, Hashable
    extension SyncReason: Sendable

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

    See more

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

    public enum TracingLevel : Equatable, Hashable
    extension TracingLevel: Sendable

  • HTTP Methods.

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

    See more

    Declaration

    Swift

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

    Declaration

    Swift

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