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){
  var url = ScriptApp.getService().getUrl();      // Ends in /exec (for a web app)
  url = url.slice(0, -4) + 'usercallback?state='; // Change /exec to /usercallback
  var stateToken = ScriptApp.newStateToken()
      .withMethod(callbackFunction)
      .withTimeout(120)
      .createToken();
  return url + stateToken;
}

الطُرق

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

الوثائق التفصيلية

createToken()

تنشئ تمثيل سلسلة مشفّر للرمز المميز للحالة.

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

الإرجاع

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

---

withArgument(name, value)

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

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

المعلمات

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

الإرجاع

StateTokenBuilder — أداة إنشاء الرموز المميزة للحالة، للتسلسل

---

withMethod(method)

تعين دالة معاودة الاتصال. والقيمة التلقائية لهذه الدالة هي دالة باسم callback().

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

المعلمات

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

الإرجاع

StateTokenBuilder — أداة إنشاء الرموز المميزة للحالة، للتسلسل

---

withTimeout(seconds)

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

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

المعلمات

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

الإرجاع

StateTokenBuilder — أداة إنشاء الرموز المميزة للحالة، للتسلسل