ActionCodeURL class

這個公用程式類別可剖析電子郵件動作網址,例如密碼重設、電子郵件驗證、電子郵件連結登入等。

這個類別的建構函式標示為內部函式。第三方程式碼不得直接呼叫建構函式,也不得建立擴充 ActionCodeURL 類別的子類別。

簽名:

export declare class ActionCodeURL 

屬性

屬性 修飾符 類型 說明
apiKey 字串 電子郵件動作連結的 API 金鑰。
程式碼 字串 電子郵件動作連結的動作代碼。
continueUrl 字串 |空值 電子郵件動作連結的繼續網址。如未提供,則為空值。
languageCode 字串 |空值 電子郵件動作連結的語言代碼。如未提供,則為空值。
運作 字串 由電子郵件動作連結執行的動作。該事件從 ActionCodeInfo 的其中一種類型傳回
用戶群 ID 字串 |空值 電子郵件動作連結的用戶群 ID。如果電子郵件動作來自父項專案,則為空值。

方法

方法 修飾符 說明
parseLink(連結) static 剖析電子郵件動作連結字串,如果連結有效,就會傳回 ActionCodeURL,否則傳回空值。

ActionCodeURL.apiKey

電子郵件動作連結的 API 金鑰。

簽名:

readonly apiKey: string;

ActionCodeURL.code

電子郵件動作連結的動作代碼。

簽名:

readonly code: string;

ActionCodeURL.continueUrl

電子郵件動作連結的繼續網址。如未提供,則為空值。

簽名:

readonly continueUrl: string | null;

ActionCodeURL.languageCode

電子郵件動作連結的語言代碼。如未提供,則為空值。

簽名:

readonly languageCode: string | null;

ActionCodeURL.operation

由電子郵件動作連結執行的動作。該事件從 ActionCodeInfo 的其中一種類型傳回

簽名:

readonly operation: string;

ActionCodeURL.用戶群 Id

電子郵件動作連結的用戶群 ID。如果電子郵件動作來自父項專案,則為空值。

簽名:

readonly tenantId: string | null;

剖析電子郵件動作連結字串,如果連結有效,就會傳回 ActionCodeURL,否則傳回空值。

簽名:

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

參數

參數 類型 說明
連結 字串 電子郵件動作連結字串。

傳回:

ActionCodeURL |空值

ActionCodeURL 物件;如果連結無效,則為空值。