Class AbstractUserInterface`Abstract`

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

Hierarchy

AbstractUserInterface

Implements

UserInterface

Index

Constructors

Methods

addTranslations getTranslate login onBroadcast onBroadcastComplete onError onLogin onLoginComplete onSign onSignComplete onTransact onTransactComplete prompt status translate

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 src/ui.ts:121

getTranslate

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

`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 src/ui.ts:96

`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 src/ui.ts:104

`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 src/ui.ts:105

`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 src/ui.ts:97

`Abstract` onLogin

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

`Abstract` onLoginComplete

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

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

`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 src/ui.ts:102

`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 src/ui.ts:103

`Abstract` onTransact

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

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

`Abstract` onTransactComplete

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

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

`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 src/ui.ts:106

`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 src/ui.ts:107

translate

translate(key: string, options?: UserInterfaceTranslateOptions, namespace?: string): string
Parameters
- key: string
- Optional options: UserInterfaceTranslateOptions
- Optional namespace: string
Returns string
Implementation of UserInterface.translate
- Defined in src/ui.ts:108