@wharfkit/session - v4.0.1
    Preparing search index...

    Interface UserInterface

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

    interface UserInterface {
        addTranslations: (translations: LocaleDefinitions) => void;
        getMinimal?: () => boolean;
        getTranslate: (namespace?: string) => UserInterfaceTranslateFunction;
        onAccountCreate: (
            context: CreateAccountContext,
        ) => Promise<UserInterfaceAccountCreationResponse>;
        onAccountCreateComplete: () => Promise<void>;
        onBroadcast: () => Promise<void>;
        onBroadcastComplete: () => Promise<void>;
        onError: (error: Error) => Promise<void>;
        onLogin: () => Promise<void>;
        onLoginComplete: () => Promise<void>;
        onSessionKeyConflict?: (
            args: SessionKeyConflictArgs,
        ) => Promise<SessionKeyConflictResponse>;
        onSessionKeyConsent?: (args: SessionKeyConsentArgs) => Promise<boolean>;
        onSessionKeyMismatch?: (
            args: SessionKeyMismatchArgs,
        ) => Promise<SessionKeyMismatchResponse>;
        onSessionKeyRemove?: (args: SessionKeyRemoveArgs) => Promise<boolean>;
        onSign: () => Promise<void>;
        onSignComplete: () => Promise<void>;
        onTransact: () => Promise<void>;
        onTransactComplete: () => Promise<void>;
        prompt: (args: PromptArgs) => Cancelable<PromptResponse>;
        setMinimal?: (minimal: boolean) => void;
        status: (message: string) => void;
        translate: UserInterfaceTranslateFunction;
        login(context: LoginContext): Promise<UserInterfaceLoginResponse>;
    }

    Implemented by

    Index
    addTranslations getMinimal? getTranslate onAccountCreate onAccountCreateComplete onBroadcast onBroadcastComplete onError onLogin onLoginComplete onSessionKeyConflict? onSessionKeyConsent? onSessionKeyMismatch? onSessionKeyRemove? onSign onSignComplete onTransact onTransactComplete prompt setMinimal? status translate
    login
    addTranslations: (translations: LocaleDefinitions) => void

    Programmatically add new localization strings to the user interface

    getMinimal?: () => boolean

    Optional: Get current minimal mode state

    getTranslate: (namespace?: string) => UserInterfaceTranslateFunction

    Returns a translator for a specific namespace

    onAccountCreate: (
        context: CreateAccountContext,
    ) => Promise<UserInterfaceAccountCreationResponse>

    Inform the UI that an account creation process has started

    onAccountCreateComplete: () => Promise<void>

    Inform the UI that a account creation call has completed *

    onBroadcast: () => Promise<void>

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

    onBroadcastComplete: () => Promise<void>

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

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

    Inform the UI that an error has occurred

    onLogin: () => Promise<void>

    Inform the UI that a login call has started *

    onLoginComplete: () => Promise<void>

    Inform the UI that a login call has completed *

    onSessionKeyConflict?: (
        args: SessionKeyConflictArgs,
    ) => Promise<SessionKeyConflictResponse>

    Optional: Show session key conflict resolution UI

    onSessionKeyConsent?: (args: SessionKeyConsentArgs) => Promise<boolean>

    Optional: Show session key consent UI

    onSessionKeyMismatch?: (
        args: SessionKeyMismatchArgs,
    ) => Promise<SessionKeyMismatchResponse>

    Optional: Show session key whitelist mismatch UI

    onSessionKeyRemove?: (args: SessionKeyRemoveArgs) => Promise<boolean>

    Optional: Show session key removal confirmation UI

    onSign: () => Promise<void>

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

    onSignComplete: () => Promise<void>

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

    onTransact: () => Promise<void>

    Inform the UI that a transact call has started *

    onTransactComplete: () => Promise<void>

    Inform the UI that a transact call has completed *

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

    Prompt the user with a custom UI element *

    setMinimal?: (minimal: boolean) => void

    Optional: Enable/disable minimal mode temporarily for session key transactions

    status: (message: string) => void

    Update the displayed modal status from a TransactPlugin *

    translate: UserInterfaceTranslateFunction

    Translate a string using the UI's language *

    Settings
    Member Visibility

    On This Page
    Properties
    Methods