التابع .ajaxSuccess() في jQuery
.ajaxSuccess( handler )
القيمة المعادة
كائن jQuery.
الوصف
يُستخدَم التابع .ajaxSuccess() لإرفاق دالة لتنفيذها عند اكتمال تنفيذ طلب Ajax، يُعدُّ هذا التّابع حدثًا من أحداث Ajax.
.ajaxSuccess( handler )
أضيفت في الإصدار: 1.0.
handler
دالة على الشكل Function( Event event, jqXHR jqXHR, PlainObject ajaxOptions, PlainObject data )، وهي الدالة المطلوب استدعاؤها.
عندما يكتمل تنفيذ طلب Ajax، تُطلِق jQuery الحدث ajaxSuccess، وتُنفَّذ عندها كافّة مُعالجات الأحداث المُسجَّلة مع التّابع .ajaxSuccess().
لمشاهدة مثال عملي عن هذا التّابع نُجهِّز طلب بسيط لتحميل Ajax:
<button class="trigger">إطلاق مُعالِج الحدث</button>
<div class="result"></div> <!--تُعرَض هنا النتيجة-->
<div class="log"></div> <!--تُعرَض هنا رسالة السّجل-->
أرفِق مُعالِج الحدث (event handler) إلى أي عنصر:
$(document).ajaxSuccess(function() {
$( ".log" ).text( ".ajaxSuccessأُطلِق مُعالِج الحدث " );
});
نفذ الآن طلب Ajax باستخدام أي تابع jQuery:
$( ".trigger" ).on( "click", function() {
$( ".result" ).load( "ajax/test.html" );
});
عندما يضغط المستخدم على العنصر الذي يمتلك الصنف trigger ويكتمل تنفيذ طلب Ajax، ستُعرَض رسالة السّجل.
تُستدعَى كافة مُعالِجات الحدث ajaxSuccess قبل إرسال أي طلب Ajax، إن كنت تريد التفريق بين الطلبات فاستخدم الممررة لمُعالِج الأحداث، ففي كل مرة يُنفَّذ فيها مُعالِج الحدث ajaxSuccess يُمرِّر كائن الحدث، والكائن XMLHttpRequest، وكائن الإعدادات الذي استخدم في إنشاء الطلب. بإمكاننا على سبيل المثال حصر الاستدعاء فقط من أجل الأحداث التي تتعامل مع روابط معينة:
$( document ).ajaxSuccess(function( event, xhr, settings ) {
if ( settings.url == "ajax/test.html" ) {
$( ".log" ).text( "أُطلِق مُعالِج الحدث ajaxSuccess. كانت استجابة Ajax هي" +
xhr.responseText );
}
});
ملاحظة: بإمكاننا الحصول على محتوى Ajax المعاد عن طريق xhr.responseXML أو xhr.responseText وذلك من أجل xml و html على التوالي وبالترتيب.
ملاحظات إضافية
بدءًا من إصدار jQuery 1.9 أصبح إرفاق مُعالِجات الأحداث لأحداث Ajax العامة (jQuery global Ajax events) بالمستند إجباريًّا، بما في ذلك مُعالِجات الأحداث المُضافة عن طريق التّابع .ajaxSuccess().
إن استدعينا التابع $.ajax() أو $.ajaxSetup() مع تعيين الخيار global إلى القيمة false، فلن يُنفَّذ التّابع .ajaxSuccess().
أمثلة
إظهار رسالة عند اكتمال تنفيذ طلب Ajax:
$( document ).ajaxSuccess(function( event, request, settings ) {
$( "#msg" ).append( "<li>طلب ناجح!</li>" );
});