Class 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 - أداة إنشاء الرموز المميّزة للحالة، لإنشاء سلاسل