用于解析电子邮件操作 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。