用於解析電子郵件操作 URL(例如密碼重設、電子郵件驗證、電子郵件連結登入等)的實用程式類別。
此類的構造函數被標記為內部構造函數。第三方程式碼不應直接呼叫建構函式或建立擴充ActionCodeURL
類別的子類別。
簽名:
export declare class ActionCodeURL
特性
財產 | 修飾符 | 類型 | 描述 |
---|---|---|---|
API金鑰 | 細繩 | 電子郵件操作連結的 API 金鑰。 | |
程式碼 | 細繩 | 電子郵件操作連結的操作代碼。 | |
繼續網址 | 字串|無效的 | 電子郵件操作連結的繼續 URL。如果未提供則為空。 | |
語言程式碼 | 字串|無效的 | 電子郵件操作連結的語言代碼。如果未提供則為空。 | |
手術 | 細繩 | 透過電子郵件操作連結執行的操作。它從ActionCodeInfo的一種類型傳回 | |
租戶ID | 字串|無效的 | 電子郵件操作連結的租用戶 ID。如果電子郵件操作來自父項目,則為空。 |
方法
方法 | 修飾符 | 描述 |
---|---|---|
解析連結(連結) | static | 解析電子郵件動作連結字串,如果連結有效,則傳回ActionCodeURL ,否則傳回 null。 |
ActionCodeURL.apiKey
電子郵件操作連結的 API 金鑰。
簽名:
readonly apiKey: string;
ActionCodeURL.code
電子郵件操作連結的操作代碼。
簽名:
readonly code: string;
ActionCodeURL.continueUrl
電子郵件操作連結的繼續 URL。如果未提供則為空。
簽名:
readonly continueUrl: string | null;
ActionCodeURL.語言程式碼
電子郵件操作連結的語言代碼。如果未提供則為空。
簽名:
readonly languageCode: string | null;
ActionCodeURL.操作
透過電子郵件操作連結執行的操作。它從ActionCodeInfo的一種類型傳回
簽名:
readonly operation: string;
ActionCodeURL.tenantId
電子郵件操作連結的租用戶 ID。如果電子郵件操作來自父項目,則為空。
簽名:
readonly tenantId: string | null;
ActionCodeURL.parseLink()
解析電子郵件動作連結字串,如果連結有效,則傳回ActionCodeURL ,否則傳回 null。
簽名:
static parseLink(link: string): ActionCodeURL | null;
參數
範圍 | 類型 | 描述 |
---|---|---|
關聯 | 細繩 | 電子郵件操作連結字串。 |
返回:
操作代碼URL |無效的
ActionCodeURL對象,如果連結無效,則為 null。