Урок - .ajaxSuccess()

Группа вКонтакте
Лицензия: Лицензия Creative Commons.

Метод .ajaxSuccess() регистрирует функцию для выполнения во время успешного завершения Ajax-запроса. Метод .ajaxSuccess() является Ajax-событием (Ajax-Event).

Синтаксис метода .ajaxSuccess()

.ajaxSuccess( handler(event, XMLHttpRequest, ajaxOptions, throwError) )

где

  • handler(event, XMLHttpRequest, ajaxOptions, throwError) - функция обратного вызова.
  • event - объект хранящий в себе параметры события.
    Список некоторых параметров:
    • type - будет равняться ajaxSuccess.
    • timeStamp - временнеая метка запроса.
    • target - ссылка на вызывающий DOM-элемент.
  • XMLHttpRequest - XMLHttpRequest-объект.
    Некоторые из свойст XMLHttpRequest-объекта:
    • responseText - содержит полученный текст.
    • status - HTTP-код ответа.
  • ajaxOptions - объект хранящий в себе параметры AJAX-запроса.
    • url - URL-на страницу запроса.
    • type - метод HTTP-запроса.
    • async - синхронный или асинхронный запрос.
    • dataType - ожидаемый формат данных.
  • throwError - информация об исключении, если таковое было.

Метод .ajaxSuccess() возвращает: jQuery-объект.

Внутри метода .ajaxSuccess() ссылка this указывает на объект document.

Описание метода .ajaxSuccess()

Все обработчики зарегистрированные методом .ajaxSuccess() вызываются в случае успешного выполнения любого AJAX-запроса.

Метод .ajaxSuccess() применим только к объекту document:

jQuery(document).ajaxSuccess(function(event, xhr, settings, throwError) {
    ... код обработчика
});