Uma classe de utilitário para analisar URLs de ação de e-mail, como redefinição de senha, verificação de e-mail, login de link de e-mail etc.
O construtor para esta classe é marcado como interno. O código de terceiros não deve chamar o construtor diretamente ou criar subclasses que estendam a classe ActionCodeURL
.
Assinatura:
export declare class ActionCodeURL
Propriedades
Propriedade | Modificadores | Modelo | Descrição |
---|---|---|---|
Chave API | corda | A chave de API do link de ação de email. | |
código | corda | O código de ação do link de ação de email. | |
continueUrl | seqüência | nulo | A URL de continuação do link de ação de e-mail. Nulo se não fornecido. | |
languageCode | seqüência | nulo | O código de idioma do link de ação de e-mail. Nulo se não fornecido. | |
Operação | corda | A ação executada pelo link de ação de email. Ele retorna de um dos tipos de ActionCodeInfo | |
ID do locatário | seqüência | nulo | A ID do locatário do link de ação de email. Nulo se a ação de email for do projeto pai. |
Métodos
Método | Modificadores | Descrição |
---|---|---|
parseLink(link) | static | Analisa a string do link de ação de email e retorna um ActionCodeURL se o link for válido, caso contrário, retornará nulo. |
ActionCodeURL.apiKey
A chave de API do link de ação de email.
Assinatura:
readonly apiKey: string;
ActionCodeURL.code
O código de ação do link de ação de email.
Assinatura:
readonly code: string;
ActionCodeURL.continueUrl
A URL de continuação do link de ação de e-mail. Nulo se não fornecido.
Assinatura:
readonly continueUrl: string | null;
ActionCodeURL.languageCode
O código de idioma do link de ação de e-mail. Nulo se não fornecido.
Assinatura:
readonly languageCode: string | null;
ActionCodeURL.operation
A ação executada pelo link de ação de email. Ele retorna de um dos tipos de ActionCodeInfo
Assinatura:
readonly operation: string;
ActionCodeURL.tenantId
A ID do locatário do link de ação de email. Nulo se a ação de email for do projeto pai.
Assinatura:
readonly tenantId: string | null;
ActionCodeURL.parseLink()
Analisa a string do link de ação de email e retorna um ActionCodeURL se o link for válido, caso contrário, retornará nulo.
Assinatura:
static parseLink(link: string): ActionCodeURL | null;
Parâmetros
Parâmetro | Modelo | Descrição |
---|---|---|
link | corda | A string do link de ação de e-mail. |
Devoluções:
ActionCodeURL | nulo
O objeto ActionCodeURL ou null se o link for inválido.