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.

Hierarchy

LoginContext

Index

Constructors

Properties

appName? chain? chains fetch hooks permissionLevel? ui uiRequirements walletPlugins

Accessors

Methods

addHook getClient

Constructors

constructor

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

Properties

`Optional` appName

appName?: string

`Optional` chain

chain?: ChainDefinition

chains

chains: ChainDefinition[] = []

fetch

fetch: Fetch

hooks

hooks: LoginHooks = ...

`Optional` permissionLevel

permissionLevel?: PermissionLevel

ui

ui: UserInterface

uiRequirements

uiRequirements: UserInterfaceRequirements = ...

walletPlugins

walletPlugins: UserInterfaceWalletPlugin[] = []

Accessors

esrOptions

get esrOptions(): SigningRequestEncodingOptions
Returns SigningRequestEncodingOptions
- Defined in src/login.ts:96

Methods

addHook

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

getClient

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