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();

المَعلمات

الاسم	النوع	الوصف
name	String	اسم الوسيطة
value	String	قيمة الوسيطة

الإرجاع

StateTokenBuilder — أداة إنشاء رمز الحالة المميّز، من أجل الربط بين الطرق

---

withMethod(method)

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

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

المَعلمات

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

الإرجاع

StateTokenBuilder — أداة إنشاء رمز الحالة المميّز، من أجل الربط بين الطرق

---

withTimeout(seconds)

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

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

المَعلمات

الاسم	النوع	الوصف
seconds	Integer	المدة التي يكون خلالها الرمز المميّز صالحًا، والحد الأقصى للقيمة هو 3600

الإرجاع

StateTokenBuilder — أداة إنشاء رمز الحالة المميّز، من أجل الربط بين الطرق