يسمح هذا الإذن للنصوص البرمجية بإنشاء رموز مميّزة للحالة يمكن استخدامها في واجهات برمجة تطبيقات معاودة الاتصال (مثل تدفقات 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();
المَعلمات
الاسم | Type | الوصف |
---|---|---|
name | String | اسم الوسيطة |
value | String | قيمة الوسيطة |
استرجاع الكرة
StateTokenBuilder
: أداة إنشاء الرموز المميّزة للحالة، للسلاسل
withMethod(method)
لضبط دالة رد اتصال. الدالة التلقائية هي دالة باسم callback()
.
var stateToken = ScriptApp.newStateToken().withMethod('myCallback').createToken();
المَعلمات
الاسم | Type | الوصف |
---|---|---|
method | String | تمثّل هذه السمة اسم دالة رد الاتصال، ويتم تمثيله كسلسلة بدون أقواس أو وسيطات. يمكنك استخدام الدوال من المكتبات المضمّنة، مثل
Library.libFunction1 . |
استرجاع الكرة
StateTokenBuilder
: أداة إنشاء الرموز المميّزة للحالة، للسلاسل
withTimeout(seconds)
لضبط المدة (بالثواني) التي يكون الرمز المميّز صالحًا لها. الإعدادات الافتراضية هي 60 ثانية؛ وأقصى مدة هي 3600 ثانية (ساعة واحدة).
var stateToken = ScriptApp.newStateToken().withTimeout(60).createToken();
المَعلمات
الاسم | Type | الوصف |
---|---|---|
seconds | Integer | المدة التي يكون فيها الرمز المميز صالحًا؛ الحد الأقصى للقيمة هو 3600 |
استرجاع الكرة
StateTokenBuilder
: أداة إنشاء الرموز المميّزة للحالة، للسلاسل