Cette page a été traduite par l'API Cloud Translation.

Class StateTokenBuilder

Permet aux scripts de créer des jetons d'état pouvant être utilisés dans les API de rappel (comme les flux OAuth).

// Reusable function to generate a callback URL, assuming the script has been published as a
// web app (necessary to obtain the URL programmatically). If the script has not been published
// as a web app, set `var url` in the first line to the URL of your script project (which
// cannot be obtained programmatically).
function getCallbackURL(callbackFunction){
  var url = ScriptApp.getService().getUrl();      // Ends in /exec (for a web app)
  url = url.slice(0, -4) + 'usercallback?state='; // Change /exec to /usercallback
  var stateToken = ScriptApp.newStateToken()
      .withMethod(callbackFunction)
      .withTimeout(120)
      .createToken();
  return url + stateToken;
}

Méthodes

Méthode	Type renvoyé	Brève description
`createToken()`	`String`	Construit une représentation sous forme de chaîne chiffrée du jeton d'état.
`withArgument(name, value)`	`StateTokenBuilder`	Ajoute un argument au jeton.
`withMethod(method)`	`StateTokenBuilder`	Définit une fonction de rappel.
`withTimeout(seconds)`	`StateTokenBuilder`	Définit la durée (en secondes) de validité du jeton.

Documentation détaillée

`createToken()`

Construit une représentation sous forme de chaîne chiffrée du jeton d'état.

var stateToken = ScriptApp.newStateToken().createToken();

Renvois

String : chaîne chiffrée représentant le jeton

`withArgument(name, value)`

Ajoute un argument au jeton. Cette méthode peut être appelée plusieurs fois.

var stateToken = ScriptApp.newStateToken().withArgument('myField', 'myValue').createToken();

Paramètres

Nom	Type	Description
`name`	`String`	le nom de l'argument
`value`	`String`	la valeur de l'argument

Renvois

StateTokenBuilder : compilateur de jetons d'état, pour le chaînage

`withMethod(method)`

Définit une fonction de rappel. La valeur par défaut est une fonction nommée callback().

var stateToken = ScriptApp.newStateToken().withMethod('myCallback').createToken();

Paramètres

Nom	Type	Description
`method`	`String`	Nom de la fonction de rappel, représenté par une chaîne sans parenthèses ni arguments. Vous pouvez utiliser des fonctions des bibliothèques incluses, telles que `Library.libFunction1`.

Renvois

StateTokenBuilder : compilateur de jetons d'état, pour le chaînage

`withTimeout(seconds)`

Définit la durée (en secondes) de validité du jeton. La valeur par défaut est de 60 secondes. La durée maximale est de 3 600 secondes (une heure).

var stateToken = ScriptApp.newStateToken().withTimeout(60).createToken();

Paramètres

Nom	Type	Description
`seconds`	`Integer`	la durée de validité du jeton ; la valeur maximale est `3600`

Renvois

StateTokenBuilder : compilateur de jetons d'état, pour le chaînage