ActionCodeURL class

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

Konstruktor dla tej klasy jest oznaczony jako wewnętrzny. Kod zewnętrzny nie powinien wywoływać konstruktora bezpośrednio ani tworzyć podklas, które rozszerzają klasę ActionCodeURL.

Podpis:

export declare class ActionCodeURL 

Właściwości

Właściwość Modyfikatory Typ Opis
apiKey ciąg znaków Klucz interfejsu API linku do działania e-maila.
kod ciąg znaków Kod działania linku do działania e-maila.
continueUrl. ciąg znaków | wartość null Adres URL linku do dalszych działań w e-mailu. Wartość null, jeśli nie została podana.
languageCode, ciąg znaków | wartość null Kod języka linku do działania e-maila. Wartość null, jeśli nie została podana.
operacja ciąg znaków Czynność wykonana przez link czynności e-mail. Zwracany jest z jednego z typów z ActionCodeInfo
tenantId, ciąg znaków | wartość null Identyfikator najemcy linku do działania w e-mailu. Wartość „null”, jeśli działanie e-maila pochodzi z projektu nadrzędnego.

Metody

Metoda Modyfikatory Opis
parseLink(link), static Analizuje ciąg znaków linku do działania w e-mailu i zwraca wartość ActionCodeURL, jeśli link jest prawidłowy. W przeciwnym razie zwraca wartość null.

ActionCodeURL.apiKey

Klucz interfejsu API linku do działania e-maila.

Podpis:

readonly apiKey: string;

ActionCodeURL.code

Kod działania linku do działania e-maila.

Podpis:

readonly code: string;

ActionCodeURL.continueUrl

Adres URL linku do dalszych działań w e-mailu. Wartość null, jeśli nie została podana.

Podpis:

readonly continueUrl: string | null;

ActionCodeURL.kodjęzyka

Kod języka linku do działania e-maila. Wartość null, jeśli nie została podana.

Podpis:

readonly languageCode: string | null;

ActionCodeURL.operation

Czynność wykonana przez link czynności e-mail. Zwracany jest z jednego z typów z ActionCodeInfo

Podpis:

readonly operation: string;

AdresURLkodu_działań.identyfikator najemcy

Identyfikator najemcy linku do działania w e-mailu. Wartość „null”, jeśli działanie e-maila pochodzi z projektu nadrzędnego.

Podpis:

readonly tenantId: string | null;

Analizuje ciąg znaków linku do działania w e-mailu i zwraca wartość ActionCodeURL, jeśli link jest prawidłowy. W przeciwnym razie zwraca wartość null.

Podpis:

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

Parametry

Parametr Typ Opis
link ciąg znaków Ciąg znaków linku do działania e-maila.

Zwroty:

ActionCodeURL | wartość null

Obiekt ActionCodeURL lub wartość null, jeśli link jest nieprawidłowy.