Interface AccountCreationPlugin

Interface which all 3rd party account creation plugins must implement.

interface AccountCreationPlugin {
    config: AccountCreationPluginConfig;
    translations?: LocaleDefinitions;
    get id(): string;
    get name(): string;
    create(options: CreateAccountContext): Promise<CreateAccountResponse>;
}

Implemented by

AbstractAccountCreationPlugin

Index

Properties

config translations?

Accessors

Methods

Properties

config

config: AccountCreationPluginConfig

The [[SessionKit]] configuration parameters for this [[WalletPlugin]].

`Optional`translations

translations?: LocaleDefinitions

Any translations this plugin requires

Accessors

id

get id(): string
A URL friendly (lower case, no spaces, etc) ID for this plugin - Used in serialization

Returns string
- Defined in packages/session/src/account-creation.ts:124

name

get name(): string
A display name for the account creation service that is presented to users.

Returns string
- Defined in packages/session/src/account-creation.ts:127

Methods

create

create(options: CreateAccountContext): Promise<CreateAccountResponse>
Request the [[AccountCreationPlugin]] to create a new account.
Parameters
- options: CreateAccountContext
Returns Promise<CreateAccountResponse>
- Defined in packages/session/src/account-creation.ts:139