タイトル: $.ajax()
$.ajax()
・Ajaxリクエストを送信するオプションをキーと値のペアで指定する。
このオプションに初期値を設定したい場合は、 $.ajaxSetup()を使用する。
■.ajax( url[, settings] )
戻り値:jqXHR
| 引数 | 説明 |
|---|---|
| url | Ajaxリクエストを送信するURLを指定 |
| [settings] | 通信時の設定パラメーター(「パラメーター名: 値」のハッシュ) |
引数settingsでは以下のパラメータが利用可能。
| 分類 | パラメーター名 | 概要 |
|---|---|---|
| 基本 | type |
通信に利用するHTTPメソッド 型:String 初期値:'GET' リクエストのタイプ("POST"または"GET")を指定 |
| dataType |
応答データの種類 型:String 初期値:xml,json,script,htmlからjQueryがMIME typeを元に判別 |
|
| data |
サーバへ送信するデータ 型:PlainObjectまたはString |
|
| headers |
リクエスト時に送信するヘッダー 型:PlainObject 初期値:{} |
|
| コールバック | beforeSend |
リクエスト送信前に実行されるコールバック関数 型:Function( jqXHR jqXHR, PlainObject settings ) |
| converters |
dataTypeオプション単位のコンバーター 型:PlainObject |
|
| dataFilter |
レスポンスデータを処理するためのコールバック関数 型:Function( String data, String type ) => Object |
|
| 設定 | accepts |
期待する応答のデータ型 型:PlainObject 初期値:DataTypeに依存 |
| cache |
通信結果をキャッシュするか否か 型:Boolean |
|
| contentType |
リクエスト時に利用するContent-Typeヘッダー 型:String 初期値:'application/x-www-form-urlencoded; charset=UTF-8' |
|
| context |
コールバック関数のコンテキスト 型:Object |
|
| crossDomain |
クロスドメインのリクエストか否か 型:Boolean |
|
| global |
$.ajaxXxxxxイベントを処理するか否か 型:Boolean 初期値:true |
|
| ifModified |
trueの場合、応答に変更がある場合にだけ成功ステータスを返す 型:Boolean 初期値:false |
|
| jsonp |
JSONPリクエストのコールバック関数名 型:String |
|
| processData |
dataパラメーターの内容をクエリ情報に変換するか否か 型:Boolean 初期値:true |
|
| scriptCharset |
スクリプトを読み込む際に利用する文字コード(dataType=が"script"や"jsonp"などの場合のみ使用できる) 型:String |
|
| timeout |
タイムアウト時間 型:Number |
|
| xhrFields |
ネイティブなXMLHttpRequestオブジェクトに設定するフィールド値 型:PlainObject |
|
| 認証 | username |
認証時に利用するユーザー名 型:String |
| password |
認証時に利用するパスワード 型:String |