kotlin-components-docs/mozilla.appservices.fxaclient

Package-level declarations

Types

AccessTokenInfo

data class AccessTokenInfo(var scope: String, var token: String, var key: ScopedKey?, var expiresAt: Long)

An OAuth access token, with its associated keys and metadata.

AccountEvent

sealed class AccountEvent

An event that happened on the user's account.

AttachedClient

data class AttachedClient(var clientId: String?, var deviceId: String?, var deviceType: DeviceType, var isCurrentSession: Boolean, var name: String?, var createdTime: Long?, var lastAccessTime: Long?, var scope: List<String>?)

A client connected to the user's account.

AuthorizationInfo

data class AuthorizationInfo(var active: Boolean)

Information about the authorization state of the application.

AuthorizationParameters

data class AuthorizationParameters(var clientId: String, var scope: List<String>, var state: String, var accessType: String, var codeChallenge: String?, var codeChallengeMethod: String?, var keysJwk: String?)

Parameters provided in an incoming OAuth request.

CloseTabsPayload

data class CloseTabsPayload(var urls: List<String>)

The payload sent when invoking a "close tabs" command.

CloseTabsResult

sealed class CloseTabsResult

The result of invoking a "close tabs" command.

Device

data class Device(var id: String, var displayName: String, var deviceType: DeviceType, var capabilities: List<DeviceCapability>, var pushSubscription: DevicePushSubscription?, var pushEndpointExpired: Boolean, var isCurrentDevice: Boolean, var lastAccessTime: Long?)

A device connected to the user's account.

DeviceCapability

enum DeviceCapability : Enum<DeviceCapability>

A "capability" offered by a device.

DeviceConfig

data class DeviceConfig(var name: String, var deviceType: DeviceType, var capabilities: List<DeviceCapability>)

Device configuration

DevicePushSubscription

data class DevicePushSubscription(var endpoint: String, var publicKey: String, var authKey: String)

Details of a web-push subscription endpoint.

Disposable

interface Disposable

FirefoxAccount

open class FirefoxAccount : Disposable, AutoCloseable, FirefoxAccountInterface

Object representing the signed-in state of an application.

FirefoxAccountInterface

interface FirefoxAccountInterface

Object representing the signed-in state of an application.

FxaConfig

data class FxaConfig(var server: FxaServer, var clientId: String, var redirectUri: String, var tokenServerUrlOverride: String? = null)

FxaEvent

sealed class FxaEvent

FxaException

sealed class FxaException : Exception

Generic error type thrown by many `FirefoxAccount` operations.

FxaRustAuthState

enum FxaRustAuthState : Enum<FxaRustAuthState>

FxaServer

sealed class FxaServer

FxA server to connect to

FxaState

sealed class FxaState

FxaStateCheckerEvent

sealed class FxaStateCheckerEvent

FxaStateCheckerState

sealed class FxaStateCheckerState

FxaStateMachineChecker

open class FxaStateMachineChecker : Disposable, AutoCloseable, FxaStateMachineCheckerInterface

Machinery for dry-run testing of FxaAuthStateMachine

FxaStateMachineCheckerInterface

interface FxaStateMachineCheckerInterface

Machinery for dry-run testing of FxaAuthStateMachine

IncomingDeviceCommand

sealed class IncomingDeviceCommand

A command invoked by another device.

InternalException

class InternalException(message: String) : Exception

LocalDevice

data class LocalDevice(var id: String, var displayName: String, var deviceType: DeviceType, var capabilities: List<DeviceCapability>, var pushSubscription: DevicePushSubscription?, var pushEndpointExpired: Boolean)

Local device that's connecting to FxA

Profile

data class Profile(var uid: String, var email: String, var displayName: String?, var avatar: String, var isDefaultAvatar: Boolean)

Information about the user that controls a Firefox Account.

ScopedKey

data class ScopedKey(var kty: String, var scope: String, var k: String, var kid: String)

A cryptographic key associated with an OAuth scope.

SendTabPayload

data class SendTabPayload(var entries: List<TabHistoryEntry>, var flowId: String = "", var streamId: String = "")

The payload sent when invoking a "send tab" command.

TabHistoryEntry

data class TabHistoryEntry(var title: String, var url: String)

An individual entry in the navigation history of a sent tab.

UserData

data class UserData(var sessionToken: String, var uid: String, var email: String, var verified: Boolean)