Class StateTokenBuilder

StateTokenBuilder

Umożliwia skryptom tworzenie tokenów stanu, które mogą być używane w interfejsach API wywołania zwrotnego (np. w przypadku przepływów 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

MetodaZwracany typKrótki opis
createToken()StringTworzy zaszyfrowany ciąg znaków reprezentujący token stanu.
withArgument(name, value)StateTokenBuilderDodaje argument do tokena.
withMethod(method)StateTokenBuilderUstawia funkcję wywołania zwrotnego.
withTimeout(seconds)StateTokenBuilderUstawia 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 znaków reprezentujący token.

withArgument(name, value)

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

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

Parametry

NazwaTypOpis
nameStringNazwa argumentu.
valueStringWartość argumentu.

Powrót

StateTokenBuilder – narzędzie do tworzenia tokenów stanu do łączenia.

withMethod(method)

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

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

Parametry

NazwaTypOpis
methodStringNazwa funkcji wywołania zwrotnego w postaci ciągu znaków bez nawiasów ani argumentów. Możesz używać funkcji z dołączonych bibliotek, np. Library.libFunction1.

Powrót

StateTokenBuilder – narzędzie do tworzenia tokenów stanu do łączenia.

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). 

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

Parametry

NazwaTypOpis
secondsIntegerCzas ważności tokenu. Maksymalna wartość to 3600.

Powrót

StateTokenBuilder – narzędzie do tworzenia tokenów stanu do łączenia.