Interface ResetPasswordMfaPhoneChallengeMembers

ResetPasswordMfaPhoneChallengeMembers

interface ResetPasswordMfaPhoneChallengeMembers {
    branding: BrandingMembers;
    client: ClientMembers;
    organization: OrganizationMembers;
    prompt: PromptMembers;
    screen: ScreenMembersOnResetPasswordMfaPhoneChallenge;
    tenant: TenantMembers;
    transaction: TransactionMembers;
    untrustedData: UntrustedDataMembers;
    user: UserMembers;
    continue(payload: ResetPasswordMfaPhoneChallengeContinueOptions): Promise<void>;
    tryAnotherMethod(payload: ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions): Promise<void>;
}

Hierarchy

BaseMembers
- ResetPasswordMfaPhoneChallengeMembers

Implemented by

ResetPasswordMfaPhoneChallenge

Index

Properties

branding client organization prompt screen tenant transaction untrustedData user

Methods

continue tryAnotherMethod

Properties

branding

branding: BrandingMembers

client

client: ClientMembers

Access to client-specific information (e.g., client ID, name).

organization

organization: OrganizationMembers

Access to organization-specific information, if applicable.

prompt

prompt: PromptMembers

Access to prompt details (e.g., prompt name).

screen

screen: ScreenMembersOnResetPasswordMfaPhoneChallenge

Access to the specific properties and data of the 'reset-password-mfa-phone-challenge' screen.

tenant

tenant: TenantMembers

transaction

transaction: TransactionMembers

Access to the current transaction details (e.g., state, errors).

untrustedData

untrustedData: UntrustedDataMembers

user

user: UserMembers

Methods

continue

continue(payload): Promise<void>
Sends the verification code to the user's phone via the specified method (SMS or Voice). This action corresponds to the user clicking the "Send Code via SMS" or "Send Code via Voice Call" button. It triggers the Auth0 backend to initiate the code delivery process.
Parameters
- payload: ResetPasswordMfaPhoneChallengeContinueOptions
  The options specifying the delivery type ('sms' or 'voice') and any custom data.
Returns Promise<void>
A promise that resolves when the action is successfully submitted to the server.
Throws
Throws an error if the submission fails (e.g., network issue, invalid state).
Example
```
import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge';

const screen = new ResetPasswordMfaPhoneChallenge();

// Send code via SMS
await screen.continue({ type: 'sms' });

// Send code via Voice Call
await screen.continue({ type: 'voice' });
```
- Defined in interfaces/screens/reset-password-mfa-phone-challenge.ts:119

tryAnotherMethod

tryAnotherMethod(payload): Promise<void>
Navigates the user to the screen where they can select an alternative MFA method. This action corresponds to the user clicking a "Try Another Method" button.
Parameters
- payload: ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions
  The options specifying the current challenge type (sms or voice) and any custom data. The type field is necessary to inform the backend which flow the user is navigating away from.
Returns Promise<void>
A promise that resolves when the action is successfully submitted to the server.
Throws
Throws an error if the submission fails.
Example
```
import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge';

const screen = new ResetPasswordMfaPhoneChallenge();

// If the user was presented with SMS option initially:
await screen.tryAnotherMethod({ type: 'sms' });

// If the user was presented with Voice option initially:
await screen.tryAnotherMethod({ type: 'voice' });
```
- Defined in interfaces/screens/reset-password-mfa-phone-challenge.ts:141