Class AuthorizationException

Exception d'autorisation

Erreur pouvant être renvoyée pour déclencher l'affichage d'une fiche d'autorisation auprès de l'utilisateur.

CardService.newAuthorizationException()
    .setAuthorizationUrl('http://auth.com/')
    .setResourceDisplayName('Example Resource')
    .throwException();

Méthodes

MéthodeType renvoyéBrève description
printJson()StringImprime la représentation JSON de cet objet.
setAuthorizationUrl(authUrl)AuthorizationExceptionDéfinit l'URL d'autorisation vers laquelle l'utilisateur est redirigé à partir de l'invite d'autorisation.
setCustomUiCallback(callback)AuthorizationExceptionNom d'une fonction à appeler pour générer une requête d'autorisation personnalisée.
setResourceDisplayName(name)AuthorizationExceptionDéfinit le nom qui s'affiche auprès de l'utilisateur lors de la demande d'autorisation.
throwException()voidDéclenche l'exception.

Documentation détaillée

printJson()

Imprime la représentation JSON de cet objet. Cette option est réservée au débogage.

Renvois

String


setAuthorizationUrl(authUrl)

Définit l'URL d'autorisation vers laquelle l'utilisateur est redirigé à partir de l'invite d'autorisation. Obligatoire.

Paramètres

NomTypeDescription
authUrlStringURL d'autorisation à définir.

Renvois

AuthorizationException : cet objet, pour le chaînage.


setCustomUiCallback(callback)

Nom d'une fonction à appeler pour générer une requête d'autorisation personnalisée. Facultatif.

Paramètres

NomTypeDescription
callbackStringNom de la fonction qui génère une invite d'autorisation personnalisée.

Renvois

AuthorizationException : cet objet, pour le chaînage.


setResourceDisplayName(name)

Définit le nom qui s'affiche auprès de l'utilisateur lors de la demande d'autorisation. Obligatoire.

Paramètres

NomTypeDescription
nameStringNom à afficher.

Renvois

AuthorizationException : cet objet, pour le chaînage.


throwException()

Déclenche l'exception.