OAuthCredential class

代表 OAuthProvider 傳回的 OAuth 憑證。

實作項目會詳細介紹每個驗證供應商的憑證規定。

簽名:

export declare class OAuthCredential extends AuthCredential 

擴充功能: AuthCredential

屬性

屬性 修飾符 類型 說明
accessToken 字串 與憑證相關聯的 OAuth 存取權杖 (如果憑證屬於 OAuthProvider,例如 facebook.comtwitter.com 等)。
idToken 字串 與憑證相關聯的 OAuth ID 權杖 (如果憑證屬於 OIDC 提供者,例如 google.com)。
秘密 字串 與憑證相關聯的 OAuth 存取權杖密鑰 (如果屬於 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 存取權杖密鑰 (如果屬於 OAuth 1.0 提供者),例如 twitter.com

簽名:

secret?: string;

OAuthCredential.fromJSON()

這個靜態方法可將物件的 JSON 表示法反序列化為 AuthCredential

簽名:

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

參數

參數 類型 說明
json 字串 |物體 輸入可以是物件或物件的字串化表示法。提供字串時,系統會先呼叫 JSON.parse。

傳回:

OAuth 憑證 |空值

如果 JSON 輸入內容不代表 AuthCredential,則會傳回空值。

OAuthCredential.toJSON()

傳回此物件的 JSON 可序列化表示法。

簽名:

toJSON(): object;

傳回:

物件

此物件的 JSON 序列化表示法。