Class AuthorizationException

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

Methods

MethodReturn typeBrief description
printJson()StringPrints the JSON representation of this object.
setAuthorizationUrl(authUrl)AuthorizationExceptionSets the authorization URL that user is taken to from the authorization prompt.
setCustomUiCallback(callback)AuthorizationExceptionThe name of a function to call to generate a custom authorization prompt.
setResourceDisplayName(name)AuthorizationExceptionSets the name that is displayed to the user when asking for authorization.
throwException()voidTriggers 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

NameTypeDescription
authUrlStringThe 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

NameTypeDescription
callbackStringThe 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

NameTypeDescription
nameStringThe display name.

Return

AuthorizationException — This object, for chaining.

throwException()

Triggers this exception to be thrown.