kotlin-components-docs/mozilla.appservices.fxaclient/FxaException

FxaException

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.

Inheritors

SyncScopedKeyMissingInServerResponse

Panic

Other

Types

Authentication

class Authentication(message: String) : FxaException

Thrown when there was a problem with the authentication status of the account, such as an expired token. The application should * FirefoxAccount::check_authorization_status to see whether it has been disconnected, or retry the operation with a freshly-generated token.

ErrorHandler

object ErrorHandler : UniffiRustCallStatusErrorHandler<FxaException>

Network

class Network(message: String) : FxaException

Thrown if an operation fails due to network access problems. The application may retry at a later time once connectivity is restored.

NoExistingAuthFlow

class NoExistingAuthFlow(message: String) : FxaException

Thrown if the application attempts to complete an OAuth flow when no OAuth flow has been initiated for that state. This may indicate a user who navigated directly to the OAuth redirect_uri for the application.

OriginMismatch

class OriginMismatch(message: String) : FxaException

Origin mismatch when handling a pairing flow

Other

class Other(message: String) : FxaException

A catch-all for other unspecified errors.

Panic

class Panic(message: String) : FxaException

Thrown if there is a panic in the underlying Rust code.

SyncScopedKeyMissingInServerResponse

class SyncScopedKeyMissingInServerResponse(message: String) : FxaException

The sync scoped key was missing in the server response

WrongAuthFlow

class WrongAuthFlow(message: String) : FxaException

Thrown if the application attempts to complete an OAuth flow, but the state tokens returned from the Firefox Account server do not match with the ones expected by the client. This may indicate a stale OAuth flow, or potentially an attempted hijacking of the flow by an attacker. The signin attempt cannot be completed.