google.script.history
هي واجهة برمجة تطبيقات JavaScript غير متزامنة من جهة العميل يمكنها التفاعل.
باستخدام مكدس سجل المتصفح. لا يمكن استخدامها إلا في سياق تطبيق ويب يستخدم
IFRAME
وهو غير مخصص للاستخدام مع الأشرطة الجانبية ومربعات الحوار في أي وظيفة إضافية أو
سياق الحاوية النصية. لمزيد من المعلومات، يُرجى الاطّلاع على
دليل استخدام المتصفّح
السجلّ في تطبيقات الويب.
الطُرق
الطريقة | نوع الإرجاع | وصف قصير |
---|---|---|
push(stateObject, params, hash) |
void |
إرسال كائن الحالة ومعلمات عنوان URL وجزء عنوان URL إلى سجلّ المتصفّح حزمة. |
replace(stateObject, params, hash) |
void |
لاستبدال الحدث الرئيسي في حزمة سجلّ المتصفّح بعنصر الحالة المقدَّم، عنوان URL المعلمات وجزء عنوان URL. |
setChangeHandler(function) |
void |
تضبط دالة معاودة الاتصال للاستجابة للتغييرات في سجلّ المتصفّح. |
الوثائق التفصيلية
push(stateObject, params, hash)
إرسال كائن الحالة ومعلمات عنوان URL وجزء عنوان URL إلى سجلّ المتصفّح حزمة. كائن الحالة هو كائن JavaScript بسيط يحدده المطور ويمكن سيحتوي على أي بيانات ذات صلة بالحالة الحالية للتطبيق. تشبه هذه الطريقة طريقة pushState() JavaScript.
Index.html
var now = new Date(); var state = { 'timestamp': now.getTime() }; var params = { 'options': "none" }; google.script.history.push(state, params, "anchor1");
المعلمات
الاسم | النوع | الوصف |
---|---|---|
stateObject | Object | كائن محدد بواسطة المطوّر يجب أن يكون والمرتبط بحدث سجل المتصفح، والذي يظهر مرة أخرى عند تمييز الحالة. السعر المعتاد يُستخدم لتخزين معلومات حالة التطبيق (مثل بيانات الصفحة) لاستردادها في المستقبل. |
params | Object | كائن يحتوي على معلمات عناوين URL
المرتبطة بهذه الحالة. على سبيل المثال، تساوي {foo: “bar”, fiz: “baz”}
"?foo=bar&fiz=baz" بدلاً من ذلك، يمكن استخدام الصفائف:
تساوي {foo: [“bar”, “cat”], fiz: “baz”} "?foo=bar&foo=cat&fiz=baz" .
إذا كانت القيم فارغة أو غير محدّدة، لن تتغيّر مَعلمات عناوين URL الحالية. إذا كانت فارغة، سيتم ضبط معلَمات عناوين URL
تم محوها.
|
hash | String | ظهور جزء عنوان URL للسلسلة بعد الصف الحرف. إذا كانت القيمة فارغة أو غير محددة، لن يتغير الجزء الحالي من عنوان URL. إذا كانت فارغة، سيتم تم محو جزء عنوان URL. |
replace(stateObject, params, hash)
يستبدل الحدث الرئيسي في حزمة سجلّ المتصفّح بالحالة المقدّمة (من تحديد المطوّر). ومعلمات عنوان URL وجزء عنوان URL. يعد هذا مطابقًا push().
Index.html
var now = new Date(); var state = { 'timestamp': now.getTime() }; var params = { 'options': "none" }; google.script.history.replace(state, params, "anchor1");
المعلمات
الاسم | النوع | الوصف |
---|---|---|
stateObject | Object | كائن محدد بواسطة المطوّر يجب أن يكون والمرتبط بحدث سجل المتصفح، والذي يظهر مرة أخرى عند تمييز الحالة. السعر المعتاد يُستخدم لتخزين معلومات حالة التطبيق (مثل بيانات الصفحة) لاستردادها في المستقبل. |
params | Object | كائن يحتوي على معلمات عناوين URL
المرتبطة بهذه الحالة. على سبيل المثال، تساوي {foo: “bar”, fiz: “baz”}
"?foo=bar&fiz=baz" بدلاً من ذلك، يمكن استخدام الصفائف:
تساوي {foo: [“bar”, “cat”], fiz: “baz”} "?foo=bar&foo=cat&fiz=baz" .
إذا كانت القيم فارغة أو غير محدّدة، لن تتغيّر مَعلمات عناوين URL الحالية. إذا كانت فارغة، سيتم ضبط معلَمات عناوين URL
تم محوها.
|
hash | String | ظهور جزء عنوان URL للسلسلة بعد الصف الحرف. إذا كانت القيمة فارغة أو غير محددة، لن يتغير الجزء الحالي من عنوان URL. إذا كانت فارغة، سيتم تم محو جزء عنوان URL. |
setChangeHandler(function)
تضبط وظيفة معاودة الاتصال للاستجابة للتغييرات في سجلّ المتصفّح. دالة رد الاتصال يجب أن يتم استخدام كائن حدث واحد فقط كوسيطة.
Index.html
google.script.history.setChangeHandler(function (e) { console.log(e.state); console.log(e.location.parameters); console.log(e.location.hash); // Adjust web app UI to match popped state here... });
المعلمات
الاسم | النوع | الوصف |
---|---|---|
function | Function | جانب العميل لتشغيلها عند حدث تغيير السجل، باستخدام event object كوسيطة وحيدة. |
كائن الحدث
الحقول | |
---|---|
e.state |
عنصر الحالة المرتبط بالحدث الذي تم تمييزه وهذا العنصر مماثل للحالة الذي يُستخدم في الدالة push() المقابلة أو replace() الذي أضاف حالة انبثاق إلى مكدس التاريخ. {"page":2, "name":"Wilbur"} |
e.location |
عنصر موقع المرتبط بالحدث المفرقع {"hash":"", "parameter":{"name": "alice", "n": "1"}, "parameters":{"name": ["alice"], "n": ["1", "2"]}} |