ユーザーへの認証カードの表示をトリガーするために返されるエラー。
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 を設定します。必須。
パラメータ
名前 | 型 | 説明 |
---|---|---|
authUrl | String | 設定する認可 URL。 |
リターン
AuthorizationException
- このオブジェクト(チェーン用)。
setCustomUiCallback(callback)
カスタム承認プロンプトを生成するために呼び出す関数の名前。省略可。
パラメータ
名前 | 型 | 説明 |
---|---|---|
callback | String | カスタム承認プロンプトを生成する関数の名前。 |
リターン
AuthorizationException
- このオブジェクト(チェーン用)。
setResourceDisplayName(name)
承認をリクエストしたときにユーザーに表示される名前を設定します。必須。
パラメータ
名前 | 型 | 説明 |
---|---|---|
name | String | 表示名。 |
リターン
AuthorizationException
- このオブジェクト(チェーン用)。
throwException()
この例外のスローをトリガーします。