Skip to content

Latest commit

 

History

History
124 lines (98 loc) · 9.06 KB

index.md

File metadata and controls

124 lines (98 loc) · 9.06 KB
title slug l10n
XMLHttpRequest
Web/API/XMLHttpRequest
sourceCommit
c215109b90da51435eaa2c94a8f6764909f628e0

{{APIRef("XMLHttpRequest API")}}

XMLHttpRequest (XHR) オブジェクトは、サーバーと対話するために使用されます。ページ全体を更新する必要なしに、データを受け取ることができます。これでユーザーの作業を中断させることなく、ウェブページの一部を更新することができます。

{{InheritanceDiagram}}

XMLHttpRequest という名前ではあるものの、 XML だけでなく、あらゆる種類のデータを受け取るために使用することができます。

通信においてサーバーからのイベントデータやメッセージデータの受信を含む必要があるのであれば、サーバー送信イベントの {{domxref("EventSource")}} インターフェイスを使用することも検討してください。全二重の通信では、 WebSocket の方が良いかもしれません。

{{AvailableInWorkers("notservice")}}

コンストラクター

  • {{domxref("XMLHttpRequest.XMLHttpRequest", "XMLHttpRequest()")}}
    • : XMLHttpRequest を初期化するコンストラクターです。これは、他のメソッドを呼び出す前に呼び出さなければなりません。

インスタンスプロパティ

このインターフェイスは、 {{domxref("XMLHttpRequestEventTarget")}} および {{domxref("EventTarget")}} のプロパティを継承しています。

  • {{domxref("XMLHttpRequest.readyState")}} {{ReadOnlyInline}}

    • : リクエストの状態を表す数値を返します。

  • {{domxref("XMLHttpRequest.response")}} {{ReadOnlyInline}}

    • : {{jsxref("ArrayBuffer")}}、{{domxref("Blob")}}、{{domxref("Document")}}、JavaScript オブジェクト、文字列の何れか（{{domxref("XMLHttpRequest.responseType")}} の値による）で、リクエストのエンティティ本体を返します。

  • {{domxref("XMLHttpRequest.responseText")}} {{ReadOnlyInline}}

    • : 文字列で、リクエストに対するレスポンスをテキスト形式で返すか、リクエストが失敗した場合や、まだ送信されていない場合は null を返します。

  • {{domxref("XMLHttpRequest.responseType")}}

    • : レスポンスの種類を示します。

  • {{domxref("XMLHttpRequest.responseURL")}} {{ReadOnlyInline}}

    • : レスポンスのシリアライズされた URL、または URL が null であれば空文字列を返します。

  • {{domxref("XMLHttpRequest.responseXML")}} {{ReadOnlyInline}}

    • : {{domxref("Document")}} でリクエストに対するレスポンスが入ったを返すか、またはリクエストが成功しなかった場合、まだ送信されていない場合、 XML または HTML として解釈できなかった場合は null を返します。ウェブワーカーでは利用できません。

  • {{domxref("XMLHttpRequest.status")}} {{ReadOnlyInline}}

  • {{domxref("XMLHttpRequest.statusText")}} {{ReadOnlyInline}}

    • : 文字列で、HTTP サーバーから返ってきたレスポンス文字列を返します。 {{domxref("XMLHttpRequest.status")}} とは異なり、（"OK" のような）レスポンスメッセージの完全な文が含まれています。

      [!NOTE] HTTP/2 仕様書 {{RFC(7540, "Response Pseudo-Header Fields", "8.1.2.4")}} によれば、 HTTP/2 では、 HTTP/1.1 のステータス行に含まれていたバージョンや原因の文を伝える方法が定義されていません。

  • {{domxref("XMLHttpRequest.timeout")}}

    • : リクエストを自動的に終了するまでの時間をミリ秒単位で表します。

  • {{domxref("XMLHttpRequest.upload")}} {{ReadOnlyInline}}

    • : {{domxref("XMLHttpRequestUpload")}} で、アップロードプロセスを表します。

  • {{domxref("XMLHttpRequest.withCredentials")}}

    • : サイト間の Access-Control リクエストでクッキーや認証ヘッダーなどの資格情報を使用する場合は true を返します。そうでなければ false を返します。

標準外のプロパティ

  • {{domxref("XMLHttpRequest.channel")}} {{ReadOnlyInline}}
    • : リクエストの実行の際にオブジェクトによって使われるチャンネルです。
  • {{domxref("XMLHttpRequest.mozAnon")}} {{ReadOnlyInline}}
    • : 論理値です。 true の場合、リクエストを Cookie や認証ヘッダーを伴わずに送信します。
  • {{domxref("XMLHttpRequest.mozSystem")}} {{ReadOnlyInline}}
    • : 論理値です。 true の場合、リクエストで同一オリジンポリシーは適用されません。
  • {{domxref("XMLHttpRequest.mozBackgroundRequest")}}
    • : 論理値です。このオブジェクトがバックグラウンドサービスのリクエストを表しているかどうかを示します。

インスタンスメソッド

  • {{domxref("XMLHttpRequest.abort()")}}
    • : リクエストがすでに送信されている場合、リクエストを中止します。
  • {{domxref("XMLHttpRequest.getAllResponseHeaders()")}}
    • : すべてのレスポンスヘッダーを、 {{Glossary("CRLF")}} で区切り、文字列として返します。レスポンスを何も受け取らなかった場合は null を返します。
  • {{domxref("XMLHttpRequest.getResponseHeader()")}}
    • : 指定したヘッダーを含む文字列を返します。レスポンスを受信していない、またはレスポンス内に指定したヘッダーが存在しない場合は null を返します。
  • {{domxref("XMLHttpRequest.open()")}}
    • : リクエストを初期化します。
  • {{domxref("XMLHttpRequest.overrideMimeType()")}}
    • : サーバーから返ってくる MIME タイプを上書きします。
  • {{domxref("XMLHttpRequest.send()")}}
    • : リクエストを送信します。このリクエストが非同期（既定）の場合、このメソッドはリクエストが送るとすぐに返ります。
  • {{domxref("XMLHttpRequest.setRequestHeader()")}}
    • : HTTP リクエストヘッダーの値を設定します。 setRequestHeader() は {{domxref("XMLHttpRequest.open", "open()")}} の後、および {{domxref("XMLHttpRequest.send", "send()")}} の前に呼び出さなくてはいけません。

イベント

  • {{domxref("XMLHttpRequest/abort_event", "abort")}}
    • : 例えばプログラムが {{domxref("XMLHttpRequest.abort()")}} を呼び出した時など、リクエストが中断されたときに発生します。 onabort イベントハンドラープロパティを通して利用することもできます。
  • {{domxref("XMLHttpRequest/error_event", "error")}}
    • : リクエストでエラーが発生したときに発生します。 onerror イベントハンドラープロパティを通して利用することもできます。
  • {{domxref("XMLHttpRequest/load_event", "load")}}
    • : XMLHttpRequest のトランザクションが成功裏に完了したときに発生します。 onload イベントハンドラープロパティを通して利用することもできます。
  • {{domxref("XMLHttpRequest/loadend_event", "loadend")}}
    • : リクエストが完了したときに、成功した場合（{{domxref("XMLHttpRequest/load_event", "load")}} の後）、成功しなかった場合（{{domxref("XMLHttpRequest/abort_event", "abort")}} または {{domxref("XMLHttpRequest/error_event", "error")}} の後）のどちらでも発生します。 onloadend イベントハンドラープロパティを通して利用することもできます。
  • {{domxref("XMLHttpRequest/loadstart_event", "loadstart")}}
    • : リクエストがデータを読み込み始めたときに発生します。 onloadstart イベントハンドラープロパティを通して利用することもできます。
  • {{domxref("XMLHttpRequest/progress_event", "progress")}}
    • : リクエストがもっとデータを受信した際に定期的に発生します。 onprogress イベントハンドラープロパティを通して利用することもできます。
  • {{domxref("XMLHttpRequest/readystatechange_event", "readystatechange")}}
    • : {{domxref("XMLHttpRequest.readyState", "readyState")}} プロパティが変化するたびに発生します。 onreadystatechange イベントハンドラープロパティを通して利用することもできます。
  • {{domxref("XMLHttpRequest/timeout_event", "timeout")}}
    • : プリセット時間が過ぎたために進行が終了したときに発生します。 ontimeout イベントハンドラープロパティを通して利用することもできます。

仕様書

{{Specifications}}

ブラウザーの互換性

{{Compat}}

関連情報