Class StateTokenBuilder

StateTokenBuilder

Zezwala skryptom na tworzenie tokenów stanu, które mogą być używane w interfejsach API wywołań zwrotnych (np. w przepływach 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;
}

Metody

MetodaZwracany typKrótki opis
createToken()StringKonstruuje zaszyfrowany ciąg znaków reprezentujący token stanu.
withArgument(name, value)StateTokenBuilderDodaje argument do tokena.
withMethod(method)StateTokenBuilderKonfiguruje funkcję wywołania zwrotnego.
withTimeout(seconds)StateTokenBuilderUstawia czas (w sekundach), przez jaki token jest ważny.

Szczegółowa dokumentacja

createToken()

Konstruuje zaszyfrowany ciąg znaków reprezentujący token stanu.

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

Powroty

String – zaszyfrowany ciąg znaków reprezentujący token;


withArgument(name, value)

Dodaje argument do tokena. Tę metodę można wywołać wiele razy.

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

Parametry

NazwaTypOpis
nameStringnazwa argumentu
valueStringwartość argumentu

Powroty

StateTokenBuilder – kreator tokenów stanu na potrzeby łańcuchów.


withMethod(method)

Konfiguruje funkcję wywołania zwrotnego. Wartością domyślną jest funkcja o nazwie callback().

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

Parametry

NazwaTypOpis
methodStringNazwa funkcji wywołania zwrotnego, przedstawiona jako ciąg znaków bez nawiasów i argumentów. Możesz używać funkcji z dołączonych bibliotek, takich jak Library.libFunction1.

Powroty

StateTokenBuilder – kreator tokenów stanu na potrzeby łańcuchów.


withTimeout(seconds)

Ustawia czas (w sekundach), przez jaki token jest ważny. Wartość domyślna to 60 sekund, a maksymalny czas trwania to 3600 sekund (1 godzina).

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

Parametry

NazwaTypOpis
secondsIntegerczas, przez jaki token jest ważny; maksymalna wartość to 3600

Powroty

StateTokenBuilder – kreator tokenów stanu na potrzeby łańcuchów.