ActionCodeURL class

Klasa narzędzia do analizowania adresów URL działań e-mail, takich jak resetowanie hasła, weryfikacja adresu e-mail, logowanie za pomocą łącza e-mail itp.

Konstruktor dla tej klasy jest oznaczony jako wewnętrzny. Kod innej firmy nie powinien bezpośrednio wywoływać konstruktora ani tworzyć podklas rozszerzających klasę ActionCodeURL .

Podpis:

export declare class ActionCodeURL 

Nieruchomości

Nieruchomość Modyfikatory Typ Opis
Klucz API strunowy Klucz API łącza akcji e-mail.
kod strunowy Kod akcji łącza akcji e-mail.
kontynuujUrl ciąg | zero Adres URL kontynuacji łącza akcji e-mail. Wartość null, jeśli nie została podana.
kod języka ciąg | zero Kod języka łącza akcji e-mail. Wartość null, jeśli nie została podana.
operacja strunowy Akcja wykonywana przez łącze akcji e-mail. Zwraca jeden z typów z ActionCodeInfo
identyfikator najemcy ciąg | zero Identyfikator dzierżawy łącza akcji e-mail. Wartość null, jeśli akcja e-mail pochodzi z projektu nadrzędnego.

Metody

metoda Modyfikatory Opis
parseLink(link) static Analizuje ciąg łącza akcji e-mail i zwraca ActionCodeURL, jeśli łącze jest prawidłowe, w przeciwnym razie zwraca wartość null.

ActionCodeURL.apiKey

Klucz API łącza akcji e-mail.

Podpis:

readonly apiKey: string;

ActionCodeURL.code

Kod akcji łącza akcji e-mail.

Podpis:

readonly code: string;

ActionCodeURL.continueUrl

Adres URL kontynuacji łącza akcji e-mail. Wartość null, jeśli nie została podana.

Podpis:

readonly continueUrl: string | null;

ActionCodeURL.languageCode

Kod języka łącza akcji e-mail. Wartość null, jeśli nie została podana.

Podpis:

readonly languageCode: string | null;

ActionCodeURL.operacja

Akcja wykonywana przez łącze akcji e-mail. Zwraca jeden z typów z ActionCodeInfo

Podpis:

readonly operation: string;

ActionCodeURL.tenantId

Identyfikator dzierżawy łącza akcji e-mail. Wartość null, jeśli akcja e-mail pochodzi z projektu nadrzędnego.

Podpis:

readonly tenantId: string | null;

Analizuje ciąg łącza akcji e-mail i zwraca ActionCodeURL, jeśli łącze jest prawidłowe, w przeciwnym razie zwraca wartość null.

Podpis:

static parseLink(link: string): ActionCodeURL | null;

Parametry

Parametr Typ Opis
połączyć strunowy Ciąg linku do akcji e-mail.

Zwroty:

Adres URL kodu akcji | zero

Obiekt ActionCodeURL lub null, jeśli łącze jest nieprawidłowe.