OAuthCredential class

OAuthProviderによって返された OAuth 資格情報を表します。

実装では、各認証プロバイダーの資格情報要件の詳細を指定します。

サイン:

export declare class OAuthCredential extends AuthCredential 

拡張: AuthCredential

プロパティ

財産修飾子タイプ説明
アクセストークン認証情報がOAuthProviderに属している場合、認証情報に関連付けられた OAuth アクセス トークンfacebook.comtwitter.comなど
idトークン資格情報が OIDC プロバイダー ( google.comなど) に属している場合は、資格情報に関連付けられた OAuth ID トークン。
秘密資格情報がtwitter.comなどの OAuth 1.0 プロバイダーに属している場合、資格情報に関連付けられた OAuth アクセス トークンのシークレット。

メソッド

方法修飾子説明
fromJSON(json) staticオブジェクトの JSON 表現をAuthCredentialに逆シリアル化する静的メソッド
toJSON()このオブジェクトの JSON シリアル化可能な表現を返します。

OAuthCredential.accessToken

認証情報がOAuthProviderに属している場合、認証情報に関連付けられた OAuth アクセス トークンfacebook.comなどtwitter.com 、など。

サイン:

accessToken?: string;

OAuthCredential.idToken

資格情報が OIDC プロバイダー ( google.comなど) に属している場合は、資格情報に関連付けられた OAuth ID トークン

サイン:

idToken?: string;

OAuthCredential.secret

資格情報がtwitter.comなどの OAuth 1.0 プロバイダーに属している場合、資格情報に関連付けられた OAuth アクセス トークンのシークレット

サイン:

secret?: string;

OAuthCredential.fromJSON()

オブジェクトの JSON 表現をAuthCredentialに逆シリアル化する静的メソッド

サイン:

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

パラメーター

パラメータタイプ説明
json文字列 |物体入力は、オブジェクトまたはオブジェクトの文字列化された表現のいずれかです。文字列を指定すると、最初に JSON.parse が呼び出されます。

戻り値:

OAuth認証情報|ヌル

JSON 入力がAuthCredentialを表していない場合、nullが返されます。

OAuthCredential.toJSON()

このオブジェクトの JSON シリアル化可能な表現を返します。

サイン:

toJSON(): object;

戻り値:

物体

このオブジェクトの JSON シリアル化可能な表現。