Una clase de utilidad para analizar URL de acciones de correo electrónico, como restablecimiento de contraseña, verificación de correo electrónico, inicio de sesión de enlace de correo electrónico, etc.
El constructor de esta clase está marcado como interno. El código de terceros no debe llamar al constructor directamente ni crear subclases que amplíen la clase ActionCodeURL .
Firma:
export declare class ActionCodeURL
Propiedades
| Propiedad | modificadores | Escribe | Descripción |
|---|---|---|---|
| Clave API | cuerda | La clave API del enlace de acción de correo electrónico. | |
| código | cuerda | El código de acción del vínculo de acción del correo electrónico. | |
| URL continua | cadena | nulo | La URL de continuación del enlace de acción de correo electrónico. Nulo si no se proporciona. | |
| Código de lenguaje | cadena | nulo | El código de idioma del enlace de acción del correo electrónico. Nulo si no se proporciona. | |
| operación | cuerda | La acción realizada por el vínculo de acción de correo electrónico. Regresa de uno de los tipos de ActionCodeInfo | |
| inquilinoId | cadena | nulo | El ID de arrendatario del vínculo de acción de correo electrónico. Nulo si la acción de correo electrónico es del proyecto principal. |
Métodos
| Método | modificadores | Descripción |
|---|---|---|
| parseLink(enlace) | static | Analiza la cadena del enlace de la acción del correo electrónico y devuelve un ActionCodeURL si el enlace es válido; de lo contrario, devuelve un valor nulo. |
ActionCodeURL.apiKey
La clave API del enlace de acción de correo electrónico.
Firma:
readonly apiKey: string;
ActionCodeURL.código
El código de acción del vínculo de acción del correo electrónico.
Firma:
readonly code: string;
ActionCodeURL.continueUrl
La URL de continuación del enlace de acción de correo electrónico. Nulo si no se proporciona.
Firma:
readonly continueUrl: string | null;
ActionCodeURL.languageCode
El código de idioma del enlace de acción del correo electrónico. Nulo si no se proporciona.
Firma:
readonly languageCode: string | null;
ActionCodeURL.operación
La acción realizada por el vínculo de acción de correo electrónico. Regresa de uno de los tipos de ActionCodeInfo
Firma:
readonly operation: string;
ActionCodeURL.tenantId
El ID de arrendatario del vínculo de acción de correo electrónico. Nulo si la acción de correo electrónico es del proyecto principal.
Firma:
readonly tenantId: string | null;
ActionCodeURL.parseLink()
Analiza la cadena del enlace de la acción del correo electrónico y devuelve un ActionCodeURL si el enlace es válido; de lo contrario, devuelve un valor nulo.
Firma:
static parseLink(link: string): ActionCodeURL | null;
Parámetros
| Parámetro | Escribe | Descripción |
|---|---|---|
| Enlace | cuerda | La cadena de enlace de la acción de correo electrónico. |
Devoluciones:
URL del código de acción | nulo
El objeto ActionCodeURL , o nulo si el enlace no es válido.