التابع ‎.ajaxSend()‎‎‎ في jQuery

من موسوعة حسوب
اذهب إلى: تصفح، ابحث

‎.ajaxSend( handler )‎

القيمة المعادة

كائن jQuery.

الوصف

يُستخدَم التابع ‎.ajaxSend( handler )‎ في إرفاق دالة لتنفيذها قبل إرسال طلب Ajax، يُعدُّ هذا التّابع حدثًا من أحداث Ajax.

‎.ajaxSend( handler )‎

أضيفت في الإصدار 1.0.

handler

دالة على الشكل ‎Function( Event event, jqXHR jqXHR, PlainObject ajaxOptions )‎، وهي الدالة المطلوب استدعاؤها.

عندما يكون طلب Ajax على وشك أن يُرسَل، تُطلِق jQuery الحدث ajaxSend. تُنفَّذ حينها كافّة مُعالجات الأحداث المُسجَّلة مع التّابع ‎.ajaxSend()‎.

لمشاهدة مثال عملي عن هذا التّابع نُجهِّز طلب بسيط لتحميل Ajax:
<button class="trigger">إطلاق مُعالِج الحدث</button>
<div class="result"></div> <!--تُعرَض هنا النتيجة-->
<div class="log"></div> <!--تُعرَض هنا رسالة السّجل-->
أرفِق مُعالِج الحدث (event handler) إلى المستند:
$( document ).ajaxSend(function() {
 $( ".log" ).text( ".‏ajaxSend‏أُطلِق مُعالِج الحدث ‏" );
});
نفذ الآن طلب Ajax باستخدام أي تابع jQuery:
$( ".trigger" ).click(function() {
 $( ".result" ).load( "ajax/test.html" );
});
عندما يضغط المستخدم على العنصر الذي يمتلك الصنف trigger ويكون طلب Ajax على وشك التنفيذ، ستُعرَض رسالة السّجل. تُستدعى كافة مُعالِجات أحداث ajaxSend قبل إرسال أي طلب Ajax، إن كنت تريد التفريق بين الطلبات فاستخدم المعاملات الممررة لمُعالِج الأحداث، ففي كل مرة يُنفَّذ فيها مُعالِج الحدث ajaxSend يُمرِّر كائن الحدث، والكائن jqXHR (الكائن XMLHttpRequest في الإصدار 1.4)، وكائن الإعدادات الذي استخدم في إنشاء الطلب. بإمكاننا على سبيل المثال حصر الاستدعاء فقط من أجل الأحداث التي تتعامل مع روابط معينة:
$( document ).ajaxSend(function( event, jqxhr, settings ) {
 if ( settings.url == "ajax/test.html" ) {
   $( ".log" ).text( ".‏ajaxSend ‏أُطلِق مُعالِج الحدث" );
 }
});

ملاحظات إضافية

بدءًا من إصدار jQuery 1.9 أصبح إرفاق مُعالِجات الأحداث لأحداث Ajax العامة (jQuery global Ajax events) بالمستند إجباريًّا، بما في ذلك مُعالِجات الأحداث المُضافة عن طريق التّابع ‎.ajaxSend()‎.

إن استدعينا التابع ‎$.ajax()‎ أو ‎$.ajaxSetup()‎ مع تعيين الخيار global إلى القيمة false، فلن يُنفَّذ التّابع ‎.ajaxSend()‎.

أمثلة

إظهار رسالة قبل إرسال طلب Ajax:
$( document ).ajaxSend(function( event, request, settings ) {
 $( "#msg" ).append( "<li>يجري بدء الطلب " + settings.url + "</li>" );
});

مصادر