1.0.0.0以上

説明

アップロード方式を返します。

形式

mode = component.getUploadMode();

リターン

アップロード方式、「ORAF」、「OROF」、「EXTS」、「AWSS3」、「NCPOS」、「AZRBS」のいずれかが返される。デフォルトでは、「ORAF」である。

1.0.0.0以上

説明

サーバー側のアップロードアドレスを設定します。

ファイルをアップロードするには、アップロードパスを設定する必要があります。

DEXTUploadX5は、RFC1867プロトコルに従って、multipart / form-dataとしてエンコードされたデータをサーバーに送信することのみを担当します。

サーバー側のアップロードアドレスは、multipart / form-dataとしてエンコードされたデータを受信して​​保存するサービスとして実装する必要があります。

function onDX5Created(id) {
  var dx = dx5.get(id);
  // アップロード処理アドレスを設定します。
  dx.setUploadURL("http://domain/path/common-upload.do");
}

形式

component.setUploadURL(url);

パラメータ

1.0.0.0以上

説明

アップロード方式を設定する。

DEXTUploadX5はファイルのアップロードは動作の3つのモードをサポートする。

• ORAF（基本）：アップロードするファイルを1つのリクエストに入れて送信する。アップロードが完了すると、応答データは、1つになる。
• OROF：アップロードするファイルの数だけリクエストが行われます。アップロードが完了すると、ファイルの数だけ応答データが生成される。
• EXTS：OROFと同じか、大容量アップロードにより、個々の、またはファイル全体のサイズが2GBを超える場合に使用される。
• AWSS3: Amazon S3にファイルをアップロードする際に使用されます。4.0.0.0から対応しています。
• NCPOS: NAVER CLOUD PLATFORM Object Storageにファイルをアップロードする際に使用されます。4.2.0.0から対応しています。
• AZRBS: Azure Blob Storageにファイルをアップロードする際に使用されます。4.3.0.0から対応しています。

function onDX5Created(id) {
  var dx = dx5.get(id);
  // OROFアップロード方式を使用するようにする。
  dx.getUploadMode("OROF");
}

形式

component.setUploadMode(mode);

パラメータ

1.0.0.0以上

説明

現在、アップロードの状態情報を持つオブジェクトを返します。

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

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

アップロードするプロセスの変化を継続取得するにはsetTimeoutのような関数を使用する必要がある。

function toggleUploadStatus(isBegin) {
  function uploadProgress() {			
    var dx = dx5.get("dext5"), 
        out = document.getElementById("upstatus-value"), 
        status = dx.getUploadStatus();
    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(sended/total): " + status.currentSendSize + "/" + status.currentSize + " (bytes)<br/>" + 
      "current time(past/remained): " + status.currentTime + "/" + status.remainedCurrentTime + "<br/>" + 
      "total rate: " + status.totalRate + " % <br/>" + 
      "total size(sended/total): " + status.totalSendSize + "/" + status.totalSize + " (bytes)<br/>" + 
      "total time(past/remained): " + status.totalTime + "/" + status.remainedTotalTime + "<br/>" + 
      "";
    if (window.isUploading === true) {
      setTimeout(uploadProgress, 1000);
    }
  }
  window.isUploading = isBegin;
  if (isBegin) uploadProgress();
}

ORAF方式でファイルをアップロードする場合、個々のファイル単位でステータス値を区別して表示することができません。 したがって、completeCountの値はアップロード完了時にtotalCountと同じ値を持ち、アップロード中は0で維持されます。 また、currentとtotalは常に同じ値を持つので、currentSendSize、currentTime、currentRateの値は無意味です。 したがって、ORAFではtotalRate、totalSendSize、totalSize、totalTime、remainedTotalTimeだけを使うようにしなければなりません。

形式

status = component.getUploadStatus();

リターンタ

アップロードの転送状態の値を持つオブジェクト

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

1.0.0.0以上

説明

サーバー側のアップロード処理アドレスを返します。

ファイルをアップロードするには、アップロードパスを設定する必要があります。

DEXTUploadX5は、RFC1867プロトコルに従って、multipart / form-dataとしてエンコードされたデータをサーバーに送信することのみを担当します。

サーバー側のアップロードアドレスは、multipart / form-dataとしてエンコードされたデータを受信して​​保存するサービスとして実装する必要があります。

function onDX5Created(id) {
  var dx = dx5.get(id);
  // サーバー側のアップロード処理アドレスを出力します。
  console.log(dx.getUploadURL());
}

形式

url = component.getUploadURL();

リターンタ

Server-side upload processing address

3.10.0.0以上

説明

ファイルアップロード操作間の時間間隔値を返します。

形式

interval = component.getUploadTimeInterval();

リターンタ

ミリ秒単位の時間間隔値 (1/1000)

3.10.0.0以上

説明

ファイルアップロード操作の間隔を設定します。

ファイルアップロード方法が OROF または EXTS の場合、アップロードするファイル数とチャンク数に応じて複数のアップロード操作が発生し、各操作は指定した時間値だけ遅延します。

var dx = dx5.get("component-id");
dx.setUploadTimeInterval(1000);

形式

component.setUploadTimeInterval(interval);

パラメータ

3.10.0.0以上

説明

アップロード・ジョブの一時停止

この機能を使用して、アップロード・ジョブを一時停止できます。アップロードが一時停止されている間は、resumeUploading関数を使用してアップロード操作を再開できます。

<button type="button" onclick="pause('component-id');">Pause</button>
<script>
function pause(id) {
    dx5.get(id).pauseUploading();
}
</script>

形式

component.pauseUploading();

3.10.0.0以上

説明

一時停止したアップロードジョブを再開する

pauseUploadingメソッドは、pauseUploadingメソッドを使用してダウンロード操作が一時停止されている場合、またはエラーが発生して一時停止されている場合にのみ使用できます。

• ORAFメソッドでは、アップロード操作を再開すると、アップロードが最初から再開されます。
• OROFメソッドでは、アップロードを再開すると、アップロードを停止したファイルから再開します。
• EXTSメソッドでは、アップロードを再開すると、停止したチャンクからアップロードを再開します。
• AWSS3メソッドでは、アップロードを再開すると、停止したチャンクからアップロードを再開します。

<button type="button" onclick="resume('component-id');">Resume</button>
<script>
function resume(id) {
    dx5.get(id).resumeUploading();
}
</script>

形式

component.resumeUploading();

4.0.0.0以上

説明

Amazon S3にファイルをアップロードするための設定値を定義します。

dx.setUploadMode("AWSS3");
dx.setAWSS3UploadConfig({
    type: "NON-SECRET",
    accessKeyId: "ABCD...1234",
    secretAccessKey: "ABCD...1234",
    region: "ap-northeast-2",
    bucket: "abc-bucket"
});

形式

component.setAWSS3UploadConfig(config);

パラメータ

dx.setAWSS3UploadConfig({
    makeKey: item => {
        return item.name;
    }
});

4.2.0.0以上

説明

NAVER CLOUD PLATFORM Object Storageにファイルをアップロードするための設定値を定義します。

dx.setUploadMode("NCPOS");
dx.setNCPOSUploadConfig({
    type: "NON-SECRET",
    accessKeyId: "ABCD...1234",
    secretAccessKey: "ABCD...1234",
    // kr, us, sg, jp, de
    region: "kr",
    bucket: "abc-bucket"
});

形式

component.setNCPOSUploadConfig(config);

パラメータ

dx.setNCPOSUploadConfig({
    makeKey: item => {
        return item.name;
    }
});

4.3.0.0以上

説明

Microsoft Azure Blob Storageにファイルをアップロードするための設定値を定義します。

dx.setUploadMode("AZRBS");
dx.setAZRBSUploadConfig({
    accountName: "photomanager",
    containerName: "photos",
    sasListURL: "https://example.com/get-list-sastoken.ashx",
    sasUploadURL: "https://example.com/get-upload-sastoken.ashx"
});

形式

component.setAZRBSUploadConfig(config);

パラメータ

dx.setAZRBSUploadConfig({
    makeKey: item => {
        return item.name;
    }
});