Class StateTokenBuilder

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) {
  let url = ScriptApp.getService().getUrl();  // Ends in /exec (for a web app)
  url = `${
      url.slice(0, -4)}usercallback?state=`;  // Change /exec to /usercallback
  const stateToken = ScriptApp.newStateToken()
                         .withMethod(callbackFunction)
                         .withTimeout(120)
                         .createToken();
  return url + stateToken;
}

Méthodes

MéthodeType renvoyéBrève description
createToken()StringConstruit une représentation sous forme de chaîne chiffrée du jeton d'état.
withArgument(name, value)StateTokenBuilderAjoute un argument au jeton.
withMethod(method)StateTokenBuilderDéfinit une fonction de rappel.
withTimeout(seconds)StateTokenBuilderDéfinit la durée (en secondes) pendant laquelle le jeton est valide.

Documentation détaillée

createToken()

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

const 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. 

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

Paramètres

NomTypeDescription
nameStringNom de l'argument.
valueStringValeur de l'argument.

Renvois

StateTokenBuilder : générateur de jetons d'état, pour l'enchaînement.

withMethod(method)

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

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

Paramètres

NomTypeDescription
methodStringNom de la fonction de rappel, représenté sous la forme d'une chaîne sans parenthèses ni arguments. Vous pouvez utiliser des fonctions des bibliothèques incluses, comme Library.libFunction1.

Renvois

StateTokenBuilder : générateur de jetons d'état, pour l'enchaînement.

withTimeout(seconds)

Définit la durée (en secondes) pendant laquelle le jeton est valide. La valeur par défaut est de 60 secondes, et la durée maximale est de 3 600 secondes (1 heure). 

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

Paramètres

NomTypeDescription
secondsIntegerDurée de validité du jeton. La valeur maximale est 3600.

Renvois

StateTokenBuilder : générateur de jetons d'état, pour l'enchaînement.