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éthode	Type renvoyé	Brève description
createToken()	String	Construit une représentation chiffrée de la chaîne 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) pendant laquelle le jeton est valide.

Documentation détaillée

createToken()

Construit une représentation chiffrée de la chaîne 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

Nom	Type	Description
name	String	Nom de l'argument
value	String	la valeur 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

Nom	Type	Description
method	String	Nom de la fonction de rappel, représenté sous forme de chaîne sans parenthèses ni arguments. Vous pouvez utiliser les fonctions des bibliothèques incluses, telles que 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. La durée maximale est de 3 600 secondes (1 heure).

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

Paramètres

Nom	Type	Description
seconds	Integer	Durée de validité du jeton (valeur maximale : 3600)

Renvois

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