ActionCodeURL class

Eine Dienstprogrammklasse zum Parsen von E-Mail-Aktions-URLs wie Passwortzurücksetzung, E-Mail-Verifizierung, E-Mail-Link-Anmeldung usw.

Der Konstruktor für diese Klasse ist als intern markiert. Code von Drittanbietern sollte den Konstruktor nicht direkt aufrufen oder Unterklassen erstellen, die die ActionCodeURL Klasse erweitern.

Unterschrift:

export declare class ActionCodeURL

Eigenschaften

Eigentum Modifikatoren Typ Beschreibung
API-Schlüssel Zeichenfolge Der API-Schlüssel des E-Mail-Aktionslinks.
Code Zeichenfolge Der Aktionscode des E-Mail-Aktionslinks.
continueUrl Zeichenfolge | Null Die Fortsetzungs-URL des E-Mail-Aktionslinks. Null, wenn nicht angegeben.
Sprachcode Zeichenfolge | Null Der Sprachcode des E-Mail-Aktionslinks. Null, wenn nicht angegeben.
Betrieb Zeichenfolge Die durch den E-Mail-Aktionslink ausgeführte Aktion. Es wird von einem der Typen von ActionCodeInfo zurückgegeben
Mieter-ID Zeichenfolge | Null Die Mandanten-ID des E-Mail-Aktionslinks. Null, wenn die E-Mail-Aktion vom übergeordneten Projekt stammt.

Methoden

Methode Modifikatoren Beschreibung
parseLink(Link) static Analysiert die Linkzeichenfolge der E-Mail-Aktion und gibt eine ActionCodeURL zurück, wenn der Link gültig ist, andernfalls wird null zurückgegeben.

ActionCodeURL.apiKey

Der API-Schlüssel des E-Mail-Aktionslinks.

Unterschrift:

readonly apiKey: string;

ActionCodeURL.code

Der Aktionscode des E-Mail-Aktionslinks.

Unterschrift:

readonly code: string;

ActionCodeURL.continueUrl

Die Fortsetzungs-URL des E-Mail-Aktionslinks. Null, wenn nicht angegeben.

Unterschrift:

readonly continueUrl: string | null;

ActionCodeURL.Sprachcode

Der Sprachcode des E-Mail-Aktionslinks. Null, wenn nicht angegeben.

Unterschrift:

readonly languageCode: string | null;

ActionCodeURL.operation

Die durch den E-Mail-Aktionslink ausgeführte Aktion. Es wird von einem der Typen von ActionCodeInfo zurückgegeben

Unterschrift:

readonly operation: string;

ActionCodeURL.tenantId

Die Mandanten-ID des E-Mail-Aktionslinks. Null, wenn die E-Mail-Aktion vom übergeordneten Projekt stammt.

Unterschrift:

readonly tenantId: string | null;

Analysiert die Linkzeichenfolge der E-Mail-Aktion und gibt eine ActionCodeURL zurück, wenn der Link gültig ist, andernfalls wird null zurückgegeben.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Verknüpfung Zeichenfolge Die Linkzeichenfolge für die E-Mail-Aktion.

Kehrt zurück:

ActionCodeURL | Null

Das ActionCodeURL- Objekt oder null, wenn der Link ungültig ist.