Class AuthorizationException

AuthorizationException

ユーザーへの承認カードの表示をトリガーするために返されるエラー。

CardService.newAuthorizationException()
  .setAuthorizationUrl("http://auth.com/")
  .setResourceDisplayName("Example Resource")
  .throwException();

メソッド

メソッド戻り値の型概要
printJson()Stringこのオブジェクトの JSON 表現を出力します。
setAuthorizationUrl(authUrl)AuthorizationExceptionユーザーを認証プロンプトから取得する認証 URL を設定します。
setCustomUiCallback(callback)AuthorizationExceptionカスタム認証プロンプトを生成するために呼び出す関数の名前。
setResourceDisplayName(name)AuthorizationException承認を求める際にユーザーに表示される名前を設定します。
throwException()voidこの例外をスローします。

詳細なドキュメント

printJson()

このオブジェクトの JSON 表現を出力します。これはデバッグ専用です。

戻る

String


setAuthorizationUrl(authUrl)

ユーザーを認証プロンプトから取得する認証 URL を設定します。必須。

パラメータ

名前説明
authUrlString設定する認証 URL。

戻る

AuthorizationException - チェーン用のオブジェクト。


setCustomUiCallback(callback)

カスタム認証プロンプトを生成するために呼び出す関数の名前。省略可。

パラメータ

名前説明
callbackStringカスタム認証プロンプトを生成する関数の名前。

戻る

AuthorizationException - チェーン用のオブジェクト。


setResourceDisplayName(name)

承認を求める際にユーザーに表示される名前を設定します。必須。

パラメータ

名前説明
nameString表示名。

戻る

AuthorizationException - チェーン用のオブジェクト。


throwException()

この例外をスローします。