Class AuthorizationException

AuthorizationException

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();

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

Prints the JSON representation of this object. This is for debugging only.

String

Sets the authorization URL that user is taken to from the authorization prompt. Required.

Name	Type	Description
`authUrl`	`String`	The authorization URL to set.

AuthorizationException — This object, for chaining.

The name of a function to call to generate a custom authorization prompt. Optional.

Name	Type	Description
`callback`	`String`	The name of the function that generates a custom authorization prompt.

AuthorizationException — This object, for chaining.

Sets the name that is displayed to the user when asking for authorization. Required.

Name	Type	Description
`name`	`String`	The display name.

AuthorizationException — This object, for chaining.

Triggers this exception to be thrown.