XMLHttpRequest: open() メソッド

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since 2015年7月.

メモ: この機能はウェブワーカー内で利用可能ですが、サービスワーカーでは使用できません。

XMLHttpRequest の open() メソッドは、新しく作成されたリクエストを初期化したり、既存のリクエストを再初期化したりします。

メモ: すでに有効なリクエスト (すでに open() が呼び出されたもの) に対してこのメソッドを呼び出すと、 abort() を呼び出すのと等価になります。

構文

js
open(method, url)
open(method, url, async)
open(method, url, async, user)
open(method, url, async, user, password)

引数

method

使用する HTTP リクエストメソッドです。 "GET", "POST", "PUT", "DELETE" など。 HTTP(S) 以外の URL では無視されます。

url

文字列または文字列化のあるその他のオブジェクト、例えば URL オブジェクトで、リクエストの送信先となる URL を表します。

async 省略可

任意の論理値の引数で、既定値は trueです。操作が非同期的に行われるかどうかを示します。値が false の場合、 send() メソッドはレスポンスを受信するまで戻りません。 true の場合は、トランザクション完了の通知はイベントリスナーを使用して配信されます。 multipart 属性が true である場合は true でなければならず、さもなくば例外が発生します。

メモ: メインスレッドで同期リクエストを行うと、ユーザーの使い勝手を簡単に阻害するので避けるべきです。実際、多くのブラウザーではメインスレッドにおける同期的な XHR の対応を全面的に非推奨としています。同期リクエストはワーカー (Worker) では許可されています。

user 省略可

任意で、認証プロセスで使用するユーザー名です。既定では、これは null 値です。

password 省略可

任意で、認証プロセスで使用するパスワードです。既定では、これは null 値です。