TransportInterface

@accounts/clientGlobalsTransportInterface

Hierarchy

  • TransportInterface

Index

Properties

Methods

Properties

client

client: AccountsClient

Defined in transport-interface.ts:12

Methods

addEmail

addEmail(newEmail: string): Promise‹void›

Defined in transport-interface.ts:33

Parameters:

NameType
newEmailstring

Returns: Promise‹void›


authenticateWithService

authenticateWithService(service: string, authenticateParams: object): Promise‹boolean›

Defined in transport-interface.ts:14

Parameters:

NameType
servicestring
authenticateParamsobject

Returns: Promise‹boolean›


changePassword

changePassword(oldPassword: string, newPassword: string): Promise‹void›

Defined in transport-interface.ts:34

Parameters:

NameType
oldPasswordstring
newPasswordstring

Returns: Promise‹void›


createUser

createUser(user: CreateUser): Promise‹CreateUserResult›

Defined in transport-interface.ts:13

Parameters:

NameType
userCreateUser

Returns: Promise‹CreateUserResult›


getUser

getUser(): Promise‹User›

Defined in transport-interface.ts:27

Returns: Promise‹User›


impersonate

impersonate(token: string, impersonated: ImpersonationUserIdentity): Promise‹ImpersonationResult›

Defined in transport-interface.ts:35

Parameters:

NameType
tokenstring
impersonatedImpersonationUserIdentity

Returns: Promise‹ImpersonationResult›


loginWithService

loginWithService(service: string, authenticateParams: object): Promise‹LoginResult›

Defined in transport-interface.ts:20

Parameters:

NameType
servicestring
authenticateParamsobject

Returns: Promise‹LoginResult›


logout

logout(): Promise‹void›

Defined in transport-interface.ts:26

Returns: Promise‹void›


refreshTokens

refreshTokens(accessToken: string, refreshToken: string): Promise‹LoginResult›

Defined in transport-interface.ts:28

Parameters:

NameType
accessTokenstring
refreshTokenstring

Returns: Promise‹LoginResult›


resetPassword

resetPassword(token: string, newPassword: string): Promise‹LoginResult | null›

Defined in transport-interface.ts:32

Parameters:

NameType
tokenstring
newPasswordstring

Returns: Promise‹LoginResult | null›


sendResetPasswordEmail

sendResetPasswordEmail(email: string): Promise‹void›

Defined in transport-interface.ts:30

Parameters:

NameType
emailstring

Returns: Promise‹void›


sendVerificationEmail

sendVerificationEmail(email: string): Promise‹void›

Defined in transport-interface.ts:31

Parameters:

NameType
emailstring

Returns: Promise‹void›


verifyEmail

verifyEmail(token: string): Promise‹void›

Defined in transport-interface.ts:29

Parameters:

NameType
tokenstring

Returns: Promise‹void›