Esta página foi traduzida pela API Cloud Translation.

Class StateTokenBuilder

Permite que os scripts criem tokens de estado que podem ser usados em APIs de callback (como fluxos do 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 retorno	Breve descrição
`createToken()`	`String`	Constrói uma representação de string criptografada do token de estado.
`withArgument(name, value)`	`StateTokenBuilder`	Adiciona um argumento ao token.
`withMethod(method)`	`StateTokenBuilder`	Define uma função de callback.
`withTimeout(seconds)`	`StateTokenBuilder`	Define a duração (em segundos) pela qual o token é válido.

Documentação detalhada

`createToken()`

Constrói uma representação de string criptografada do token de estado.

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

Retorno

String: uma string criptografada que representa o token.

`withArgument(name, value)`

Adiciona um argumento ao token. Esse método pode ser chamado várias vezes.

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

Parâmetros

Nome	Tipo	Descrição
`name`	`String`	o nome do argumento
`value`	`String`	o valor do argumento

Retorno

StateTokenBuilder: o criador de token de estado, para encadeamento.

`withMethod(method)`

Define uma função de callback. O padrão é uma função chamada callback().

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

Parâmetros

Nome	Tipo	Descrição
`method`	`String`	O nome da função de callback, representado como uma string sem parênteses ou argumentos. Você pode usar funções de bibliotecas incluídas, como `Library.libFunction1`.

Retorno

StateTokenBuilder: o criador de token de estado, para encadeamento.

`withTimeout(seconds)`

Define a duração (em segundos) pela qual o token é válido. O padrão é 60 segundos. A duração máxima é de 3.600 segundos (uma hora).

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

Parâmetros

Nome	Tipo	Descrição
`seconds`	`Integer`	a duração do token. O valor máximo é `3600`;

Retorno

StateTokenBuilder: o criador de token de estado, para encadeamento.