OAuthProvider によって返される OAuth 認証情報を表します。
実装では、各認証プロバイダの認証情報要件に関する詳細を指定します。
署名:
export declare class OAuthCredential extends AuthCredential
拡張: AuthCredential
プロパティ
| プロパティ | 修飾キー | タイプ | 説明 |
|---|---|---|---|
| accessToken | 文字列 | OAuthProvider（facebook.com、twitter.com など）に属している場合、認証情報に関連付けられた OAuth アクセス トークン。 |
|
| idToken | 文字列 | OIDC プロバイダに属している場合、認証情報に関連付けられた OAuth ID トークン（google.com など）。 |
|
| Secret | 文字列 | OAuth 1.0 プロバイダに属している場合、認証情報に関連付けられた OAuth アクセス トークン シークレット（twitter.com など）。 |
メソッド
| メソッド | 修飾キー | 説明 |
|---|---|---|
| fromJSON（json） | static |
オブジェクトの JSON 表現を AuthCredential にシリアル化解除する静的メソッド。 |
| toJSON() | このオブジェクトの JSON シリアル化可能な表現を返します。 |
OAuthCredential.accessToken
OAuthProvider に属している場合、認証情報に関連付けられた OAuth アクセス トークン（facebook.com、twitter.com など）。
署名:
accessToken?: string;
OAuthCredential.idToken を使用する
OIDC プロバイダに属している場合、認証情報に関連付けられた OAuth ID トークン（google.com など）。
署名:
idToken?: string;
OAuthCredential.secret
OAuth 1.0 プロバイダに属している場合、認証情報に関連付けられた OAuth アクセス トークン シークレット（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 シリアル化可能な表現。