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 یک تابع فراخوانی (callback) تنظیم می‌کند.
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 نام تابع فراخوانی، که به صورت یک رشته بدون پرانتز یا آرگومان نمایش داده می‌شود. می‌توانید از توابع موجود در کتابخانه‌های موجود، مانند Library.libFunction1 ، استفاده کنید.

بازگشت

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

with Timeout(seconds)

مدت زمان اعتبار توکن (به ثانیه) را تنظیم می‌کند. مقدار پیش‌فرض ۶۰ ثانیه است؛ حداکثر مدت زمان ۳۶۰۰ ثانیه (۱ ساعت) می‌باشد.

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

پارامترها

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

بازگشت

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