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 |
---|---|---|
printJson() | String | Prints the JSON representation of this object. |
setAuthorizationUrl(authUrl) | AuthorizationException | Sets the authorization URL that user is taken to from the authorization prompt. |
setCustomUiCallback(callback) | AuthorizationException | The name of a function to call to generate a custom authorization prompt. |
setResourceDisplayName(name) | AuthorizationException | Sets the name that is displayed to the user when asking for authorization. |
throwException() | 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 |
---|---|---|
authUrl | String | The authorization URL to set. |
Return
AuthorizationException
— 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
AuthorizationException
— 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
AuthorizationException
— This object, for chaining.
throwException()
Triggers this exception to be thrown.