OAuthCredential class

表示 OAuthProvider 返回的 OAuth 凭据。

实现指定了有关每个身份验证提供方凭据要求的详细信息。

签名

export declare class OAuthCredential extends AuthCredential 

扩展AuthCredential

属性

属性 修饰符 类型 说明
accessToken 字符串 与凭据关联的 OAuth 访问令牌(如果属于 OAuthProvider),例如 facebook.comtwitter.com 等。
idToken 字符串 与该凭据关联的 OAuth ID 令牌(如果该凭据属于 OIDC 提供方,例如 google.com)。
密钥 字符串 与凭据关联的 OAuth 访问令牌 Secret(如果属于 OAuth 1.0 提供方,例如 twitter.com)。

方法

方法 修饰符 说明
fromJSON(json) static 用于将对象的 JSON 表示法反序列化为 AuthCredential 的静态方法。
toJSON() 返回此对象的可序列化 JSON 表示法。

OAuthCredential.accessToken

与凭据关联的 OAuth 访问令牌(如果属于 OAuthProvider),例如 facebook.comtwitter.com 等。

签名

accessToken?: string;

OAuthCredential.idToken

与该凭据关联的 OAuth ID 令牌(如果属于 OIDC 提供方,例如 google.com)。

签名

idToken?: string;

OAuthCredential.secret

与凭据关联的 OAuth 访问令牌 Secret(如果属于 OAuth 1.0 提供方,例如 twitter.com)。

签名

secret?: string;

OAuthCredential.fromJSON()

用于将对象的 JSON 表示法反序列化为 AuthCredential 的静态方法。

签名

static fromJSON(json: string | object): OAuthCredential | null;

参数

参数 类型 说明
json 字符串 |对象 输入可以是对象,也可以是对象的字符串化表示形式。如果提供了字符串,则系统会首先调用 JSON.parse。

返回

OAuthCredential |null

如果 JSON 输入不表示 AuthCredential,则返回 null。

OAuthCredential.toJSON()

返回此对象的可序列化 JSON 表示法。

签名

toJSON(): object;

返回

对象

此对象的可序列化 JSON 表示法。