Class StateTokenBuilder

StateTokenBuilder

Consente agli script di creare token di stato che possono essere utilizzati 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) {
  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;
}

Metodi

MetodoTipo restituitoBreve descrizione
createToken()StringCostruisce una rappresentazione di stringa criptata del token dello stato.
withArgument(name, value)StateTokenBuilderAggiunge un argomento al token.
withMethod(method)StateTokenBuilderImposta una funzione di callback.
withTimeout(seconds)StateTokenBuilderImposta la durata (in secondi) di validità del token.

Documentazione dettagliata

createToken()

Costruisce una rappresentazione di stringa criptata del token dello stato. 

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

Invio

String: una stringa criptata che rappresenta il token

withArgument(name, value)

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

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

Parametri

NomeTipoDescrizione
nameStringIl nome dell'argomento
valueStringil valore dell'argomento

Invio

StateTokenBuilder: il generatore di token di stato per l'accodamento

withMethod(method)

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

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

Parametri

NomeTipoDescrizione
methodStringIl nome della funzione di callback, rappresentata come stringa senza parentesi o argomenti. Puoi utilizzare le funzioni delle librerie incluse, ad esempio Library.libFunction1.

Invio

StateTokenBuilder: il generatore di token di stato per l'accodamento

withTimeout(seconds)

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

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

Parametri

NomeTipoDescrizione
secondsIntegerla durata di validità del token; il valore massimo è 3600

Invio

StateTokenBuilder: il generatore di token di stato per l'accodamento