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éthode | Type renvoyé | Brève description |
|---|---|---|
printJson() | String | Affiche la représentation JSON de cet objet. |
setAuthorizationUrl(authUrl) | AuthorizationException | Définit l'URL d'autorisation vers laquelle l'utilisateur est redirigé depuis l'invite d'autorisation. |
setCustomUiCallback(callback) | AuthorizationException | Nom d'une fonction à appeler pour générer une invite d'autorisation personnalisée. |
setResourceDisplayName(name) | AuthorizationException | Définit le nom présenté à l'utilisateur lorsqu'il demande une autorisation. |
throwException() | void | Dé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
| Nom | Type | Description |
|---|---|---|
authUrl | String | URL 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
| Nom | Type | Description |
|---|---|---|
callback | String | Nom 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
| Nom | Type | Description |
|---|---|---|
name | String | Nom à afficher. |
Renvois
AuthorizationException : objet utilisé pour le chaînage.
throwException()
Déclenche la génération de cette exception.