Enum fxa_client::FxaEvent

pub enum FxaEvent {
    Initialize {
        device_config: DeviceConfig,
    },
    BeginOAuthFlow {
        scopes: Vec<String>,
        entrypoint: String,
    },
    BeginPairingFlow {
        pairing_url: String,
        scopes: Vec<String>,
        entrypoint: String,
    },
    CompleteOAuthFlow {
        code: String,
        state: String,
    },
    CancelOAuthFlow,
    CheckAuthorizationStatus,
    Disconnect,
    CallGetProfile,
}

Fxa event

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

Variants

Initialize

Fields

device_config: DeviceConfig

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

BeginOAuthFlow

Fields

scopes: Vec<String>

entrypoint: String

Begin an oauth flow

If successful, the state machine will transition the FxaState::Authenticating. The next step is to navigate the user to the oauth_url and let them sign and authorize the client.

BeginPairingFlow

Fields

pairing_url: String

scopes: Vec<String>

entrypoint: String

Begin an oauth flow using a URL from a pairing code

If successful, the state machine will transition the FxaState::Authenticating. The next step is to navigate the user to the oauth_url and let them sign and authorize the client.

CompleteOAuthFlow

Fields

code: String

state: String

Complete an OAuth flow.

Send this event after the user has navigated through the OAuth flow and has reached the redirect URI. Extract code and state from the query parameters or web channel. If successful the state machine will transition to FxaState::Connected.

CancelOAuthFlow

Cancel an OAuth flow.

Use this to cancel an in-progress OAuth, returning to FxaState::Disconnected so the process can begin again.

CheckAuthorizationStatus

Check the authorization status for a connected account.

Send this when issues are detected with the auth tokens for a connected account. It will double check for authentication issues with the account. If it detects them, the state machine will transition to FxaState::AuthIssues. From there you can start an OAuth flow again to re-connect the user.

Disconnect

Disconnect the user

Send this when the user is asking to be logged out. The state machine will transition to FxaState::Disconnected.

CallGetProfile

Force a call to FirefoxAccount::get_profile

This is used for testing the auth/network retry code, since it hits the network and requires and auth token.

Trait Implementations

impl Clone for FxaEvent

fn clone(&self) -> FxaEvent

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FxaEvent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for FxaEvent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for FxaEvent

fn eq(&self, other: &FxaEvent) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for FxaEvent

impl StructuralEq for FxaEvent

impl StructuralPartialEq for FxaEvent