Class ResetPasswordRequest

Hierarchy

BaseContext
- ResetPasswordRequest

Implements

Classes.ResetPasswordRequestMembers

Index

Constructors

Properties

branding client organization prompt screen tenant transaction untrustedData user screenIdentifier

Methods

backToLogin getError resetPassword

Constructors

constructor

new ResetPasswordRequest(): ResetPasswordRequest
Returns ResetPasswordRequest
Overrides BaseContext.constructor
- Defined in src/screens/reset-password-request/index.ts:24

Properties

branding

branding: Classes.BrandingMembers

client

client: Classes.ClientMembers

organization

organization: Classes.OrganizationMembers

prompt

prompt: Classes.PromptMembers

screen

screen: Classes.ScreenMembersOnResetPasswordRequest

tenant

tenant: Classes.TenantMembers

transaction

transaction: Classes.TransactionMembersOnResetPasswordRequest

untrustedData

untrustedData: Classes.UntrustedDataMembers

user

user: Classes.UserMembers

`Static`screenIdentifier

screenIdentifier: string = ScreenIds.RESET_PASSWORD_REQUEST

Methods

backToLogin

backToLogin(payload?: Classes.CustomOptions): Promise<void>
Parameters
- Optionalpayload: Classes.CustomOptions
Returns Promise<void>
Example
```
import ResetPasswordRequest from '@auth0/auth0-acul-js/reset-password-request';

const resetPasswordRequest = new ResetPasswordRequest();
resetPasswordRequest.backToLogin();
```
Implementation of ResetPasswordRequestMembers.backToLogin
- Defined in src/screens/reset-password-request/index.ts:55

getError

getError(): Classes.Error[]
Retrieves the array of transaction errors from the context, or an empty array if none exist.

Returns Classes.Error[]
An array of error objects from the transaction context.
Inherited from BaseContext.getError
- Defined in src/models/base-context.ts:99

resetPassword

resetPassword(payload: Classes.ResetPasswordRequestOptions): Promise<void>
Parameters
- payload: Classes.ResetPasswordRequestOptions
Returns Promise<void>
Example
```
import ResetPasswordRequest from '@auth0/auth0-acul-js/reset-password-request';

const resetPasswordRequest = new ResetPasswordRequest();
resetPasswordRequest.resetPassword({ username: 'testuser' });
```
Implementation of ResetPasswordRequestMembers.resetPassword
- Defined in src/screens/reset-password-request/index.ts:39