SYNCERのロゴ
アイキャッチ画像

XMLHttpRequestUpload - ajax通信のアップロード

XMLHttpRequestUploadは、ajax通信のアップロード時の情報を管理するための機能を備えたインターフェイスです。専ら、イベントを設定するためにあります。アップロードとは、クライアント側からサーバー側への通信を指し、POSTメソッドのリクエストでパラメータやBlobを送信する時に発生します。GETメソッドの通信では発生しません。

概要

名前
XMLHttpRequestUpload
継承
IDL
[Exposed=(Window,DedicatedWorker,SharedWorker)]
interface XMLHttpRequestUpload : XMLHttpRequestEventTarget {
};
仕様書
https://xhr.spec.whatwg.org/#xmlhttprequestupload

チュートリアル

XMLHttpRequestUploadは、XMLHttpRequest.uploadが返します。

var xmlHttpRequest = new XMLHttpRequest() ;
var xmlHttpRequestUpload = xmlHttpRequest.upload ;

XMLHttpRequestUploadは、固有のプロパティやメソッドを持ちません。XMLHttpRequestEventTargetを継承しており、そのイベントハンドラを利用できます。アップロード時にイベントを設定したい場合に利用するためのインターフェイスです。

xmlHttpRequestUpload.onloadstart = callbackFn ;
xmlHttpRequestUpload.onload = callbackFn ;
xmlHttpRequestUpload.onloadend = callbackFn ;
xmlHttpRequestUpload.onprogress = callbackFn ;
xmlHttpRequestUpload.onerror = callbackFn ;
xmlHttpRequestUpload.ontimeout = callbackFn ;
xmlHttpRequestUpload.onabort = callbackFn ;

デモ

ボタンをクリックすると、"hoge=1"というデータをPOSTメソッドで送信します。送信先はここのページで、送信しても特に何も起こりません。ここではイベントが発生することを確かめて下さい。

<!-- このコードは編集できます。 -->

<!DOCTYPE html>
<html>
<head>
<style>
body { word-break: break-all ; tab-size: 2 ; }
div#result { white-space: pre-wrap ; }
</style>
</head>
<body>
<p><button id="send">通信 [send()]</button></p>
<hr>
<img src="" id="hoge" width="120" height="auto">
<hr>
<div id="result"></div>
<script>
var xmlHttpRequest = new XMLHttpRequest() ;
var xmlHttpRequestUpload = xmlHttpRequest.upload ;

xmlHttpRequestUpload.onloadstart = function ( event ) {
	appendText( "[loadstart] アップロードを開始しました!!" + "\n" ) ;
}

xmlHttpRequestUpload.onprogress = function ( event ) {
	appendText( "[progress] アップロード中…" + "\n" ) ;
}

xmlHttpRequestUpload.onload = function ( event ) {
	appendText( "[load] アップロードが正常に完了しました!!" + "\n" ) ;
}

xmlHttpRequestUpload.onloadend = function ( event ) {
	appendText( "[loadend] アップロードを終了しました!!" + "\n" ) ;
}

document.getElementById( "send" ).onclick = function () {
	xmlHttpRequest.open( "POST", "./" ) ;
	xmlHttpRequest.send( "hoge=1" ) ;
}

function appendText ( text ) {
	document.getElementById( "result" ).appendChild( document.createTextNode( text ) ) ;
}
</script>
</body>
</html>

コンストラクタ

コンストラクタはありません。

プロパティ

固有のプロパティはありません。

メソッド

固有のメソッドはありません。

定数

固有の定数はありません。

イベント

固有のイベントハンドラはありません。

サポート状況

クリックすると、バージョンごとの対応状況を確認できます。

ChromeFirefoxSafariEdgeIEOperaiOS SafariAndroid
10+ 15+
  • Twitterでシェア
  • Facebookでシェア
  • Google+でシェア
  • はてなブックマークでシェア
  • pocketに保存
  • LINEでシェア
更新履歴
2017年10月20日 (金)
コンテンツを公開しました。