Class AuthorizationException

AuthorizationException

Erreur pouvant être renvoyée pour déclencher l'affichage d'une carte 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()StringAffiche la représentation JSON de cet objet.
setAuthorizationUrl(authUrl)AuthorizationExceptionDéfinit l'URL d'autorisation vers laquelle l'utilisateur est redirigé depuis l'invite d'autorisation.
setCustomUiCallback(callback)AuthorizationExceptionNom d'une fonction à appeler pour générer une invite d'autorisation personnalisée.
setResourceDisplayName(name)AuthorizationExceptionDéfinit le nom présenté à l'utilisateur lorsqu'il demande une autorisation.
throwException()voidDéclenche la génération de cette exception.

Documentation détaillée

printJson()

Affiche la représentation JSON de cet objet. Il n'est utilisé qu'à des fins de débogage.

Renvois

String


setAuthorizationUrl(authUrl)

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

Paramètres

NomTypeDescription
authUrlStringURL d'autorisation à définir.

Renvois

AuthorizationException : objet utilisé pour le chaînage.


setCustomUiCallback(callback)

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

Paramètres

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

Renvois

AuthorizationException : objet utilisé pour le chaînage.


setResourceDisplayName(name)

Définit le nom présenté à l'utilisateur lorsqu'il demande une autorisation. Obligatoire.

Paramètres

NomTypeDescription
nameStringNom à afficher.

Renvois

AuthorizationException : objet utilisé pour le chaînage.


throwException()

Déclenche la génération de cette exception.