ActionCodeURL class

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 desta classe está 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 Tipo 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.
continuarUrl corda | nulo O URL de continuação do link de ação de e-mail. Nulo se não for fornecido.
código de idioma corda | nulo O código do idioma do link de ação de email. Nulo se não for fornecido.
Operação corda A ação executada pelo link de ação de email. Ele retorna de um dos tipos de ActionCodeInfo
inquilinoId corda | nulo O 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
analisarLink(link) 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 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

O URL de continuação do link de ação de e-mail. Nulo se não for fornecido.

Assinatura:

readonly continueUrl: string | null;

ActionCodeURL.idiomaCode

O código do idioma do link de ação de email. Nulo se não for fornecido.

Assinatura:

readonly languageCode: string | null;

ActionCodeURL.operação

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

O 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;

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 corda A string do link de ação de e-mail.

Retorna:

ActionCodeURL | nulo

O objeto ActionCodeURL ou nulo se o link for inválido.