Class 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()

この例外がスローされるようにトリガーします。