Class AuthorizationException

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.
ExceptionException

Une erreur peut ê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 dirigé 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 qui s'affiche lorsque l'utilisateur demande une autorisation.
throwException()voidDéclenche cette exception.

Documentation détaillée

printJson()

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

Aller-retour

String


setAuthorizationUrl(authUrl)

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

Paramètres

NomTypeDescription
authUrlStringURL d'autorisation à définir.

Aller-retour

AuthorizationException : cet objet, 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.

Aller-retour

AuthorizationException : cet objet, pour le chaînage


setResourceDisplayName(name)

Définit le nom qui s'affiche lorsque l'utilisateur demande une autorisation. Obligatoire.

Paramètres

NomTypeDescription
nameStringNom à afficher.

Aller-retour

AuthorizationException : cet objet, pour le chaînage


throwException()

Déclenche cette exception.