この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

Newer Version Available

This content describes an older version of this product. View Latest

OAuthRefreshResult クラス

AuthProviderPluginClass 更新メソッドの結果を保存します。OAuth 認証フローでは、新しいアクセストークンの取得に使用できる更新トークンが提供されます。アクセストークンの有効期間は、セッションタイムアウト値で指定されたとおりに制限されます。アクセストークンの有効期限が切れた場合、更新トークンを使用して新しいアクセストークンを取得します。

名前空間

Auth

使用方法

OAuthRefreshResult には、パラメータ accessTokenrefreshToken、および error が含まれます。このすべてのパラメータは string 型です。コードの例については、「Auth 例外」を参照してください。

OAuthRefreshResult のコンストラクタ

OAuthRefreshResult のコンストラクタは次のとおりです。

OAuthRefreshResult(accessToken, refreshToken, error)

カスタム認証プロバイダプラグインに対して指定されたアクセストークン、更新トークン、およびエラーを使用して、OAuthRefreshResult クラスのインスタンスを作成します。

署名

public OAuthRefreshResult(String accessToken, String refreshToken, String error)

パラメータ

accessToken
型: String
現在ログインしているユーザの OAuth アクセストークン。
refreshToken
型: String
現在ログインしているユーザの OAuth 更新トークン。
error
型: String
ユーザがカスタム認証プロバイダとの認証を行っているときに発生したエラー。

OAuthRefreshResult(accessToken, refreshToken)

カスタム認証プロバイダプラグインに対して指定されたアクセストークンおよび更新トークンを使用して、OAuthRefreshResult クラスのインスタンスを作成します。更新に失敗したことを認識している場合にこのメソッドを使用します。

署名

public OAuthRefreshResult(String accessToken, String refreshToken)

パラメータ

accessToken
型: String
ログインしているユーザの OAuth アクセストークン。
refreshToken
型: String
ログインしているユーザの OAuth 更新トークン。

OAuthRefreshResult のプロパティ

OAuthRefreshResult のプロパティは次のとおりです。

accessToken

現在ログインしているユーザの OAuth アクセストークン。

署名

public String accessToken {get; set;}

プロパティ値

型: String

error

ユーザがカスタム認証プロバイダとの認証に失敗した場合に発生するエラー。

署名

public String error {get; set;}

プロパティ値

型: String

refreshToken

現在ログインしているユーザの OAuth 更新トークン。

署名

public String refreshToken {get; set;}

プロパティ値

型: String