import {TokenClient} from '@token-io/core/src/main/TokenClient.js'

public class | source

TokenClient

Token SDK entry point.

Constructor Summary

Public Constructor
public	constructor(options: object)

Member Summary

Public Members
public	Crypto: Crypto
public	KeyLevel: Object
public	ManualCryptoEngine: Class<MemoryCryptoEngine>
public	MemoryCryptoEngine: Class<MemoryCryptoEngine>
public	Util: Util
public	options: Object

Private Members
private	_unauthenticatedClient: HttpClient

Method Summary

Public Methods
public	createMemberCore(alias: Alias, CryptoEngine: Class<KeyStoreCryptoEngine>, Member: Class<Member>, memberType: string, tokenRequestId: string, realmId: string): Promise<Object> Creates a Token member with an alias.
public	getBanks(options: object): Promise<object> Gets a list of countries with Token-enabled banks.
public	getCountries(options: object): Promise<object> Gets a list of available countries for linking.
public	getMemberCore(CryptoEngine: Class<KeyStoreCryptoEngine>, Member: Class<Member>, memberId: string): Object Returns 'logged-in' member that uses keys already in the CryptoEngine.
public	resolveAlias(alias: Alias): PromiseTokenMember> Resolve an alias to a member.

Public Constructors

public constructor(options: object) source

Params:

Name	Type	Attribute	Description
options	object	optional default: {}

Public Members

public Crypto: Crypto source

public KeyLevel: Object source

public ManualCryptoEngine: Class<MemoryCryptoEngine> source

public MemoryCryptoEngine: Class<MemoryCryptoEngine> source

public Util: Util source

public options: Object source

Private Members

private _unauthenticatedClient: HttpClient source

Public Methods

public createMemberCore(alias: Alias, CryptoEngine: Class<KeyStoreCryptoEngine>, Member: Class<Member>, memberType: string, tokenRequestId: string, realmId: string): Promise<Object> source

Creates a Token member with an alias.

Params:

Name	Type	Attribute	Description
alias	Alias	nullable: true	the member's alias
CryptoEngine	Class<KeyStoreCryptoEngine>		engine to use for key creation and storage
Member	Class<Member>		Member class for creation
memberType	string		type of member to create. "PERSONAL" if undefined
tokenRequestId	string		(optional) token request ID if the member is being claimed
realmId	string		(optional) member id of the Member to which this new member will belong

Return:

Promise<Object>

Promise of created Member

public getBanks(options: object): Promise<object> source

Gets a list of countries with Token-enabled banks.

Params:

Name	Type	Attribute	Description
options	object		optional parameters for getBanks

Return:

Promise<object>

list of banks

public getCountries(options: object): Promise<object> source

Gets a list of available countries for linking.

Params:

Name	Type	Attribute	Description
options	object		optional parameters for getBanksCountries

Return:

Promise<object>

list of countries with linkable banks

public getMemberCore(CryptoEngine: Class<KeyStoreCryptoEngine>, Member: Class<Member>, memberId: string): Object source

Returns 'logged-in' member that uses keys already in the CryptoEngine. If memberId is not provided, the last member to 'log in' will be used.

Params:

Name	Type	Attribute	Description
CryptoEngine	Class<KeyStoreCryptoEngine>		engine to use for key creation and storage
Member	Class<Member>		Member class for creation
memberId	string		optional ID of the member we want to log in

Return:

Object

instantiated member

public resolveAlias(alias: Alias): PromiseTokenMember> source

Resolve an alias to a member.

Params:

Name	Type	Attribute	Description
alias	Alias		alias to lookup

Return:

PromiseTokenMember>

TokenMember