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

FirefoxAccount

open class FirefoxAccount : Disposable, AutoCloseable, FirefoxAccountInterface

Object representing the signed-in state of an application.

The FirefoxAccount object is the main interface provided by this crate. It represents the signed-in state of an application that may be connected to user's Firefox Account, and provides methods for inspecting the state of the account and accessing other services on behalf of the user.

Constructors

FirefoxAccount

constructor(config: FxaConfig)

Create a new `FirefoxAccount` instance, not connected to any account.

Types

Companion

object Companion

Functions

authorizeCodeUsingSessionToken

open override fun authorizeCodeUsingSessionToken(params: AuthorizationParameters): String

Create a new OAuth authorization code using the stored session token.

beginOauthFlow

open override fun beginOauthFlow(scopes: List<String>, entrypoint: String, service: String): String

Initiate a web-based OAuth sign-in flow.

beginPairingFlow

open override fun beginPairingFlow(pairingUrl: String, scopes: List<String>, entrypoint: String, service: String): String

Initiate a device-pairing sign-in flow.

checkAuthorizationStatus

open override fun checkAuthorizationStatus(): AuthorizationInfo

Check authorization status for this application.

clearAccessTokenCache

open override fun clearAccessTokenCache()

Clear the access token cache in response to an auth failure.

clearDeviceName

open override fun clearDeviceName()

Clear any custom display name used for this application instance.

@Synchronized

open override fun close()

closeTabs

open override fun closeTabs(targetDeviceId: String, urls: List<String>): CloseTabsResult

Use device commands to close one or more tabs on another device.

completeOauthFlow

open override fun completeOauthFlow(code: String, state: String)

Complete an OAuth flow.

destroy

open override fun destroy()

disconnect

open override fun disconnect()

Disconnect from the user's account.

ensureCapabilities

open override fun ensureCapabilities(supportedCapabilities: List<DeviceCapability>): LocalDevice

Ensure that the device record has a specific set of capabilities.

gatherTelemetry

open override fun gatherTelemetry(): String

Collect and return telemetry about incoming and outgoing device commands.

getAccessToken

open override fun getAccessToken(scope: String, useCache: Boolean): AccessTokenInfo

Get a short-lived OAuth access token for the user's account.

getAttachedClients

open override fun getAttachedClients(): List<AttachedClient>

Get the list of all client applications attached to the user's account.

getAuthState

open override fun getAuthState(): FxaRustAuthState

Get the high-level authentication state of the client

getConnectionSuccessUrl

open override fun getConnectionSuccessUrl(): String

Get a URL which shows a "successfully connceted!" message.

getCurrentDeviceId

open override fun getCurrentDeviceId(): String

Get the device id registered for this application.

getDevices

open override fun getDevices(ignoreCache: Boolean): List<Device>

Get the list of devices registered on the user's account.

getManageAccountUrl

open override fun getManageAccountUrl(entrypoint: String): String

Get a URL at which the user can manage their account and profile data.

getManageDevicesUrl

open override fun getManageDevicesUrl(entrypoint: String): String

Get a URL at which the user can manage the devices connected to their account.

getPairingAuthorityUrl

open override fun getPairingAuthorityUrl(): String

Get the URL at which to begin a device-pairing signin flow.

getProfile

open override fun getProfile(ignoreCache: Boolean): Profile

Get profile information for the signed-in user, if any.

getSignedInUserForWebChannel

open override fun getSignedInUserForWebChannel(): String?

Returns a complete signedInUser JSON object for a WebChannel fxaccounts:fxa_status response, embedding the session token privately. Email and uid come from the cached profile in internal state. Returns null if no session token is set.

getState

open override fun getState(): FxaState

Get the current state

getTokenServerEndpointUrl

open override fun getTokenServerEndpointUrl(): String

Get the URL at which to access the user's sync data.

handlePushMessage

open override fun handlePushMessage(payload: String): AccountEvent

Process and respond to a server-delivered account update message

handleWebChannelLogin

open override fun handleWebChannelLogin(jsonPayload: String)

Stores anything necessary from a WebChannel login JSON payload. This includes the session token, but that is abstracted because the consuming apps should not be aware of the specific payload format returned, nor should they get access to the session token directly if possible. The json_payload is the data object from the fxaccounts:login WebChannel command.

handleWebChannelPasswordChange

open override fun handleWebChannelPasswordChange(jsonPayload: String)

Handle a WebChannel password-change notification by exchanging the new session token for a new refresh token via a network call. The json_payload is the data object from the fxaccounts:change_password WebChannel command.

initializeDevice