Class StateTokenBuilder

StateTokenBuilder

Umożliwia skryptom tworzenie tokenów stanu, które można używać w interfejsach wywołania zwrotnego (np. w procesach 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;
}

Metody

Metoda	Zwracany typ	Krótki opis
createToken()	String	Tworzy zaszyfrowany ciąg znaków reprezentujący token stanu.
withArgument(name, value)	StateTokenBuilder	Dodaje argument do tokena.
withMethod(method)	StateTokenBuilder	Ustawia funkcję wywołania zwrotnego.
withTimeout(seconds)	StateTokenBuilder	Ustawia czas (w sekundach), przez jaki token jest ważny.

Szczegółowa dokumentacja

createToken()

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

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

Powrót

String – zaszyfrowany ciąg reprezentujący token

---

withArgument(name, value)

Dodaje argument do tokena. Metodę tę można wywołać wielokrotnie.

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

Parametry

Nazwa	Typ	Opis
name	String	nazwa argumentu.
value	String	wartość argumentu.

Powrót

StateTokenBuilder – kreator tokena stanu do łańcuchowania

---

withMethod(method)

Ustawia funkcję wywołania zwrotnego. Domyślnie jest to funkcja o nazwie callback().

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

Parametry

Nazwa	Typ	Opis
method	String	Nazwa funkcji wywołania zwrotnego, reprezentowana jako ciąg znaków bez nawiasów ani argumentów. Możesz używać funkcji z dołączonych bibliotek, takich jak Library.libFunction1.

Powrót

StateTokenBuilder – kreator tokena stanu do łańcuchowania

---

withTimeout(seconds)

Ustawia czas (w sekundach), przez jaki token jest ważny. Domyślny czas to 60 sekund, a maksymalny – 3600 sekund (1 godzina).

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

Parametry

Nazwa	Typ	Opis
seconds	Integer	czas ważności tokenu; maksymalna wartość to 3600

Powrót

StateTokenBuilder – kreator tokena stanu do łańcuchowania