Class AuthorizationException
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
AutorizaçãoException
Um erro que pode ser retornado para acionar um card de autorização a ser mostrado ao usuário.
CardService.newAuthorizationException()
.setAuthorizationUrl('http://auth.com/')
.setResourceDisplayName('Example Resource')
.throwException();
Documentação detalhada
printJson()
Mostra a representação JSON desse objeto. Isso é apenas para depuração.
Retornar
String
setAuthorizationUrl(authUrl)
Define o URL de autorização para onde o usuário é direcionado a partir do comando de autorização. Obrigatório.
Parâmetros
Nome | Tipo | Descrição |
authUrl | String | O URL de autorização a ser definido. |
Retornar
AuthorizationException
: este objeto, para encadeamento.
setCustomUiCallback(callback)
O nome de uma função a ser chamada para gerar uma solicitação de autorização personalizada. Opcional.
Parâmetros
Nome | Tipo | Descrição |
callback | String | O nome da função que gera uma solicitação de autorização personalizada. |
Retornar
AuthorizationException
: este objeto, para encadeamento.
setResourceDisplayName(name)
Define o nome que aparece para o usuário ao solicitar autorização. Obrigatório.
Parâmetros
Nome | Tipo | Descrição |
name | String | O nome de exibição. |
Retornar
AuthorizationException
: este objeto, para encadeamento.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-26 UTC.
[null,null,["Última atualização 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."]]