Class AuthorizationException
Stay organized with collections
Save and categorize content based on your preferences.
AI-generated Key Takeaways
-
AuthorizationException is an error used to trigger an authorization card for the user.
-
Key methods include setting the authorization URL and resource display name.
-
The exception can be configured with a custom UI callback function.
-
Use
throwException()to trigger the authorization card.
An error that can be returned to trigger an authorization card to be shown to the user.
CardService .newAuthorizationException() .setAuthorizationUrl('http://auth.com/') .setResourceDisplayName('Example Resource') .throwException();
Methods
| Method | Return type | Brief description |
|---|---|---|
print | String | Prints the JSON representation of this object. |
set | Authorization | Sets the authorization URL that user is taken to from the authorization prompt. |
set | Authorization | The name of a function to call to generate a custom authorization prompt. |
set | Authorization | Sets the name that is displayed to the user when asking for authorization. |
throw | void | Triggers this exception to be thrown. |
Detailed documentation
printJson()
Prints the JSON representation of this object. This is for debugging only.
Return
String
setAuthorizationUrl(authUrl)
Sets the authorization URL that user is taken to from the authorization prompt. Required.
Parameters
| Name | Type | Description |
|---|---|---|
auth | String | The authorization URL to set. |
Return
Authorization — This object, for chaining.
setCustomUiCallback(callback)
The name of a function to call to generate a custom authorization prompt. Optional.
Parameters
| Name | Type | Description |
|---|---|---|
callback | String | The name of the function that generates a custom authorization prompt. |
Return
Authorization — This object, for chaining.
setResourceDisplayName(name)
Sets the name that is displayed to the user when asking for authorization. Required.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | The display name. |
Return
Authorization — This object, for chaining.
throwException()
Triggers this exception to be thrown.