Class StateTokenBuilder

ایالت توکن ساز

به اسکریپت‌ها اجازه می‌دهد تا توکن‌های حالت ایجاد کنند که می‌توانند در APIهای برگشت تماس (مانند جریان‌های 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;
}

روش ها

روش نوع برگشت شرح مختصر
create Token() String یک نمایش رشته رمزگذاری شده از نشانه حالت می سازد.
with Argument(name, value) State Token Builder یک آرگومان به توکن اضافه می کند.
with Method(method) State Token Builder یک عملکرد برگشت به تماس را تنظیم می کند.
with Timeout(seconds) State Token Builder مدت زمانی (بر حسب ثانیه) که توکن برای آن معتبر است را تنظیم می کند.

مستندات دقیق

create Token()

یک نمایش رشته رمزگذاری شده از نشانه حالت می سازد.

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

بازگشت

String - یک رشته رمزگذاری شده که نشان دهنده رمز است

with Argument(name, value)

یک آرگومان به توکن اضافه می کند. این روش را می توان چندین بار فراخوانی کرد.

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

پارامترها

نام تایپ کنید توضیحات
name String نام استدلال
value String ارزش استدلال

بازگشت

State Token Builder - سازنده توکن ایالتی، برای زنجیره زدن

with Method(method)

یک عملکرد برگشت به تماس را تنظیم می کند. پیش فرض تابعی به نام callback() است.

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

پارامترها

نام تایپ کنید توضیحات
method String نام تابع callback که به صورت رشته ای بدون پرانتز یا آرگومان نمایش داده می شود. می توانید از توابع کتابخانه های موجود مانند Library.libFunction1 استفاده کنید.

بازگشت

State Token Builder - سازنده توکن ایالتی، برای زنجیره زدن

with Timeout(seconds)

مدت زمانی (بر حسب ثانیه) که توکن برای آن معتبر است را تنظیم می کند. پیش فرض 60 ثانیه است. حداکثر مدت زمان 3600 ثانیه (1 ساعت) است.

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

پارامترها

نام تایپ کنید توضیحات
seconds Integer مدت زمانی که رمز معتبر است؛ حداکثر مقدار 3600 است

بازگشت

State Token Builder - سازنده توکن ایالتی، برای زنجیره زدن