1.0.0.0以上

説明

ファイルのダウンロードを開始する。

ファイルをダウンロードするには、サーバーに存在する対象のパス情報を得る必要がありますが、仮想ファイルの属性を使用する。

デフォルトでは、ダウンロードできる仮想ファイルは1つだけです。したがって、フラグに一致するターゲットのうち、最初のファイルのみがダウンロードされます。もし複数のファイルのダウンロード（1.1.0.0からサポート）をしたい場合はuseMDパラメータをtrueに設定すると、複数のファイルのダウンロード方法で処理がされ、flagに合うターゲットの両方が順次ダウンロードされる。

ダウンロードはしたい仮想ファイルは必ずdownUrl属性にダウンロードすることができ、サーバー側アドレスが設定されなければならない。（1.4.1.0バージョンからurl属性でも可能である。）

ターゲットパスは、サーバーの機能を使用して、必ずContent-dispositionレスポンスヘッダの値がattachment状態であるように設定する必要がある。

ファイルダウンロードの場合、ターゲットが存在するかどうかを判断するためにHEADメソッドリクエストが送信され、HTTPレスポンスコードがエラーでなければ、ダウンロードが再度実行されます。

<script>
  function onDX5Created(id) {
    var dx = dx5.get(id);
    // ダウンロードパス情報がなくてダウンロードすることができない、仮想ファイルである。
    dx.addVirtualFile({ vindex: "IDX0001", name: "virtual_file.txt", size: 12345 });
    // ダウンロードパスがあればダウンロードすることができる。
    dx.addVirtualFile({ vindex: "IDX0003", name: "bridge_509147.jpg", size: 509147, downUrl: "http://domain/path/common-download.do?key=FID0001" });
  }
  function download(id) {
    // フラグの値に基づいてダウンロードを実行する。
    // AUTO：最初の仮想ファイルをダウンロードする。
    // SELECTED：選択された対象の中の最初の仮想ファイルをダウンロードする。
    // CHECKED：チェックされた対象の中の最初の仮想ファイルをダウンロードする。
    dx5.get(id).download("AUTO");
  }
  function multidownload(id) {
    // フラグの値に基づいてダウンロードを実行する。
    // AUTO：すべての仮想ファイルのエントリをダウンロードする。   
    // SELECTED：選択された仮想ファイルのエントリのすべてをダウンロードする。
    // CHECKED：チェックされた仮想ファイルのエントリのすべてをダウンロードする。
    dx5.get(id).download("AUTO", true);
  }
</script>
<button type="button" onclick="download('component-id');">単一ファイルのダウンロード</button>
<button type="button" onclick="multidownload('component-id');">複数のファイルをダウンロード</button>

ダウンロード方法をご利用の場合、バージョン1.0.0.0との違いがあります。単一ファイルのダウンロードの場合は、1.0.0.0のバージョンでは、flagの値に対応する対象がdownUrlが明示がされていない場合は、ダウンロードがキャンセルになったが、1.1.0.0のバージョンでは、flagの値に対応する対象がdownUrlが明示がされていない場合は、次の適切な対象を探す。したがって、正確に指定された対象をダウンロードするには、downloadはなくdownloadByIdを使用することをお勧めします。

バージョン1.1.0.0で追加されたマルチファイルダウンロード機能は、プラグイン技術を使用せず、純粋にブラウザの機能として実装されています。プラグインを使用したダウンロードのように、進行状況ウィンドウを提供はするが、ブラウザが最終的にファイルを保存する段階（製品が関与することはできない）が存在するため、ダウンロードが完了した場合でも、ブラウザでクエリするメッセージが表示されることがている。また、macOSでは、Safariブラウザのバージョン10.1以上のみをサポートしています。また、iOSおよびiPadでは、Safariブラウザのバージョン17以降がマルチファイルダウンロード（10ファイル以下）をサポートしています。

<script>
  function onDX5Created(id) {
    var dx = dx5.get(id);
    // ダウンロードパス情報がなくてダウンロードすることができない、仮想ファイルである。
    dx.addVirtualFile({ vindex: "IDX0001", name: "virtual_file.txt", size: 12345 });
    // ダウンロードパスがあればダウンロードすることができる。
    dx.addVirtualFile({ vindex: "IDX0003", name: "bridge_509147.jpg", size: 509147, url: "http://domain/path/common-download.do?key=FID0001" });
  }
  function download(id) {
    // フラグの値に基づいてダウンロードを実行する。
    // AUTO：すべての仮想ファイルのエントリをダウンロードする。
    // SELECTED：選択された仮想ファイルのエントリのすべてをダウンロードする。
    // CHECKED：チェックされた仮想ファイルのエントリのすべてをダウンロードする。
    dx5.get(id).download("AUTO");
  }
</script>
<button type="button" onclick="download('component-id');">ダウンロード</button>

形式

// 1.1.0.0以上
object.download(flag[, useMD]);

パラメータ

1.0.0.0以上

説明

指定された一意のIDに対応する仮想ファイルをダウンロードする。

ファイルをダウンロードするには、サーバーに存在する対象のパス情報を得る必要がありますが、仮想ファイルの属性を使用する。

ダウンロードする仮想ファイルは、downUrl属性にダウンロード可能なサーバー側のアドレスが設定されている必要があります（バージョン1.4.1.0では、url属性でも可能です）。

<script>
  function onDX5Created(id) {
    var dx = dx5.get(id);
    // ダウンロードパス情報がなくてダウンロードすることができない、仮想ファイルである。
    dx.addVirtualFile({ vindex: "IDX0001", name: "virtual_file.txt", size: 12345 });
    // ダウンロードパスがあればダウンロードすることができる。
    dx.addVirtualFile({ vindex: "IDX0003", name: "bridge_509147.jpg", size: 509147, downUrl: "http://domain/path/common-download.do?key=FID0001" });
  }
  function download(id) {
    var dx = dx5.get(id);
    // 二番目の仮想ファイルを選択します。
    var itemId = dx.getItemId(1);
    dx.downloadById(itemId);
  }
</script>
<button type="button" onclick="download('component-id');">ダウンロード</button>

ダウンロードパスはサーバー側コンポーネントを使用し、Content-dispositionレスポンスヘッダの値がattachmentでなければなりません。

さらに、ターゲットが存在するかどうかを判断するためにHEADメソッドリクエストが送信され、HTTPレスポンスコードがエラーでなければ、ダウンロードが再度実行されます。

<script>
  function onDX5Created(id) {
    var dx = dx5.get(id);
    // ダウンロードパス情報がなくてダウンロードすることができない、仮想ファイルである。
    dx.addVirtualFile({ vindex: "IDX0001", name: "virtual_file.txt", size: 12345 });
    // ダウンロードパスがあればダウンロードすることができる。
    dx.addVirtualFile({ vindex: "IDX0003", name: "bridge_509147.jpg", size: 509147, url: "http://domain/path/common-download.do?key=FID0001" });
  }
  function download(id) {
    var dx = dx5.get(id);
    // 二番目の仮想ファイルを選択します。
    var itemId = dx.getItemId(1);
    dx.downloadById(itemId);
  }
</script>
<button type="button" onclick="download('component-id');">ダウンロード</button>

形式

component.downloadById(id);

パラメータ

2.0.0.0以上

説明

指定された一意のIDに対応する仮想ファイルをHDアプリケーションを使用してダウンロードする。

ファイルをダウンロードするには、サーバーに存在する対象のパス情報を得る必要がありますが、仮想ファイルの属性を使用する。

仮想ファイルは、urlプロパティにダウンロードすることができ、サーバー側アドレスが設定されなければならない。

バージョン1.4.1.0から、downUrlとurlの2つのプロパティが使えるようになりました。

<script>
    function onDX5Created(id) {
        var dx = dx5.get(id);
        // ダウンロードパス情報がなくてダウンロードすることができない、仮想ファイルである。
        dx.addVirtualFile({ vindex: "IDX0001", name: "virtual_file.txt", size: 12345 });
        // ダウンロードパスがあればダウンロードすることができる。
        dx.addVirtualFile({ vindex: "IDX0003", name: "bridge_509147.jpg", size: 509147, url: "http://domain/path/common-download.do?key=FID0001", chunkSize: 10 });
    }
    function download(id) {
        var dx = dx5.get(id);
        // 二番目の仮想ファイルを選択します。
        var itemId = dx.getItemId(1);
        dx.downloadByIdToHD(itemId);
    }
</script>
<button type="button" onclick="download('component-id');">ダウンロード</button>

HDアプリケーションを使用してダウンロードをするときは、ダウンロード要求に対するサーバーのContent-dispositionレスポンスヘッダがattachementあるいはinlineの場合にかかわらず、強制的にファイルをダウンロードすることができる。

ダウンロードする対象と同じ名前を持つ項目が既に存在する場合、開発者は、このエントリを追加（重複）したり、無視できるように、コールバック関数（duplicated）を使用することができる。

var dx = dx5.get(id);
// 二番目の仮想ファイルを選択します。
var itemId = dx.getItemId(1);
dx.downloadByIdToHD(itemId, function (fileName) {
    if (confirm(fileName + "ファイルが既に存在する。それでも追加しますか？")) {
        // return 0;または戻り値がない場合、重複に関係なく追加する。
    } else {
        // 無視する。
        return 1;
    }
});

戻り値に応じた内部処理方式は、次のとおりである。

• 1：項目を追加していない。
• 2：項目を追加し、以降に発生する重複件に対してコールバックを呼び出すことなく、自動的に追加される。
• 3：項目を追加せず、後に発生する重複件に対してコールバックを呼び出すことなく、自動的に無視される。
• その他の値：項目を追加する。

形式

component.downloadByIdToHD(id[, duplicated]);

パラメータ

2.0.0.0以上

説明

HDアプリケーションを使用して、複数のファイルのダウンロードを開始する。

ファイルをダウンロードするには、サーバーに存在する対象のパス情報を得る必要がありますが、仮想ファイルの属性を使用する。

ダウンロードはしたい仮想ファイルは必ずurlプロパティにダウンロードすることができ、サーバー側アドレスが設定されなければならない。

バージョン1.4.1.0から、downUrlとurlの2つのプロパティが使えるようになりました。

<script>
    function onDX5Created(id) {
        var dx = dx5.get(id);
        // ダウンロードパス情報がなくてダウンロードすることができない、仮想ファイルである。
        dx.addVirtualFile({ vindex: "IDX0001", name: "virtual_file.txt", size: 12345 });
        // ダウンロードパスがあればダウンロードすることができる。
        dx.addVirtualFile({ vindex: "IDX0003", name: "bridge_509147.jpg", size: 509147, url: "http://domain/path/common-download.do?key=FID0001", chunkSize: 10 });
    }
    function download(id) {
        // フラグの値に基づいてダウンロードを実行する。
        // AUTO：仮想ファイルをダウンロードする。
        // SELECTED：選択された仮想ファイルをダウンロードする。
        // CHECKED：チェックされた仮想ファイルをダウンロードする。
        dx5.get(id).downloadToHD("AUTO");
    }
</script>
<button type="button" onclick="download('component-id');">파일 ダウンロード</button>

特別なコードを処理せずに「AUTO」のパラメータの値を持ってアップロードを処理しようとした場合、コンポーネントの作成時にbtnDownloadToHDAuto属性値を使用して自動的にバインドして使用することができる。

<button id="btn-download" type="button">ダウンロード</button>
<script>
    dx5.create({
        ...,
        // ファイルのダウンロード機能が自動的に接続される。
        btnDownloadToHDAuto: "btn-download"
    });
</script>

btnDownloadToHDAuto属性のほかに、btnDownloadToHDSelected、btnDownloadToHDCheckedを使用することができる。

ダウンロードする対象と同じ名前を持つ項目が既に存在する場合、開発者は、このエントリを追加（重複）したり、無視できるように、コールバック関数（duplicated）を使用することができる。

var dx = dx5.get(id);
dx.downloadToHD("AUTO", function (fileName) {
    if (confirm(fileName + "ファイルが既に存在する。それでも追加しますか？")) {
        // return 0;または戻り値がない場合、重複に関係なく追加する。
    } else {
        // 無視する。
        return 1;
    }
});

戻り値に応じた内部処理方式は、次のとおりである。

• 1：項目を追加していない。
• 2：項目を追加し、以降に発生する重複件に対してコールバックを呼び出すことなく、自動的に追加される。
• 3：項目を追加せず、後に発生する重複件に対してコールバックを呼び出すことなく、自動的に無視される。
• その他の値：項目を追加する。

ボタンに自動的にバインドをして使用する場合には、重複処理のためのコールバック関数を適用することができない。

形式

component.downloadToHD(flag[, duplicated]);

パラメータ

2.0.0.0以上

説明

HDアプリケーションに設定されたダウンロードパスを返します。

dx.getDownloadPathOfHD(function (path) {
  // HDアプリケーションのダウンロードパスである。
  console.log(path);
});

HDアプリケーションを使用する場合に使用されるメソッドは、ほとんど内部的に非同期操作を実行する。非同期の操作を実行するため、戻り値を受け取るまでスレッドが待機していない、要求の結果を受け取るためのコールバック関数を使用しなければならない。

形式

component.getDownloadPathOfHD(success);

パラメータ

2.0.0.0以上

説明

ダウンロードパスを設定する。

// ドライブ文字で開始すると、絶対パスが設定される。
dx.setDownloadPathOfHD("c:\\temp");
// <home>文字列で起動すると、ユーザーフォルダサブ経路が設定される。
dx.setDownloadPathOfHD("<home>\\temp");
// <doc>文字列で起動すると、ドキュメントフォルダのサブ経路が設定される。
dx.setDownloadPathOfHD("<doc>\\temp");
// <desktop>文字列で起動すると、デスクトップフォルダサブパスが設定される。
dx.setDownloadPathOfHD("<desktop>\\temp");
// <downloads>文字列で起動すると、ダウンロードフォルダサブパスが設定される。（2.5.0.0バージョンからサポート）
dx.setDownloadPathOfHD("<downloads>\\temp");

もしダウンロードパスを変更した後は、その変更値をすぐに知りたい場合は、コールバック関数（success）を使用する。

dx.setDownloadPathOfHD("<doc>\\temp", function (path) {
  console.log(path);
});

HDアプリケーションを使用する場合に使用されるメソッドは、ほとんど内部的に非同期操作を実行する。非同期の操作を実行するため、ジョブの処理結果を受け取るまでスレッドが待機していない、要求の結果を受け取るためのコールバック関数を使用しなければならない。

形式

component.setDownloadPath(path[, success]);

パラメータ

1.0.0.0以上

説明

現在ダウンロードの状態情報を持つオブジェクトを返します。

ファイルがダウンロードされているプロセスで使用すると、アップロードの状態情報を把握することができる。

この関数を使用して、返されたオブジェクトは、時間に応じて異なる値を持つのではなく、関数呼び出し時の状態をコピーした値のみ持つ。

ダウンロードする過程の変化を継続取得するにはsetTimeoutのような関数を使用する必要がある。

function toggleDownloadStatus(isBegin) {
  function downloadProgress() {			
    var dx = dx5.get("dext5"), 
        out = document.getElementById("downstatus-value"), 
        status = dx.getDownloadStatus();
    out.innerHTML = "" + 
      "name: " + status.currentName + "<br/>" + 
      "speed: " + status.totalSpeed + "(sec)<br/>" + 
      "count(completed/total): " + status.completeCount + "/" + status.totalCount + "<br/>" + 
      "current rate: " + status.currentRate + " % <br/>" + 
      "current size(received/total): " + status.currentReceiveSize + "/" + status.currentSize + " (bytes)<br/>" + 
      "current time(past/remained): " + status.currentTime + "/" + status.remainedCurrentTime + "<br/>" + 
      "total rate: " + status.totalRate + " % <br/>" + 
      "total size(received/total): " + status.totalReceiveSize + "/" + status.totalSize + " (bytes)<br/>" + 
      "total time(past/remained): " + status.totalTime + "/" + status.remainedTotalTime + "<br/>" + 
      "";
    if (window.isDownloading === true) {
      setTimeout(downloadProgress, 1000);
    }
  }
  window.isDownloading = isBegin;
  if (isBegin) downloadProgress();
}

形式

status = component.getDownloadStatus();

リターンタ

ダウンロード転送状態値を持つオブジェクト

以下は、オブジェクトが持つ属性の説明である。

2.0.0.0以上

説明

HDアプリケーションのダウンロードフォルダを変更するためにフォルダ選択ダイアログウィンドウを表示し。

複数のファイルをダウンロードするために、ダウンロードする前にダウンロードする場所を設定する必要がある。

ダウンロードの場所を変更しない場合、デフォルトの場所（ドキュメントフォルダのサブDEXTUploadX5 HDMフォルダ）が使用される。

function changePath(id) {
  var dx = dx5.get(id);
  dx.openDownloadPathDialogOfHD();
}

openDownloadPathDialogOfHDメソッドは、ユーザーにダウンロードパスを選択機会を与える目的で使用される。

ダウンロードパスが変更になると、コールバック関数を使用して変更されたパスを得ることができる。

function changePath(id) {
  var dx = dx5.get(id);
  dx.openDownloadPathDialogOfHD(function (path) {
    // 変更されたダウンロードパスを得ることができる。
    console.log(path);
  });
}

形式

component.openDownloadPathDialogOfHD([success]);

パラメータ

2.4.0.0以上

説明

HDアプリケーションに設定されたオプションの情報をコールバック関数に返されます。

dx.getOptionsOfHD(function (option) {
  // optionパラメータは、HDアプリケーションのオプション情報を持っているJSONオブジェクトである。
});

オプションオブジェクトは、次のとおりである。

{
	// ファイルが追加されると、プログラムが自動的に有効に
	autoActivation: true,
	// ファイルが追加されると、自動的にダウンロードを開始
	autoDownload: true,
	// ファイルを削除すると、ローカルに残された一時ファイルの情報も削除
	deleteTemporary: false,
	// ダウンロードが中断されたファイルがあるとき、プログラムが有効になるとすぐにダウンロードを開始し
	resumeDownload: true,
	// ファイルがダウンロードされるとき、プログラムが閉じても、一時的な情報で残される項目対象
	saveStatus: {
		// スタンバイまたは停止された項目
		waitStop: true,
		// ダウンロードしていた項目
		downloading: true,
		// ダウンロードが完了した項目
		complete: true,
		// エラーが発生したアイテム
		error: true
	}
}

形式

component.getOptionsOfHD(success);

パラメータ

2.4.0.0以上

説明

HDアプリケーションのオプションを一度に設定する。

dx.setOptionsOfHD({
	autoActivation: true,
	autoDownload: true,
	deleteTemporary: false,
	resumeDownload: true,
	saveStatus: {
		waitStop: true,
		downloading: true,
		complete: true,
		error: true
	}
}, function () { ... });

形式

component.setOptionsOfHD(option[, success]);

パラメータ

{
	// ファイルが追加されると、プログラムが自動的に有効に
	autoActivation: true,
	// ファイルが追加されると、自動的にダウンロードを開始
	autoDownload: true,
	// ァイルを削除すると、ローカルに残された一時ファイルの情報も削除
	deleteTemporary: false,
	// ダウンロードが中断されたファイルがあるとき、プログラムが有効になるとすぐにダウンロードを開始し
	resumeDownload: true,
	// プログラムが閉じても維持されている項目対象
	saveStatus: {
		// スタンバイまたは停止された項目
		waitStop: true,
		// ダウンロード中だった項目
		downloading: true,
		// ダウンロードが完了した項目
		complete: true,
		// エラーが発生したアイテム
		error: true
	}
}

2.4.0.0以上

説明

自動アクティブ化オプションの値を設定する

自動アクティブ化とは、ダウンロードしたいファイルのエントリをHDアプリケーションに登録したとき、HDアプリケーションをアクティブに変えることをいう。この値がtrueであれば、隠されていたアプリケーションがウィンドウモードで見えるようになる。

// 自動アクティブ化オプションをtrueに変更する。
dx.setAutoActivationOptionOfHD(true, function () {
    ...
});

形式

component.setAutoActivationOptionOfHD(value[, success]);

パラメータ

2.4.0.0以上

説明

自動ダウンロードオプションの値を設定する。

自動ダウンロードとダウンロードしたいファイルのエントリをHDアプリケーションに登録したとき、HDアプリケーションを対象にすぐにダウンロードすることをいう。

// 自動ダウンロードオプションをtrueに変更する。
dx.setAutoDownloadOptionOfHD(true, function () {
    ...
});

形式

component.setAutoDownloadOptionOfHD(value[, success]);

パラメータ

2.4.0.0以上

説明

一時ファイルを削除するオプションの値を設定する。

一時ファイルの削除とは、アプリケーションからダウンロード項目を削除するときは、アイテムの一時ファイルも削除することをいう。ファイルのダウンロードを開始した後、ダウンロードが完了しない場合、常に、一時ファイルが残っている。

// 一時ファイルを削除するオプションをtrueに変更する。
dx.setDeleteTemporaryOptionOfHD(true, function () {
    ...
});

形式

component.setDeleteTemporaryOptionOfHD(value[, success]);

パラメータ

2.4.0.0以上

説明

再（再度）のダウンロードオプションの値を設定する。

再（再度）ダウンロードとダウンロードが完了していない項目がある状態で、プログラムが終了した後、再度プログラムが実行されると、完了していない対象のファイルを自動的にダウンロードする。

// 再（再度）ダウンロードオプションをtrueに変更する。
dx.setResumeDownloadOptionOfHD(true, function () {
    ...
});

形式

component.setResumeDownloadOptionOfHD(value[, success]);

パラメータ

2.4.0.0以上

説明

終了後に保持対象のオプションの値を設定する。

終了後に保持対象とプログラムが終了した後、再度プログラムが実行されたとき、支持項目を指す。

// 終了後に保持対象を変更する。
dx.setSaveStatusOptionOfHD(15, function () {
    ...
});

downloading値（2）が不足している場合、再（再度）ダウンロードオプションの設定に影響を受ける項目がないので、自動的にダウンロードするアイテムが保持されない。

形式

component.setSaveStatusOptionOfHD(value[, success]);

パラメータ

1.1.0.0以上

説明

ファイルのダウンロードを停止する。

DEXTUploadX5は、コンポーネント自体にダウンロードを停止するボタンやGUI要素がない。

代わりに、スクリプトを使用して停止することができるように関数を提供している。

<button type="button" onclick="stop('component-id');">停止</button>
<script>
function stop(id) {
  dx5.get(id).stopDownloading();
}
</script>

コンポーネントの作成時にbtnStopDownloading属性値を使用して自動的にバインドして使用することができる。

<button id="btn-stop-downloading" type="button">停止</button>
<script>
  dx5.create({
    ...,
    // ダウンロードを停止機能が自動的に接続される。
    btnStopDownloading: "btn-stop-downloading"
  });
</script>

IEモジュールとは異なり、複数のモジュールは、1.1.0.0のバージョンが後からサポートする。

中断できるのは、複数ファイルのダウンロード操作のみです。 ダウンロード対象がdownloadByIdまたはダウンロードアイコンを使用してダウンロードされている場合、stopDownloading関数を使用しても操作は中断されません。

形式

component.stopDownloading();