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éthode | Type renvoyé | Brève description |
---|---|---|
print | String | Imprime 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 requête d'autorisation personnalisée. |
set | Authorization | Définit le nom qui s'affiche auprès de l'utilisateur lors de la demande d'autorisation. |
throw | void | Déclenche l'exception. |
Documentation détaillée
print Json()
Imprime la représentation JSON de cet objet. Cette option est réservée au débogage.
Renvois
String
set Authorization Url(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
Authorization
: cet objet, pour le chaînage.
set Custom Ui Callback(callback)
Nom d'une fonction à appeler pour générer une requête 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
Authorization
: cet objet, pour le chaînage.
set Resource Display Name(name)
Définit le nom qui s'affiche auprès de l'utilisateur lors de la demande d'autorisation. Obligatoire.
Paramètres
Nom | Type | Description |
---|---|---|
name | String | Nom à afficher. |
Renvois
Authorization
: cet objet, pour le chaînage.
throw Exception()
Déclenche l'exception.