Enumerations Reference


                    
                    
                    OhttpError

Declaration

Swift

public enum OhttpError

extension OhttpError: Equatable, Hashable

extension OhttpError: Foundation.LocalizedError


                    
                    
                    AutofillApiError

Declaration

Swift

public enum AutofillApiError

extension AutofillApiError: Equatable, Hashable

extension AutofillApiError: Foundation.LocalizedError


                    
                    
                    CrashTestError

An error that can be returned from Rust code.

Declaration

Swift

public enum CrashTestError

extension CrashTestError: Equatable, Hashable

extension CrashTestError: Foundation.LocalizedError


                    
                    
                    AccountEvent

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.

Declaration

Swift

public enum AccountEvent

extension AccountEvent: Equatable, Hashable


                    
                    
                    CloseTabsResult

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.

Declaration

Swift

public enum CloseTabsResult

extension CloseTabsResult: Equatable, Hashable


                    
                    
                    DeviceCapability

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.

Declaration

Swift

public enum DeviceCapability

extension DeviceCapability: Equatable, Hashable


                    
                    
                    FxaError

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.

Declaration

Swift

public enum FxaError

extension FxaError: Equatable, Hashable

extension FxaError: Foundation.LocalizedError


                    
                    
                    FxaEvent

Declaration

Swift

public enum FxaEvent

extension FxaEvent: Equatable, Hashable


                    
                    
                    FxaRustAuthState

Declaration

Swift

public enum FxaRustAuthState

extension FxaRustAuthState: Equatable, Hashable


                    
                    
                    FxaServer

FxA server to connect to

Declaration

Swift

public enum FxaServer

extension FxaServer: Equatable, Hashable


                    
                    
                    FxaState

Declaration

Swift

public enum FxaState

extension FxaState: Equatable, Hashable


                    
                    
                    FxaStateCheckerEvent

Declaration

Swift

public enum FxaStateCheckerEvent

extension FxaStateCheckerEvent: Equatable, Hashable


                    
                    
                    FxaStateCheckerState

Declaration

Swift

public enum FxaStateCheckerState

extension FxaStateCheckerState: Equatable, Hashable


                    
                    
                    IncomingDeviceCommand

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.

Declaration

Swift

public enum IncomingDeviceCommand

extension IncomingDeviceCommand: Equatable, Hashable


                    
                    
                    LoginsApiError

These are the errors returned by our public API.

Declaration

Swift

public enum LoginsApiError

extension LoginsApiError: Equatable, Hashable

extension LoginsApiError: Foundation.LocalizedError


                    
                    
                    EnrollmentChangeEventType

Declaration

Swift

public enum EnrollmentChangeEventType

extension EnrollmentChangeEventType: Equatable, Hashable


                    
                    
                    NimbusError

Declaration

Swift

public enum NimbusError

extension NimbusError: Equatable, Hashable

extension NimbusError: Foundation.LocalizedError


                    
                    
                    BookmarkItem

Declaration

Swift

public enum BookmarkItem

extension BookmarkItem: Equatable, Hashable


                    
                    
                    BookmarkPosition

Where the item should be placed.

Declaration

Swift

public enum BookmarkPosition

extension BookmarkPosition: Equatable, Hashable


                    
                    
                    ConnectionType

Declaration

Swift

public enum ConnectionType

extension ConnectionType: Equatable, Hashable


                    
                    
                    DocumentType

Declaration

Swift

public enum DocumentType

extension DocumentType: Equatable, Hashable


                    
                    
                    FrecencyThresholdOption

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

Declaration

Swift

public enum FrecencyThresholdOption

extension FrecencyThresholdOption: Equatable, Hashable


                    
                    
                    HistoryMetadataPageMissingBehavior

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

Declaration

Swift

public enum HistoryMetadataPageMissingBehavior

extension HistoryMetadataPageMissingBehavior: Equatable, Hashable


                    
                    
                    InsertableBookmarkItem

Declaration

Swift

public enum InsertableBookmarkItem

extension InsertableBookmarkItem: Equatable, Hashable


                    
                    
                    PlacesApiError

Declaration

Swift

public enum PlacesApiError

extension PlacesApiError: Equatable, Hashable

extension PlacesApiError: Foundation.LocalizedError


                    
                    
                    VisitType

Declaration

Swift

public enum VisitType

extension VisitType: Equatable, Hashable


                    
                    
                    BridgeType

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.

Declaration

Swift

public enum BridgeType

extension BridgeType: Equatable, Hashable


                    
                    
                    PushApiError

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

Declaration

Swift

public enum PushApiError

extension PushApiError: Equatable, Hashable

extension PushApiError: Foundation.LocalizedError


                    
                    
                    PushHttpProtocol

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

Declaration

Swift

public enum PushHttpProtocol

extension PushHttpProtocol: Equatable, Hashable


                    
                    
                    RemoteSettingsError

Public error class, this is what we return to consumers

Declaration

Swift

public enum RemoteSettingsError

extension RemoteSettingsError: Equatable, Hashable

extension RemoteSettingsError: Foundation.LocalizedError


                    
                    
                    RemoteSettingsServer

The Remote Settings server that the client should use.

Declaration

Swift

public enum RemoteSettingsServer

extension RemoteSettingsServer: Equatable, Hashable


                    
                    
                    Level

Declaration

Swift

public enum Level

extension Level: Equatable, Hashable


                    
                    
                    GeonameMatchType

Declaration

Swift

public enum GeonameMatchType

extension GeonameMatchType: Equatable, Hashable


                    
                    
                    GeonameType

The type of a geoname.

Declaration

Swift

public enum GeonameType

extension GeonameType: Equatable, Hashable


                    
                    
                    InterruptKind

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

Declaration

Swift

public enum InterruptKind

extension InterruptKind: Equatable, Hashable


                    
                    
                    SuggestApiError

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

Declaration

Swift

public enum SuggestApiError

extension SuggestApiError: Equatable, Hashable

extension SuggestApiError: Foundation.LocalizedError


                    
                    
                    SuggestProviderConfig

Per-provider configuration data.

Declaration

Swift

public enum SuggestProviderConfig

extension SuggestProviderConfig: Equatable, Hashable


                    
                    
                    Suggestion

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

Declaration

Swift

public enum Suggestion

extension Suggestion: Equatable, Hashable


                    
                    
                    SuggestionProvider

A provider is a source of search suggestions.

Declaration

Swift

public enum SuggestionProvider : UInt8

extension SuggestionProvider: Equatable, Hashable


                    
                    
                    DeviceType

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.

Declaration

Swift

public enum DeviceType

extension DeviceType: Equatable, Hashable


                    
                    
                    ServiceStatus

Declaration

Swift

public enum ServiceStatus

extension ServiceStatus: Equatable, Hashable


                    
                    
                    SyncEngineSelection

Declaration

Swift

public enum SyncEngineSelection

extension SyncEngineSelection: Equatable, Hashable


                    
                    
                    SyncManagerError

Declaration

Swift

public enum SyncManagerError

extension SyncManagerError: Equatable, Hashable

extension SyncManagerError: Foundation.LocalizedError


                    
                    
                    SyncReason

Declaration

Swift

public enum SyncReason

extension SyncReason: Equatable, Hashable


                    
                    
                    RemoteCommand

A command which should be sent to a remote device.

Declaration

Swift

public enum RemoteCommand

extension RemoteCommand: Equatable, Hashable


                    
                    
                    TabsApiError

Declaration

Swift

public enum TabsApiError

extension TabsApiError: Equatable, Hashable

extension TabsApiError: Foundation.LocalizedError