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 com link de e-mail etc.
O construtor dessa classe está marcado como interno. O código de terceiros não pode chamar o construtor diretamente nem criar subclasses que estendam a classe ActionCodeURL
.
Assinatura:
export declare class ActionCodeURL
Propriedades
Propriedade | Modificadores | Tipo | Descrição |
---|---|---|---|
apiKey. | string | A chave de API do link de ação de e-mail. | |
código | string | O código de ação do link de ação de e-mail. | |
continueUrl | string | nulo | O URL de confirmação do link de ação de e-mail. Nulo se não for informado. | |
languageCode | string | nulo | O código de idioma do link de ação de e-mail. Nulo se não for informado. | |
operação | string | A ação realizada pelo link de ação de e-mail. Ela retorna de um dos tipos de ActionCodeInfo | |
tenantId (em inglês) | string | nulo | O ID de locatário do link de ação de e-mail. Nulo se a ação de e-mail for do projeto pai. |
Métodos
Método | Modificadores | Descrição |
---|---|---|
parseLink(link) (em inglês) | static |
Analisa a string do link de ação de e-mail e retorna um ActionCodeURL se o link for válido. Caso contrário, retorna nulo. |
ActionCodeURL.apiKey
A chave de API do link de ação de e-mail.
Assinatura:
readonly apiKey: string;
ActionCodeURL.code
O código de ação do link de ação de e-mail.
Assinatura:
readonly code: string;
ActionCodeURL.continueUrl
O URL de confirmação do link de ação de e-mail. Nulo se não for informado.
Assinatura:
readonly continueUrl: string | null;
ActionCodeURL.languageCode
O código de idioma do link de ação de e-mail. Nulo se não for informado.
Assinatura:
readonly languageCode: string | null;
ActionCodeURL.operation
A ação realizada pelo link de ação de e-mail. Ela retorna de um dos tipos de ActionCodeInfo
Assinatura:
readonly operation: string;
ActionCodeURL.tenantId
O ID de locatário do link de ação de e-mail. Nulo se a ação de e-mail for do projeto pai.
Assinatura:
readonly tenantId: string | null;
ActionCodeURL.parseLink()
Analisa a string do link de ação de e-mail e retorna um ActionCodeURL se o link for válido. Caso contrário, retorna nulo.
Assinatura:
static parseLink(link: string): ActionCodeURL | null;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
link | string | A string do link de ação de e-mail. |
Retorna:
ActionCodeURL | nulo
O objeto ActionCodeURL ou nulo, se o link for inválido.