2019.01.27
jQuery APIリファレンス .ajaxSuccess()
説明
Ajaxリクエストが正常終了したときに実行される関数をアタッチします。これはAjaxイベントです。
Ajaxリクエストが正常終了するたびにjQueryはajaxSuccessイベントをキックします。この時点で、ajaxSuccess()メソッドで登録されている全てのハンドラが実行されます。
どのAjaxリクエストが完了したかにかかわらず、全てのajaxSuccessハンドラが呼び出されます。リクエストを識別したい場合は、ハンドラに渡されたパラメータを使用します。ajaxSucessハンドラが実行されるたびに、Eventオブジェクト、XMLHttpRequestオブジェクト、settingsオブジェクトがパラメータとして渡されます。
たとえば、特定のURLを扱うイベントのみ処理するようにコールバックを制限することができます。
<script>
$( document ).ajaxSuccess(function( event, xhr, settings ) {
if ( settings.url == "ajax/test.html" ) {
$( ".log" ).text( "Triggered ajaxSuccess handler. The Ajax response was: " +
xhr.responseText );
}
});
</script>
シグネチャ
-
.ajaxStop( handler )
追加version 1.0 引数:型 handler:Function( Event event, jqXHR jqXHR, PlainObject ajaxOptions, PlainObject data )
注意事項
- jQuery 1.9現在、ajaxSuccessメソッドに追加されたものも含め全てのjQueryグローバルAjaxイベントをdocumentにアタッチしなければいけません。
- globalオプションをfalseにして$.ajax()や$.ajaxSetup()が呼び出されると$.ajaxSuccess()メソッドはキックされません。
サンプル1
Ajaxリクエストが正常終了したときにメッセージが表示されます。
<script>
$( document ).ajaxSuccess(function( event, request, settings ) {
$( "#msg" ).append( "<li>Successful Request!</li>" );
});
</script>
