Class StateTokenBuilder

StateTokenBuilder

Permite que las secuencias de comandos creen tokens de estado que se pueden usar en las APIs de devolución de llamada (como 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étodo	Tipo de datos que se muestra	Descripción breve
createToken()	String	Construye una representación de cadena encriptada del token de estado.
withArgument(name, value)	StateTokenBuilder	Agrega un argumento al token.
withMethod(method)	StateTokenBuilder	Establece una función de devolución de llamada.
withTimeout(seconds)	StateTokenBuilder	Establece 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();

Volver

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

Nombre	Tipo	Descripción
name	String	el nombre del argumento
value	String	el valor del argumento

Volver

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

Nombre	Tipo	Descripción
method	String	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.

Volver

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

---

withTimeout(seconds)

Establece la duración (en segundos) de la validez del token. Los valores predeterminados son 60 segundos; el la duración máxima es de 3,600 segundos (1 hora).

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

Parámetros

Nombre	Tipo	Descripción
seconds	Integer	la duración de la validez del token; el valor máximo es 3600

Volver

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