Class PhoneIdentifierChallenge

constructor

• new PhoneIdentifierChallenge(): PhoneIdentifierChallenge

  Returns PhoneIdentifierChallenge

screen

StaticscreenIdentifier

resendCode

• resendCode(payload?: Screens.CustomOptions): Promise<void>

  Parameters

  • Optionalpayload: Screens.CustomOptions

  Returns Promise<void>

  Example

  import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
  
  const phoneIdentifierChallenge = new PhoneIdentifierChallenge();
  phoneIdentifierChallenge.resendCode();
  Copy

resendManager

• resendManager(options?: Screens.StartResendOptions): Screens.ResendControl
  Utility Feature

  Gets resend functionality with timeout management for this screen

  Parameters

  • Optionaloptions: Screens.StartResendOptions

    Configuration options for resend functionality

    Options for configuring resend functionality

    • OptionalonStatusChange?: Screens.OnStatusChangeCallback

    • OptionalonTimeout?: () => void

    • OptionaltimeoutSeconds?: number

  Returns Screens.ResendControl

  ResendControl object with startResend method

  Example

  import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
    const handleStatusChange = (remainingSeconds, isDisabled) => {
      setDisabled(isDisabled);
      setRemaining(remainingSeconds);
    };
  
    const handleTimeout = () => {
      console.log('Timeout completed, resend is now available');
    };
  
    const { startResend } = phoneChallenge.resendManager({
      timeoutSeconds: 30,
      onStatusChange: handleStatusChange,
      onTimeout: handleTimeout
    });
    
    // Call startResend when user clicks resend button
    await startResend();
  Copy

returnToPrevious

• returnToPrevious(payload?: Screens.CustomOptions): Promise<void>

  Parameters

  • Optionalpayload: Screens.CustomOptions

  Returns Promise<void>

  Example

  import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
  
  const phoneIdentifierChallenge = new PhoneIdentifierChallenge();
  phoneIdentifierChallenge.returnToPrevious();
  Copy

submitPhoneChallenge

• submitPhoneChallenge(payload: Screens.PhoneChallengeOptions): Promise<void>

  Parameters

  • payload: Screens.PhoneChallengeOptions

  Returns Promise<void>

  Example

  import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
  
  const phoneIdentifierChallenge = new PhoneIdentifierChallenge();
  phoneIdentifierChallenge.submitPhoneChallenge({
      code: "<string>"
  });
  Copy

switchToText

• switchToText(payload?: Screens.CustomOptions): Promise<void>

  Parameters

  • Optionalpayload: Screens.CustomOptions

  Returns Promise<void>

  Example

  import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
  
  const phoneIdentifierChallenge = new PhoneIdentifierChallenge();
  phoneIdentifierChallenge.switchToText();
  Copy

switchToVoice

• switchToVoice(payload?: Screens.CustomOptions): Promise<void>

  Parameters

  • Optionalpayload: Screens.CustomOptions

  Returns Promise<void>

  Example

  import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
  
  const phoneIdentifierChallenge = new PhoneIdentifierChallenge();
  phoneIdentifierChallenge.switchToVoice();
  Copy