Class AuthorizationException

AuthorizationException

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

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

Methods

メソッド戻り値の型概要
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()

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