Class StateTokenBuilder

StateTokenBuilder

Consente agli script di creare token di stato utilizzabili nelle API di callback (come i flussi 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;
}

Metodi

Metodo	Tipo restituito	Breve descrizione
createToken()	String	Crea una rappresentazione stringa criptata del token di stato.
withArgument(name, value)	StateTokenBuilder	Aggiunge un argomento al token.
withMethod(method)	StateTokenBuilder	Imposta una funzione di callback.
withTimeout(seconds)	StateTokenBuilder	Imposta la durata (in secondi) di validità del token.

Documentazione dettagliata

createToken()

Crea una rappresentazione stringa criptata del token di stato.

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

Ritorni

String: una stringa criptata che rappresenta il token

---

withArgument(name, value)

Aggiunge un argomento al token. Questo metodo può essere richiamato più volte.

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

Parametri

Nome	Tipo	Descrizione
name	String	il nome dell'argomento
value	String	il valore dell'argomento

Ritorni

StateTokenBuilder: il generatore di token di stato, per il concatenamento

---

withMethod(method)

Imposta una funzione di callback. Il valore predefinito è una funzione denominata callback().

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

Parametri

Nome	Tipo	Descrizione
method	String	Il nome della funzione di callback, rappresentato come stringa senza parentesi o argomenti. Puoi utilizzare le funzioni delle librerie incluse, ad esempio Library.libFunction1.

Ritorni

StateTokenBuilder: il generatore di token di stato, per il concatenamento

---

withTimeout(seconds)

Imposta la durata (in secondi) di validità del token. Il valore predefinito è 60 secondi; la durata massima è 3600 secondi (1 ora).

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

Parametri

Nome	Tipo	Descrizione
seconds	Integer	la durata di validità del token; il valore massimo è 3600

Ritorni

StateTokenBuilder: il generatore di token di stato, per il concatenamento