Class StateTokenBuilder

StateTokenBuilder

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

Metoda	Zwracany typ	Krótki opis
createToken()	String	Konstruuje 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()

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

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

Powrót

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

---

withArgument(name, value)

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

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

Parametry

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

Powrót

StateTokenBuilder – kreator tokenów stanu do łańcuchów

---

withMethod(method)

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

var 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 lub . Możesz używać funkcji z uwzględnionych bibliotek, np. Library.libFunction1.

Powrót

StateTokenBuilder – kreator tokenów stanu do łańcuchów

---

withTimeout(seconds)

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

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

Parametry

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

Powrót

StateTokenBuilder – kreator tokenów stanu do łańcuchów