.on( "ajaxError", handler )Returns: jQuery
Description: Register a handler to be called when Ajax requests complete with an error. This is an Ajax Event.
-
version added: 1.7.on( "ajaxError", handler )
-
"ajaxError"Type: stringThe string
"ajaxError"
. -
handlerThe function to be invoked.
-
This page describes the ajaxError
event. For the deprecated .ajaxError()
method, see .ajaxError()
.
Whenever an Ajax request completes with an error, jQuery triggers the ajaxError
event. Any and all registered ajaxError
handlers are executed at this time. Note: This handler is not called for cross-domain script and cross-domain JSONP requests.
To observe this method in action, set up a basic Ajax load request.
1
2
3
|
|
Attach the event handler to the document:
1
2
3
|
|
Now, make an Ajax request using any jQuery method:
1
2
3
|
|
When the user clicks the button and the Ajax request fails, because the requested file is missing, the log message is displayed.
All ajaxError
handlers are invoked, regardless of what Ajax request was completed. To differentiate between the requests, use the parameters passed to the handler. Each time an ajaxError
handler is executed, it is passed the event object, the jqXHR
object (prior to jQuery 1.5, the XHR
object), and the settings object that was used in the creation of the request. When an HTTP error occurs, the fourth argument (thrownError
) receives the textual portion of the HTTP status, such as "Not Found" or "Internal Server Error." For example, to restrict the error callback to only handling events dealing with a particular URL:
1
2
3
4
5
|
|
Additional Notes:
-
As of jQuery 1.9, all the handlers for the jQuery global Ajax events, including those added with
.on( "ajaxError", ... )
, must be attached todocument
. -
If
$.ajax()
or$.ajaxSetup()
is called with theglobal
option set tofalse
, theajaxError
event will not fire.
Example:
Show a message when an Ajax request fails.
1
2
3
|
|