Class LoginContext

Temporary context created for the duration of a [[Kit.login]] call.

This context is used to store the state of the login request and provide a way for plugins to add hooks into the process.

Index

Constructors

Properties

appName? arbitrary chain? chains fetch hooks permissionLevel? session? sessionKeyManager? ui uiRequirements walletPluginIndex? walletPlugins

Accessors

Methods

addHook getClient

Constructors

constructor

new LoginContext(options: LoginContextOptions): LoginContext
Parameters
- options: LoginContextOptions
Returns LoginContext
- Defined in packages/session/src/login.ts:92

Properties

`Optional`appName

appName?: string

arbitrary

arbitrary: Record<string, any> = {}

`Optional`chain

chain?: ChainDefinition<AccountObject>

chains

chains: ChainDefinition<AccountObject>[] = []

fetch

fetch: Fetch

hooks

hooks: LoginHooks = ...

`Optional`permissionLevel

permissionLevel?: PermissionLevel

`Optional`session

session?: Session

The session created during login. Only available in afterLogin hooks.

`Optional`sessionKeyManager

sessionKeyManager?: any

ui

ui: UserInterface

uiRequirements

uiRequirements: UserInterfaceRequirements = ...

`Optional`walletPluginIndex

walletPluginIndex?: number

walletPlugins

walletPlugins: UserInterfaceWalletPlugin[] = []

Accessors

esrOptions

get esrOptions(): SigningRequestEncodingOptions
Returns SigningRequestEncodingOptions
- Defined in packages/session/src/login.ts:119

Methods

addHook

addHook(t: LoginHookTypes, hook: LoginHook): void
Parameters
- t: LoginHookTypes
- hook: LoginHook
Returns void
- Defined in packages/session/src/login.ts:113

getClient

getClient(chain: ChainDefinition): APIClient
Parameters
- chain: ChainDefinition
Returns APIClient
- Defined in packages/session/src/login.ts:116