Class StateTokenBuilder

StateTokenBuilder

Permite que las secuencias de comandos creen tokens de estado que se pueden utilizar en las APIs de devolución de llamada (como los flujos de 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étodos

MétodoTipo de datos que se muestraDescripción breve
createToken()StringConstruye una representación de cadena encriptada del token de estado.
withArgument(name, value)StateTokenBuilderAgrega un argumento al token.
withMethod(method)StateTokenBuilderEstablece una función de devolución de llamada.
withTimeout(seconds)StateTokenBuilderEstablece la duración (en segundos) de la validez del token.

Documentación detallada

createToken()

Construye una representación de cadena encriptada del token de estado.

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

Devolvedor

String: Es una cadena encriptada que representa el token.


withArgument(name, value)

Agrega un argumento al token. Se puede llamar a este método varias veces.

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

Parámetros

NombreTipoDescripción
nameStringel nombre del argumento
valueStringel valor del argumento

Devolvedor

StateTokenBuilder: Es el compilador de tokens de estado para el encadenamiento.


withMethod(method)

Establece una función de devolución de llamada. El valor predeterminado es una función llamada callback().

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

Parámetros

NombreTipoDescripción
methodStringEs el nombre de la función de devolución de llamada, representada como una cadena sin paréntesis ni argumentos. Puedes usar funciones de las bibliotecas incluidas, como Library.libFunction1.

Devolvedor

StateTokenBuilder: Es el compilador de tokens de estado para el encadenamiento.


withTimeout(seconds)

Establece la duración (en segundos) de la validez del token. El valor predeterminado es de 60 segundos y la duración máxima es de 3,600 segundos (1 hora).

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

Parámetros

NombreTipoDescripción
secondsIntegerla duración de la validez del token; el valor máximo es 3600

Devolvedor

StateTokenBuilder: Es el compilador de tokens de estado para el encadenamiento.