ActionCodeURL class

一个实用程序类,用于解析电子邮件操作网址,例如密码重置、电子邮件验证、电子邮件链接登录等。

此类的构造函数标记为内部函数。第三方代码不应直接调用构造函数或创建扩展 ActionCodeURL 类的子类。

签名

export declare class ActionCodeURL 

属性

属性 修饰符 类型 说明
apiKey 字符串 电子邮件操作链接的 API 密钥。
代码 字符串 电子邮件操作链接的操作代码。
continueUrl 字符串 |null 电子邮件操作链接的接续网址。如果未提供,则为 null。
languageCode 字符串 |null 电子邮件操作链接的语言代码。如果未提供,则为 null。
操作 字符串 电子邮件操作链接执行的操作。它从 ActionCodeInfo 中的一种类型返回
tenantId 字符串 |null 电子邮件操作链接的租户 ID。如果电子邮件操作来自父项目,则为 null。

方法

方法 修饰符 说明
parseLink(link) static 解析电子邮件操作链接字符串,如果链接有效,则返回 ActionCode网址,否则返回 null。

ActionCode网址.apiKey

电子邮件操作链接的 API 密钥。

签名

readonly apiKey: string;

ActionCode网址.code

电子邮件操作链接的操作代码。

签名

readonly code: string;

ActionCode网址.continueUrl

电子邮件操作链接的接续网址。如果未提供,则为 null。

签名

readonly continueUrl: string | null;

ActionCode网址.languageCode

电子邮件操作链接的语言代码。如果未提供,则为 null。

签名

readonly languageCode: string | null;

ActionCode网址.operation

电子邮件操作链接执行的操作。它从 ActionCodeInfo 中的一种类型返回

签名

readonly operation: string;

ActionCode网址.tenantId

电子邮件操作链接的租户 ID。如果电子邮件操作来自父项目,则为 null。

签名

readonly tenantId: string | null;

解析电子邮件操作链接字符串,如果链接有效,则返回 ActionCode网址,否则返回 null。

签名

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

参数

参数 类型 说明
link 字符串 电子邮件操作链接字符串。

返回

ActionCode网址 |null

ActionCode网址 对象;如果链接无效,则返回 null。