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.

sealed class AccountEvent

An event that happened on the user's account.

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.

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.

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.

interface Disposable

interface FfiConverter<KotlinType, FfiType>

FfiConverterBoolean

object FfiConverterBoolean : FfiConverter<Boolean, Byte>

FfiConverterLong

object FfiConverterLong : FfiConverter<Long, Long>

FfiConverterOptionalLong

object FfiConverterOptionalLong : FfiConverterRustBuffer<Long?>

FfiConverterOptionalSequenceString

object FfiConverterOptionalSequenceString : FfiConverterRustBuffer<List<String>?>

FfiConverterOptionalString

object FfiConverterOptionalString : FfiConverterRustBuffer<String?>

FfiConverterOptionalTypeDevice

object FfiConverterOptionalTypeDevice : FfiConverterRustBuffer<Device?>

FfiConverterOptionalTypeDevicePushSubscription

object FfiConverterOptionalTypeDevicePushSubscription : FfiConverterRustBuffer<DevicePushSubscription?>

FfiConverterOptionalTypeScopedKey

object FfiConverterOptionalTypeScopedKey : FfiConverterRustBuffer<ScopedKey?>

FfiConverterRustBuffer

interface FfiConverterRustBuffer<KotlinType> : FfiConverter<KotlinType, RustBuffer.ByValue>

FfiConverterSequenceString

object FfiConverterSequenceString : FfiConverterRustBuffer<List<String>>

FfiConverterSequenceTypeAttachedClient

object FfiConverterSequenceTypeAttachedClient : FfiConverterRustBuffer<List<AttachedClient>>

FfiConverterSequenceTypeDevice

object FfiConverterSequenceTypeDevice : FfiConverterRustBuffer<List<Device>>

FfiConverterSequenceTypeDeviceCapability

object FfiConverterSequenceTypeDeviceCapability : FfiConverterRustBuffer<List<DeviceCapability>>

FfiConverterSequenceTypeIncomingDeviceCommand

object FfiConverterSequenceTypeIncomingDeviceCommand : FfiConverterRustBuffer<List<IncomingDeviceCommand>>

FfiConverterSequenceTypeTabHistoryEntry

object FfiConverterSequenceTypeTabHistoryEntry : FfiConverterRustBuffer<List<TabHistoryEntry>>

FfiConverterString

object FfiConverterString : FfiConverter<String, RustBuffer.ByValue>

FfiConverterTypeAccessTokenInfo

object FfiConverterTypeAccessTokenInfo : FfiConverterRustBuffer<AccessTokenInfo>

FfiConverterTypeAccountEvent

object FfiConverterTypeAccountEvent : FfiConverterRustBuffer<AccountEvent>

FfiConverterTypeAttachedClient

object FfiConverterTypeAttachedClient : FfiConverterRustBuffer<AttachedClient>

FfiConverterTypeAuthorizationInfo

object FfiConverterTypeAuthorizationInfo : FfiConverterRustBuffer<AuthorizationInfo>

FfiConverterTypeAuthorizationParameters

object FfiConverterTypeAuthorizationParameters : FfiConverterRustBuffer<AuthorizationParameters>

FfiConverterTypeCloseTabsPayload

object FfiConverterTypeCloseTabsPayload : FfiConverterRustBuffer<CloseTabsPayload>

FfiConverterTypeCloseTabsResult

object FfiConverterTypeCloseTabsResult : FfiConverterRustBuffer<CloseTabsResult>

FfiConverterTypeDevice

object FfiConverterTypeDevice : FfiConverterRustBuffer<Device>

FfiConverterTypeDeviceCapability

object FfiConverterTypeDeviceCapability : FfiConverterRustBuffer<DeviceCapability>

FfiConverterTypeDeviceConfig

object FfiConverterTypeDeviceConfig : FfiConverterRustBuffer<DeviceConfig>

FfiConverterTypeDevicePushSubscription

object FfiConverterTypeDevicePushSubscription : FfiConverterRustBuffer<DevicePushSubscription>

FfiConverterTypeFirefoxAccount

object FfiConverterTypeFirefoxAccount : FfiConverter<FirefoxAccount, <Error class: unknown class>>

FfiConverterTypeFxaConfig

object FfiConverterTypeFxaConfig : FfiConverterRustBuffer<FxaConfig>

FfiConverterTypeFxaError

object FfiConverterTypeFxaError : FfiConverterRustBuffer<FxaException>

FfiConverterTypeFxaEvent

object FfiConverterTypeFxaEvent : FfiConverterRustBuffer<FxaEvent>

FfiConverterTypeFxaRustAuthState

object FfiConverterTypeFxaRustAuthState : FfiConverterRustBuffer<FxaRustAuthState>

FfiConverterTypeFxaServer

object FfiConverterTypeFxaServer : FfiConverterRustBuffer<FxaServer>

FfiConverterTypeFxaState

object FfiConverterTypeFxaState : FfiConverterRustBuffer<FxaState>

FfiConverterTypeFxaStateCheckerEvent

object FfiConverterTypeFxaStateCheckerEvent : FfiConverterRustBuffer<FxaStateCheckerEvent>

FfiConverterTypeFxaStateCheckerState

object FfiConverterTypeFxaStateCheckerState : FfiConverterRustBuffer<FxaStateCheckerState>

FfiConverterTypeFxaStateMachineChecker

object FfiConverterTypeFxaStateMachineChecker : FfiConverter<FxaStateMachineChecker, <Error class: unknown class>>

FfiConverterTypeIncomingDeviceCommand

object FfiConverterTypeIncomingDeviceCommand : FfiConverterRustBuffer<IncomingDeviceCommand>

FfiConverterTypeLocalDevice

object FfiConverterTypeLocalDevice : FfiConverterRustBuffer<LocalDevice>

FfiConverterTypeProfile

object FfiConverterTypeProfile : FfiConverterRustBuffer<Profile>

FfiConverterTypeScopedKey

object FfiConverterTypeScopedKey : FfiConverterRustBuffer<ScopedKey>

FfiConverterTypeSendTabPayload

object FfiConverterTypeSendTabPayload : FfiConverterRustBuffer<SendTabPayload>

FfiConverterTypeTabHistoryEntry

object FfiConverterTypeTabHistoryEntry : FfiConverterRustBuffer<TabHistoryEntry>

FfiConverterTypeUserData

object FfiConverterTypeUserData : FfiConverterRustBuffer<UserData>

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.

open class ForeignBytes

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

sealed class FxaEvent

sealed class FxaException : Exception

Generic error type thrown by many `FirefoxAccount` operations.

FxaRustAuthState

enum FxaRustAuthState : Enum<FxaRustAuthState>

sealed class FxaServer

FxA server to connect to

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

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

object NoPointer

Used to instantiate an interface without an actual pointer, for fakes in tests, mostly.

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.

open class RustBuffer

RustBufferByReference

class RustBufferByReference

The equivalent of the *mut RustBuffer type. Required for callbacks taking in an out pointer.

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

A cryptographic key associated with an OAuth scope.

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.

interface UniffiCleaner

UniffiNullRustCallStatusErrorHandler

object UniffiNullRustCallStatusErrorHandler : UniffiRustCallStatusErrorHandler<InternalException>

UniffiRustCallStatusErrorHandler

interface UniffiRustCallStatusErrorHandler<E>

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

Functions

inline fun <T : Disposable?, R> T.use(block: (T) -> R): R