Class AccountResolver

Hierarchy

ApiBase
- AccountResolver

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AccountResolver(__namedParameters: { agent: Agent; options: AgentOptions }): AccountResolver

Inherited from ApiBase.constructor
- Defined in api/base.ts:25
Parameters
- __namedParameters: { agent: Agent; options: AgentOptions }
  - agent: Agent
  - options: AgentOptions
Returns AccountResolver

Properties

agent

agent: Agent

options

options: AgentOptions

Methods

activate

activate(code: string): Promise<boolean>

- Defined in api/account.ts:8
Parameters
- code: string
Returns Promise<boolean>

completeRecover

completeRecover(code: string, newPassword: string): Promise<ApiResponse<Record<string, never>>>

- Defined in api/account.ts:144
Parameters
- code: string
- newPassword: string
Returns Promise<ApiResponse<Record<string, never>>>

createAccount

createAccount(username: string, password: string, email: string): Promise<UserResponse>

- Defined in api/account.ts:37
Parameters
- username: string
  
  1-64 characters
- password: string
  
  8-1024 characters
- email: string
Returns Promise<UserResponse>

recover

recover(email: string): Promise<ApiResponse<Record<string, never>>>

- Defined in api/account.ts:122
Parameters
- email: string
Returns Promise<ApiResponse<Record<string, never>>>

resendActivation

resendActivation(email: string): Promise<ApiResponse<Record<string, never>>>

- Defined in api/account.ts:90
Parameters
- email: string
Returns Promise<ApiResponse<Record<string, never>>>

Static activate

activate(code: string): Promise<boolean>

- Defined in api/account.ts:20
Parameters
- code: string
Returns Promise<boolean>

Static completeRecover

completeRecover(code: string, newPassword: string): Promise<ApiResponse<Record<string, never>>>

- Defined in api/account.ts:159
Parameters
- code: string
- newPassword: string
Returns Promise<ApiResponse<Record<string, never>>>

Static createAccount

createAccount(username: string, password: string, email: string): Promise<UserResponse>

- Defined in api/account.ts:66
Parameters
- username: string
  
  1-64 characters
- password: string
  
  8-1024 characters
- email: string
Returns Promise<UserResponse>

Static recover

recover(email: string): Promise<ApiResponse<Record<string, never>>>

- Defined in api/account.ts:132
Parameters
- email: string
Returns Promise<ApiResponse<Record<string, never>>>

Static resendActivation

resendActivation(email: string): Promise<ApiResponse<Record<string, never>>>

- Defined in api/account.ts:106
Parameters
- email: string
Returns Promise<ApiResponse<Record<string, never>>>

Generated using TypeDoc