Erreur pouvant être renvoyée pour déclencher l'affichage d'une carte d'autorisation à l'utilisateur.
CardService.newAuthorizationException() .setAuthorizationUrl('http://auth.com/') .setResourceDisplayName('Example Resource') .throwException();
Méthodes
| Méthode | Type renvoyé | Brève description |
|---|---|---|
print | String | Affiche la représentation JSON de cet objet. |
set | Authorization | Définit l'URL d'autorisation vers laquelle l'utilisateur est redirigé à partir de l'invite d'autorisation. |
set | Authorization | Nom d'une fonction à appeler pour générer une invite d'autorisation personnalisée. |
set | Authorization | Définit le nom affiché à l'utilisateur lorsque l'autorisation est demandée. |
throw | void | Déclenche la génération de cette exception. |
Documentation détaillée
printJson()
Affiche la représentation JSON de cet objet. Ceci n'est destiné qu'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
| Nom | Type | Description |
|---|---|---|
auth | String | URL d'autorisation à définir. |
Renvois
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
| Nom | Type | Description |
|---|---|---|
callback | String | Nom 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 affiché à l'utilisateur lorsque l'autorisation est demandée. Obligatoire.
Paramètres
| Nom | Type | Description |
|---|---|---|
name | String | Nom à afficher. |
Renvois
AuthorizationException : cet objet, pour le chaînage.
throwException()
Déclenche la génération de cette exception.