Una classe di utilità per analizzare gli URL delle azioni e-mail come la reimpostazione della password, la verifica dell'e-mail, l'accesso tramite collegamento e-mail, ecc.
Il costruttore di questa classe è contrassegnato come interno. Il codice di terze parti non deve chiamare direttamente il costruttore o creare sottoclassi che estendono la classe ActionCodeURL .
Firma:
export declare class ActionCodeURL
Proprietà
| Proprietà | Modificatori | Tipo | Descrizione |
|---|---|---|---|
| apiKey | corda | La chiave API del collegamento all'azione e-mail. | |
| codice | corda | Il codice di azione del collegamento di azione e-mail. | |
| continuaUrl | stringa | nullo | L'URL di continuazione del collegamento all'azione e-mail. Null se non fornito. | |
| linguaCodice | stringa | nullo | Il codice della lingua del collegamento all'azione e-mail. Null se non fornito. | |
| operazione | corda | L'azione eseguita dal collegamento dell'azione e-mail. Restituisce da uno dei tipi di ActionCodeInfo | |
| inquilinoId | stringa | nullo | L'ID tenant del collegamento dell'azione e-mail. Null se l'azione di posta elettronica proviene dal progetto principale. |
Metodi
| Metodo | Modificatori | Descrizione |
|---|---|---|
| analizzareLink(collegamento) | static | Analizza la stringa del collegamento dell'azione e-mail e restituisce un ActionCodeURL se il collegamento è valido, altrimenti restituisce null. |
ActionCodeURL.apiKey
La chiave API del collegamento all'azione e-mail.
Firma:
readonly apiKey: string;
ActionCodeURL.codice
Il codice di azione del collegamento di azione e-mail.
Firma:
readonly code: string;
ActionCodeURL.continueUrl
L'URL di continuazione del collegamento all'azione e-mail. Null se non fornito.
Firma:
readonly continueUrl: string | null;
ActionCodeURL.codicelingua
Il codice della lingua del collegamento all'azione e-mail. Null se non fornito.
Firma:
readonly languageCode: string | null;
ActionCodeURL.operazione
L'azione eseguita dal collegamento dell'azione e-mail. Restituisce da uno dei tipi di ActionCodeInfo
Firma:
readonly operation: string;
ActionCodeURL.tenantId
L'ID tenant del collegamento dell'azione e-mail. Null se l'azione di posta elettronica proviene dal progetto principale.
Firma:
readonly tenantId: string | null;
ActionCodeURL.parseLink()
Analizza la stringa del collegamento dell'azione e-mail e restituisce un ActionCodeURL se il collegamento è valido, altrimenti restituisce null.
Firma:
static parseLink(link: string): ActionCodeURL | null;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| collegamento | corda | La stringa di collegamento dell'azione e-mail. |
Ritorna:
URLCodiceAzione | nullo
L'oggetto ActionCodeURL oppure null se il collegamento non è valido.