Class StateTokenBuilder

StateTokenBuilder

Komut dosyalarının, geri çağırma API'lerinde (OAuth akışları gibi) kullanılabilecek durum jetonları oluşturmasına izin verir.

// 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;
}

Yöntemler

YöntemDönüş türüKısa açıklama
createToken()StringDurum jetonunun şifrelenmiş bir dize temsilini oluşturur.
withArgument(name, value)StateTokenBuilderJetona bir bağımsız değişken ekler.
withMethod(method)StateTokenBuilderGeri çağırma işlevi ayarlar.
withTimeout(seconds)StateTokenBuilderJetonun geçerli olacağı süreyi (saniye cinsinden) ayarlar.

Ayrıntılı belgeler

createToken()

Durum jetonunun şifrelenmiş bir dize temsilini oluşturur.

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

Return

String: Jetonu temsil eden şifrelenmiş bir dize


withArgument(name, value)

Jetona bir bağımsız değişken ekler. Bu yöntem birden fazla kez çağrılabilir.

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

Parametreler

AdTürAçıklama
nameStringbağımsız değişkenin adı
valueStringbağımsız değişkenin değeri

Return

StateTokenBuilder — zincirleme için durum jetonu oluşturucu


withMethod(method)

Geri çağırma işlevi ayarlar. Varsayılan olarak callback() adlı bir işlev kullanılır.

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

Parametreler

AdTürAçıklama
methodStringParantez veya parantez içermeyen bir dize olarak gösterilen geri çağırma işlevinin adı bağımsız değişkenlerdir. Dahil edilen kitaplıklardaki ( Library.libFunction1 gibi) işlevleri kullanabilirsiniz.

Return

StateTokenBuilder — zincirleme için durum jetonu oluşturucu


withTimeout(seconds)

Jetonun geçerli olacağı süreyi (saniye cinsinden) ayarlar. Varsayılan değer 60 saniyedir; "the" maksimum süre 3.600 saniyedir (1 saat).

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

Parametreler

AdTürAçıklama
secondsIntegerjetonun geçerli olduğu süre; maksimum değer 3600

Return

StateTokenBuilder — zincirleme için durum jetonu oluşturucu