ActionCodeURL class

Une classe utilitaire pour analyser les URL d'action par courrier électronique telles que la réinitialisation du mot de passe, la vérification du courrier électronique, la connexion par lien par courrier électronique, etc.

Le constructeur de cette classe est marqué comme interne. Le code tiers ne doit pas appeler directement le constructeur ni créer de sous-classes qui étendent la classe ActionCodeURL .

Signature:

export declare class ActionCodeURL 

Propriétés

Propriété Modificateurs Taper Description
clé API chaîne La clé API du lien d'action par e-mail.
code chaîne Le code d'action du lien d'action par e-mail.
continuerUrl chaîne | nul L'URL de suite du lien d'action par e-mail. Nul s’il n’est pas fourni.
langueCode chaîne | nul Le code de langue du lien d'action par e-mail. Nul s’il n’est pas fourni.
opération chaîne L'action effectuée par le lien d'action par e-mail. Il renvoie de l'un des types d' ActionCodeInfo
ID locataire chaîne | nul L’ID de locataire du lien d’action par e-mail. Nul si l’action email provient du projet parent.

Méthodes

Méthode Modificateurs Description
analyserLien(lien) static Analyse la chaîne du lien d'action de courrier électronique et renvoie un ActionCodeURL si le lien est valide, sinon renvoie null.

ActionCodeURL.apiKey

La clé API du lien d'action par e-mail.

Signature:

readonly apiKey: string;

ActionCodeURL.code

Le code d'action du lien d'action par e-mail.

Signature:

readonly code: string;

ActionCodeURL.continueUrl

L'URL de suite du lien d'action par e-mail. Nul s’il n’est pas fourni.

Signature:

readonly continueUrl: string | null;

ActionCodeURL.langueCode

Le code de langue du lien d'action par e-mail. Nul s’il n’est pas fourni.

Signature:

readonly languageCode: string | null;

ActionCodeURL.opération

L'action effectuée par le lien d'action par e-mail. Il renvoie de l'un des types d' ActionCodeInfo

Signature:

readonly operation: string;

ActionCodeURL.tenantId

L’ID de locataire du lien d’action par e-mail. Nul si l’action email provient du projet parent.

Signature:

readonly tenantId: string | null;

Analyse la chaîne du lien d'action de courrier électronique et renvoie un ActionCodeURL si le lien est valide, sinon renvoie null.

Signature:

static parseLink(link: string): ActionCodeURL | null;

Paramètres

Paramètre Taper Description
lien chaîne La chaîne du lien d’action par e-mail.

Retour:

ActionCodeURL | nul

L'objet ActionCodeURL , ou null si le lien n'est pas valide.