Class AuthorizationException
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Exception d'autorisation
Erreur pouvant être renvoyée pour déclencher l'affichage d'une fiche d'autorisation auprès de l'utilisateur.
CardService.newAuthorizationException()
.setAuthorizationUrl('http://auth.com/')
.setResourceDisplayName('Example Resource')
.throwException();
Documentation détaillée
printJson()
Imprime la représentation JSON de cet objet. Cette option est réservée au débogage.
Renvois
String
setAuthorizationUrl(authUrl)
Définit l'URL d'autorisation vers laquelle l'utilisateur est redirigé à partir de l'invite d'autorisation. Obligatoire.
Paramètres
| Nom | Type | Description |
authUrl | String | URL d'autorisation à définir. |
Renvois
AuthorizationException : cet objet, pour le chaînage.
setCustomUiCallback(callback)
Nom d'une fonction à appeler pour générer une requête d'autorisation personnalisée. Facultatif.
Paramètres
| Nom | Type | Description |
callback | String | Nom de la fonction qui génère une invite d'autorisation personnalisée. |
Renvois
AuthorizationException : cet objet, pour le chaînage.
setResourceDisplayName(name)
Définit le nom qui s'affiche auprès de l'utilisateur lors de la demande d'autorisation. Obligatoire.
Paramètres
| Nom | Type | Description |
name | String | Nom à afficher. |
Renvois
AuthorizationException : cet objet, pour le chaînage.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/26 (UTC).
[null,null,["Dernière mise à jour le 2025/07/26 (UTC)."],[[["\u003cp\u003e\u003ccode\u003eAuthorizationException\u003c/code\u003e triggers an authorization card to obtain user authorization.\u003c/p\u003e\n"],["\u003cp\u003eIt allows setting an authorization URL, a resource display name, and optionally, a custom authorization prompt.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers use \u003ccode\u003esetAuthorizationUrl()\u003c/code\u003e, \u003ccode\u003esetResourceDisplayName()\u003c/code\u003e, and \u003ccode\u003esetCustomUiCallback()\u003c/code\u003e to configure the authorization request.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ethrowException()\u003c/code\u003e initiates the authorization flow, prompting the user to grant access.\u003c/p\u003e\n"],["\u003cp\u003eDebugging is facilitated by \u003ccode\u003eprintJson()\u003c/code\u003e which outputs the object's JSON representation.\u003c/p\u003e\n"]]],[],null,["# Class AuthorizationException\n\nAuthorizationException\n\nAn error that can be returned to trigger an authorization card to be shown to the user.\n\n```javascript\nCardService.newAuthorizationException()\n .setAuthorizationUrl('http://auth.com/')\n .setResourceDisplayName('Example Resource')\n .throwException();\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|-----------------------------------------------------------------|-----------------------------|---------------------------------------------------------------------------------|\n| [printJson()](#printJson()) | `String` | Prints the JSON representation of this object. |\n| [setAuthorizationUrl(authUrl)](#setAuthorizationUrl(String)) | [AuthorizationException](#) | Sets the authorization URL that user is taken to from the authorization prompt. |\n| [setCustomUiCallback(callback)](#setCustomUiCallback(String)) | [AuthorizationException](#) | The name of a function to call to generate a custom authorization prompt. |\n| [setResourceDisplayName(name)](#setResourceDisplayName(String)) | [AuthorizationException](#) | Sets the name that is displayed to the user when asking for authorization. |\n| [throwException()](#throwException()) | `void` | Triggers this exception to be thrown. |\n\nDetailed documentation\n----------------------\n\n### `print``Json()`\n\nPrints the JSON representation of this object. This is for debugging only.\n\n#### Return\n\n\n`String`\n\n*** ** * ** ***\n\n### `set``Authorization``Url(authUrl)`\n\nSets the authorization URL that user is taken to from the authorization prompt. Required.\n\n#### Parameters\n\n| Name | Type | Description |\n|-------------|----------|-------------------------------|\n| `auth``Url` | `String` | The authorization URL to set. |\n\n#### Return\n\n\n[AuthorizationException](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Custom``Ui``Callback(callback)`\n\nThe name of a function to call to generate a custom authorization prompt. Optional.\n\n#### Parameters\n\n| Name | Type | Description |\n|------------|----------|------------------------------------------------------------------------|\n| `callback` | `String` | The name of the function that generates a custom authorization prompt. |\n\n#### Return\n\n\n[AuthorizationException](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Resource``Display``Name(name)`\n\nSets the name that is displayed to the user when asking for authorization. Required.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------|----------|-------------------|\n| `name` | `String` | The display name. |\n\n#### Return\n\n\n[AuthorizationException](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `throw``Exception()`\n\nTriggers this exception to be thrown."]]
