MfaVoiceChallengeMembers

Interface définissant tous les membres et opérations disponibles sur l’écran de défi vocal MFA.

Example

export interface MfaVoiceChallengeMembers extends BaseMembers {
  /**
   * Propriété et donnée propre à l'écran.
   */
  screen: ScreenMembersOnMfaVoiceChallenge;

  untrustedData: UntrustedDataMembersOnMfaVoiceChallenge;

  /**
   * Soumet le code de vérification vocale pour valider le défi AMF.
   *
   * @param payload - Objet contenant le code de vérification et les paramètres facultatifs
   * @returns Promise qui se résout une fois le code validé avec succès
   *
   * @example
   * ```typescript
   * const mfaVoiceChallenge = new MfaVoiceChallenge();
   * mfaVoiceChallenge.continue({
   *   code: '123456',
   *   rememberDevice: true
   * });
   * ```
   */
  continue(payload: MfaVoiceChallengeContinueOptions): Promise<void>;

  /**
   * Navigue vers l'écran de sélection d'un autre numéro de téléphone.
   *
   * @param payload - Paramètres personnalisés facultatifs
   * @returns Promise qui se résout une fois la navigation terminée
   *
   * @example
   * ```typescript
   * const mfaVoiceChallenge = new MfaVoiceChallenge();
   * mfaVoiceChallenge.pickPhone();
   * ```
   */
  pickPhone(payload?: CustomOptions): Promise<void>;

  /**
   * Passe à la vérification par SMS plutôt que par appel vocal.
   *
   * @param payload - Paramètres personnalisés facultatifs
   * @returns Promise qui se résout une fois le basculement terminé
   *
   * @example
   * ```typescript
   * const mfaVoiceChallenge = new MfaVoiceChallenge();
   * mfaVoiceChallenge.switchToSms();
   * ```
   */
  switchToSms(payload?: CustomOptions): Promise<void>;

  /**
   * Demande un nouvel appel vocal avec un code de vérification.
   *
   * @param payload - Paramètres personnalisés facultatifs
   * @returns Promise qui se résout une fois le nouveau code envoyé
   *
   * @example
   * ```typescript
   * const mfaVoiceChallenge = new MfaVoiceChallenge();
   * mfaVoiceChallenge.resendCode();
   * ```
   */
  resendCode(payload?: CustomOptions): Promise<void>;

  /**
   * Navigue vers l'écran de sélection d'une autre méthode AMF.
   *
   * @param payload - Paramètres personnalisés facultatifs
   * @returns Promise qui se résout une fois la navigation terminée
   *
   * @example
   * ```typescript
   * const mfaVoiceChallenge = new MfaVoiceChallenge();
   * mfaVoiceChallenge.tryAnotherMethod();
   * ```
   */
  tryAnotherMethod(payload?: CustomOptions): Promise<void>;

  /**
   * Fonctionnalité de renvoi avec gestion du délai d’attente pour cet écran
   * @param options Option de configuration pour la fonctionnalité de renvoi
   */
  resendManager(options?: StartResendOptions): ResendControl;
}

Propriétés

branding · BrandingMembers

client · ClientMembers

organization · OrganizationMembers

prompt · PromptMembers

screen · ScreenMembersOnMfaVoiceChallenge

Propriété et donnée propre à l’écran.

tenant · TenantMembers

transaction · TransactionMembers

untrustedData · UntrustedDataMembersOnMfaVoiceChallenge

user · UserMembers

Méthodes

continue · Promise<void>

Soumet le code de vérification vocal pour valider le défi AMF.

Promise qui se résout une fois le code validé avec succès

Example

const mfaVoiceChallenge = new MfaVoiceChallenge();
mfaVoiceChallenge.continue({
  code: '123456',
  rememberDevice: true
});

Show Paramètres

payload · MfaVoiceChallengeContinueOptions

Objet contenant le code de vérification et des paramètres facultatifs

Propriétés

code · string

Le code de vérification reçu par appel vocal.

rememberDevice? · boolean

Indicateur facultatif pour mémoriser l’appareil pendant 30 jours et éviter les futurs défis AMF.

pickPhone · Promise<void>

Navigue vers l’écran permettant de sélectionner un autre numéro de téléphone.

Promise qui se résout lorsque la navigation est terminée

Example

const mfaVoiceChallenge = new MfaVoiceChallenge();
mfaVoiceChallenge.pickPhone();

Show Paramètres

payload? · CustomOptions

Paramètres personnalisés facultatifs

resendCode · Promise<void>

Demande un nouvel appel vocal avec un code de vérification.

Promise qui se résout lorsque le nouveau code est envoyé

Example

const mfaVoiceChallenge = new MfaVoiceChallenge();
mfaVoiceChallenge.resendCode();

Show Paramètres

payload? · CustomOptions

Paramètres personnalisés facultatifs

resendManager · ResendControl

Fonctionnalité de renvoi avec gestion du délai d’attente pour cet écran

Show Paramètres

options? · StartResendOptions

Options de configuration de la fonctionnalité de renvoi

Propriétés

onStatusChange? · OnStatusChangeCallback

onTimeout · void

timeoutSeconds? · number

switchToSms · Promise<void>

Passe à la vérification par SMS plutôt qu’à l’appel vocal.

Promise qui se résout lorsque le changement est terminé

Example

const mfaVoiceChallenge = new MfaVoiceChallenge();
mfaVoiceChallenge.switchToSms();

Show Paramètres

payload? · CustomOptions

Paramètres personnalisés facultatifs

tryAnotherMethod · Promise<void>

Navigue vers l’écran permettant de sélectionner une autre méthode d’AMF.

Promise qui se résout lorsque la navigation est terminée

Example

const mfaVoiceChallenge = new MfaVoiceChallenge();
mfaVoiceChallenge.tryAnotherMethod();

Show Paramètres

payload? · CustomOptions

Paramètres personnalisés facultatifs