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

FxaEvent

sealed class FxaEvent

Fxa event

These are the events that consumers send to crate::FxaStateMachine::process_event

Inheritors

BeginPairingFlow

CompleteOAuthFlow

CancelOAuthFlow

CheckAuthorizationStatus

WebChannelPasswordChange

Types

data class BeginOAuthFlow(val service: String, val scopes: List<String>, val entrypoint: String) : FxaEvent

Begin an oauth flow

BeginPairingFlow

data class BeginPairingFlow(val pairingUrl: String, val service: String, val scopes: List<String>, val entrypoint: String) : FxaEvent

Begin an oauth flow using a URL from a pairing code

object CallGetProfile : FxaEvent

Force a call to FirefoxAccount::get_profile

CancelOAuthFlow

object CancelOAuthFlow : FxaEvent

Cancel an OAuth flow.

CheckAuthorizationStatus

object CheckAuthorizationStatus : FxaEvent

Check the authorization status for a connected account.

object Companion

CompleteOAuthFlow

data class CompleteOAuthFlow(val code: String, val state: String) : FxaEvent

Complete an OAuth flow.

object Disconnect : FxaEvent

Disconnect the user

data class Initialize(val deviceConfig: DeviceConfig) : FxaEvent

Initialize the state machine. This must be the first event sent.

WebChannelPasswordChange

data class WebChannelPasswordChange(val jsonPayload: String) : FxaEvent

An fxaccounts:change_password WebChannel message arrived on the device that just changed its password. json_payload is the data object of that message and contains the new session token. The state machine swaps the session token for a new refresh token and re-initialises the device record.