Interface UserInterface

Interface which all 3rd party user interface plugins must implement.

Hierarchy

  • UserInterface

Implemented by

Properties

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

Methods

login

Properties

addTranslations

addTranslations: ((translations: LocaleDefinitions) => void)

Type declaration

getTranslate

getTranslate: ((namespace?: string) => UserInterfaceTranslateFunction)

Type declaration

onBroadcast

onBroadcast: (() => Promise<void>)

Type declaration

    • (): Promise<void>

    • Inform the UI that a transact call has started broadcasting the transaction *

      Returns Promise<void>

onBroadcastComplete

onBroadcastComplete: (() => Promise<void>)

Type declaration

    • (): Promise<void>

    • Inform the UI that a transact call has completed broadcasting the transaction *

      Returns Promise<void>

onError

onError: ((error: Error) => Promise<void>)

Type declaration

    • (error: Error): Promise<void>

    • Inform the UI that an error has occurred

      Parameters

      • error: Error

      Returns Promise<void>

onLogin

onLogin: (() => Promise<void>)

Type declaration

    • (): Promise<void>

    • Inform the UI that a login call has started *

      Returns Promise<void>

onLoginComplete

onLoginComplete: (() => Promise<void>)

Type declaration

    • (): Promise<void>

    • Inform the UI that a login call has completed *

      Returns Promise<void>

onSign

onSign: (() => Promise<void>)

Type declaration

    • (): Promise<void>

    • Inform the UI that a transact call has started signing the transaction *

      Returns Promise<void>

onSignComplete

onSignComplete: (() => Promise<void>)

Type declaration

    • (): Promise<void>

    • Inform the UI that a transact call has completed signing the transaction *

      Returns Promise<void>

onTransact

onTransact: (() => Promise<void>)

Type declaration

    • (): Promise<void>

    • Inform the UI that a transact call has started *

      Returns Promise<void>

onTransactComplete

onTransactComplete: (() => Promise<void>)

Type declaration

    • (): Promise<void>

    • Inform the UI that a transact call has completed *

      Returns Promise<void>

prompt

prompt: ((args: PromptArgs) => Cancelable<PromptResponse>)

Type declaration

status

status: ((message: string) => void)

Type declaration

    • (message: string): void

    • Update the displayed modal status from a TransactPlugin *

      Parameters

      • message: string

      Returns void

translate

translate: UserInterfaceTranslateFunction

Translate a string using the UI's language *

Methods

login

Settings

Member Visibility

Theme