Class StateTokenBuilder

StateTokenBuilder

تسمح للبرامج النصية بإنشاء رموز مميّزة للحالة يمكن استخدامها في واجهات برمجة التطبيقات الخاصة بوظائف معاودة الاتصال (مثل مسارات 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;
}

الطُرق

الطريقةنوع القيمة التي تم إرجاعهاوصف قصير
createToken()Stringتنشئ هذه الدالة تمثيلاً مشفَّرًا للرمز المميّز للحالة.
withArgument(name, value)StateTokenBuilderيضيف هذا الإجراء وسيطة إلى الرمز المميّز.
withMethod(method)StateTokenBuilderتضبط هذه السمة دالة رد اتصال.
withTimeout(seconds)StateTokenBuilderتضبط هذه السمة المدة (بالثواني) التي يكون فيها الرمز المميز صالحًا.

مستندات تفصيلية

createToken()

تنشئ هذه الدالة تمثيلاً مشفَّرًا للرمز المميّز للحالة.

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

الإرجاع

String: سلسلة مشفّرة تمثّل الرمز المميّز.


withArgument(name, value)

يضيف هذا الإجراء وسيطة إلى الرمز المميّز. يمكن استدعاء هذه الطريقة عدة مرات.

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

المعلمات

الاسمالنوعالوصف
nameStringتمثّل هذه السمة اسم الوسيط.
valueStringتمثّل هذه السمة قيمة الوسيطة.

الإرجاع

StateTokenBuilder: أداة إنشاء الرموز المميزة للحالة، وذلك لربطها بسلسلة.


withMethod(method)

تضبط هذه السمة دالة رد اتصال. القيمة التلقائية هي دالة باسم callback().

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

المعلمات

الاسمالنوعالوصف
methodStringاسم دالة رد الاتصال، ويتم تمثيله كسلسلة بدون أقواس أو وسيطات. يمكنك استخدام دوال من المكتبات المضمّنة، مثل Library.libFunction1.

الإرجاع

StateTokenBuilder: أداة إنشاء الرموز المميزة للحالة، وذلك لربطها بسلسلة.


withTimeout(seconds)

تضبط هذه السمة المدة (بالثواني) التي يكون فيها الرمز المميز صالحًا. المدة التلقائية هي 60 ثانية، والحد الأقصى للمدة هو 3600 ثانية (ساعة واحدة).

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

المعلمات

الاسمالنوعالوصف
secondsIntegerمدة صلاحية الرمز المميز، والحد الأقصى للقيمة هو 3600.

الإرجاع

StateTokenBuilder: أداة إنشاء الرموز المميزة للحالة، وذلك لربطها بسلسلة.