Class AbstractUserInterface`Abstract`

Abstract class which all 3rd party [[UserInterface]] implementations may extend.

Implements

UserInterface

Constructors

constructor

new AbstractUserInterface(): AbstractUserInterface

Returns AbstractUserInterface

Methods

addTranslations

addTranslations(translations: LocaleDefinitions): void
Programmatically add new localization strings to the user interface
Parameters
- translations: LocaleDefinitions
Returns void
Implementation of UserInterface.addTranslations
- Defined in packages/session/src/ui.ts:212

getTranslate

getTranslate(namespace?: string): UserInterfaceTranslateFunction
Returns a translator for a specific namespace
Parameters
- Optionalnamespace: string
Returns UserInterfaceTranslateFunction
Implementation of UserInterface.getTranslate
- Defined in packages/session/src/ui.ts:209

`Abstract`login

login(context: LoginContext): Promise<UserInterfaceLoginResponse>
Interact with the user to collect the data needed for a [[UserInterfaceLoginResponse]].
Parameters
- context: LoginContext
Returns Promise<UserInterfaceLoginResponse>
Implementation of UserInterface.login
- Defined in packages/session/src/ui.ts:183

`Abstract`onAccountCreate

onAccountCreate(
context: CreateAccountContext,
): Promise<UserInterfaceAccountCreationResponse>
Inform the UI that an account creation process has started
Parameters
- context: CreateAccountContext
Returns Promise<UserInterfaceAccountCreationResponse>
Implementation of UserInterface.onAccountCreate
- Defined in packages/session/src/ui.ts:185

`Abstract`onAccountCreateComplete

onAccountCreateComplete(): Promise<void>
Inform the UI that a account creation call has completed *

Returns Promise<void>
Implementation of UserInterface.onAccountCreateComplete
- Defined in packages/session/src/ui.ts:188

`Abstract`onBroadcast

onBroadcast(): Promise<void>
Inform the UI that a transact call has started broadcasting the transaction *

Returns Promise<void>
Implementation of UserInterface.onBroadcast
- Defined in packages/session/src/ui.ts:195

`Abstract`onBroadcastComplete

onBroadcastComplete(): Promise<void>
Inform the UI that a transact call has completed broadcasting the transaction *

Returns Promise<void>
Implementation of UserInterface.onBroadcastComplete
- Defined in packages/session/src/ui.ts:196

`Abstract`onError

onError(error: Error): Promise<void>
Inform the UI that an error has occurred
Parameters
- error: Error
Returns Promise<void>
Implementation of UserInterface.onError
- Defined in packages/session/src/ui.ts:184

`Abstract`onLogin

onLogin(options?: LoginOptions): Promise<void>
Inform the UI that a login call has started *
Parameters
- Optionaloptions: LoginOptions
Returns Promise<void>
Implementation of UserInterface.onLogin
- Defined in packages/session/src/ui.ts:189

`Abstract`onLoginComplete

onLoginComplete(): Promise<void>
Inform the UI that a login call has completed *

Returns Promise<void>
Implementation of UserInterface.onLoginComplete
- Defined in packages/session/src/ui.ts:190

`Abstract`onSign

onSign(): Promise<void>
Inform the UI that a transact call has started signing the transaction *

Returns Promise<void>
Implementation of UserInterface.onSign
- Defined in packages/session/src/ui.ts:193

`Abstract`onSignComplete

onSignComplete(): Promise<void>
Inform the UI that a transact call has completed signing the transaction *

Returns Promise<void>
Implementation of UserInterface.onSignComplete
- Defined in packages/session/src/ui.ts:194

`Abstract`onTransact

onTransact(): Promise<void>
Inform the UI that a transact call has started *

Returns Promise<void>
Implementation of UserInterface.onTransact
- Defined in packages/session/src/ui.ts:191

`Abstract`onTransactComplete

onTransactComplete(): Promise<void>
Inform the UI that a transact call has completed *

Returns Promise<void>
Implementation of UserInterface.onTransactComplete
- Defined in packages/session/src/ui.ts:192

`Abstract`prompt

prompt(args: PromptArgs): Cancelable<PromptResponse>
Prompt the user with a custom UI element *
Parameters
- args: PromptArgs
Returns Cancelable<PromptResponse>
Implementation of UserInterface.prompt
- Defined in packages/session/src/ui.ts:197

`Abstract`status

status(message: string): void
Update the displayed modal status from a TransactPlugin *
Parameters
- message: string
Returns void
Implementation of UserInterface.status
- Defined in packages/session/src/ui.ts:198

translate

translate(
    key: string,
    options?: UserInterfaceTranslateOptions,
    namespace?: string,
): string
Translate a string using the UI's language *
Parameters
- key: string
- Optionaloptions: UserInterfaceTranslateOptions
- Optionalnamespace: string
Returns string
Implementation of UserInterface.translate
- Defined in packages/session/src/ui.ts:199