www.dextsolution.com
DEXTUPLOAD
X5
menu toggleリファレンス > Itemオブジェクト

Itemオブジェクト

オブジェクト

1.0.0.0以上

項目（item）とDEXTUploadX5で扱われる資源を意味する。エントリは、ローカルファイル、ローカルフォルダ、仮想ファイルとして区分され、コンポーネントは、スクリプト上で項目（または多数）を得るためにいくつかのメソッドを提供します。 

// 六番目の項目を得る。
var item = dx.getItemByIndex(5);
// 項目の名前を出力する。
console.log(item.name);

コンポーネントが提供するメソッドを使用して得られた項目のほとんどはコピーである。

属性

controlId

  • 1.0.0.0以上

  • 説明

    アイテムが生成されたコンポーネントのIDを表す文字列である。

id

  • 1.0.0.0以上

  • 説明

    項目の一意のIDを表す文字列である。

type

  • 1.0.0.0以上

  • 説明

    項目の種類を表す文字列である。

    • 「FILE」：ローカルファイル
    • 「FOLDER」：ローカルフォルダ（IEモジュールでのみサポート）
    • 「VIRTUAL」：仮想ファイル
    • 「DVIRTUAL "：削除された仮想ファイル

name

  • 1.0.0.0以上

  • 説明

    項目の名前、ファイル、またはフォルダ名を表す文字列である。

ext

  • 1.0.0.0以上

  • 説明

    項目の拡張子を表す文字列である。

vindex

  • 1.0.0.0以上

  • 説明

    項目の仮想インデックスを表す文字列である。

    仮想ファイルで使用されている仮想インデックスは、手動で指定する一種のキー値である。

    ex) vindex: "1234567890"

size

  • 1.0.0.0以上

  • 説明

    項目のサイズ（バイト単位）の数値である。

    ファイルをダウンロードする際には、正しい進行情報を示すために、ファイルのサイズを知るべきである。

    仮想ファイルのみをダウンロードの対象となりますので、仮想ファイルを指定するときには可能なサーバー上に存在する対象のファイルのサイズを正確に入力する必要がある。

mdate

  • 1.0.0.0以上

  • 説明

    ローカル項目の修正イルジャウル表すDate型の値である。

lock

  • 1.0.0.0以上

  • 説明

    項目のロック状態を示すBoolean値である。

    項目をロックすると、項目を削除することができない。

status

  • 1.0.0.0以上

  • 説明

    項目の状態を表す文字列である。

    「WAIT」：アップロード前に、「DONE」：アップロードした後

checked

  • 1.0.0.0以上

  • 説明

    項目のチェック状態を示すBoolean値である。

openUrl

  • 1.0.0.0以上

  • 説明

    仮想ファイルのオープンパスを表す文字列である。

    openUrlはオープンを実行する対象がウェブアドレスにより、スキーマ（http、https）が含まれている完全なURLでなければならない。

    オープンとブラウザが直接開くことができるファイルのみ対象となり、それ以外のファイルは、ダウンロードがされる。ブラウザが開くことができるファイルであってもサーバーからattachement形式で配信がされると、開かずダウンロードがされる。したがって、openUrlは必ずinline形式で配信受けるサービスを設定する必要がある。

downUrl

  • 1.0.0.0以上

  • 説明

    仮想ファイルのダウンロードパスを表す文字列である。

    downUrlはダウンロードを実行する対象がウェブアドレスにより、スキーマ（http、https）が含まれている完全なURLでなければならない。

    HTML5をサポートしているすべてのブラウザがanchor HTML要素のdownload属性の両方をサポートしていないため、ターゲットリソースは、サーバーからattachement形式でレスポンスヘッダを設定する必要がある。

middlePath

  • 3.7.0.0以上

  • 説明

    アイテムのフォルダパスを表す文字列。ターゲットがローカルリソース（ファイル、フォルダ）の場合、リソースの親フォルダを指します。親フォルダのパスはドライブから始まるのではなく、フォルダ選択ダイアログで選択されたフォルダのサブパスになります。

    • aaa/bbb/ccc

    アイテムがローカルリソースではなく仮想ファイルの場合、フォルダ構造をダウンロードするためのフォルダパス値が含まれます。

url

  • 1.4.1.0以上

  • 説明

    仮想ファイルのウェブパスを表す文字列である。

    urlはダウンロードまたは展開を実行する対象がウェブアドレスにより、スキーマ（http、https）が含まれている完全なURLでなければならない。

    このプロパティはdownUrlと同じです。

eventUriStart

  • マルチモジュールバージョン2.0.0.0以上、IEモジュールバージョン2.0.0.0以上

  • 説明

    HDアプリケーションを使用して、ファイルのダウンロードを利用する際に使用されるイベントのアドレスを表す文字列である。

    イベントアドレスは、Webアドレスとして、スキーマ（http、https）が含まれている完全なURLでなければならない。

    HDアプリケーションは、アイテムをダウンロードする際には、この属性が設定されている場合、ダウンロードを実行する前に、eventUriStart属性が指すアドレスにGETリクエストを送信します。

eventUriStop

  • マルチモジュールバージョン2.0.0.0以上、IEモジュールバージョン2.0.0.0以上

  • 説明

    HDアプリケーションを使用して、ファイルのダウンロードを利用する際に使用されるイベントのアドレスを表す文字列である。

    イベントアドレスは、Webアドレスとして、スキーマ（http、https）が含まれている完全なURLでなければならない。

    HDアプリケーションは、アイテムをダウンロードする際には、この属性が設定されて状態で、ダウンロードが停止した場合eventUriStop属性が指すアドレスにGETリクエストを送信します。（エラーに起因する停止ではなく、ユーザーのアクションによる停止を意味する。）

eventUriEnd

  • マルチモジュールバージョン2.0.0.0以上、IEモジュールバージョン2.0.0.0以上

  • 説明

    HDアプリケーションを使用して、ファイルのダウンロードを利用する際に使用されるイベントのアドレスを表す文字列である。

    イベントアドレスは、Webアドレスとして、スキーマ（http、https）が含まれている完全なURLでなければならない。

    HDアプリケーションは、アイテムをダウンロードする際には、この属性が設定されている場合、ダウンロードが完了した後eventUriEnd属性が指すアドレスにGETリクエストを送信します。

chunkSize

  • マルチモジュールバージョン2.0.0.0以上、IEモジュールバージョン2.0.0.0以上

  • 説明

    HDアプリケーションを使用して、ファイルのダウンロードを利用する際、ファイルが分割されているサイズを示す数値である。

    HDアプリケーションファイルをダウンロードするとき、要求にファイルを一度にダウンロードせずに、指定されたサイズだけ分けてダウンロードを実行する。ファイルを分けてダウンロードをすると、ファイルのダウンロード時間は、少し時間がかかることがありますが、サーバーをより安定的に運営することができる。ダウンロードするファイルのサイズが大きい場合は、そのファイルがダウンロード完了するまでの帯域幅を握っているので、性能上の問題が発生することができる。このような場合に、ファイルを分割すると、サーバーへのダウンロード要求が分けられるので、一部のユーザーがサーバーのリソースを長時間占有する現象が減ることになる。

    指定がされていない場合は-1の値に設定がされており、-1または0の場合には、ファイルを分割せずに一つのリクエストである受ける。加えて、分割サイズは、MB単位でのみ指定しなければならない。

hdTitle

  • 2.1.2.0以上

  • 説明

    HDアプリケーションを使用して、ファイルのダウンロードを利用する際にウィンドウタイトルに出力されるテキストを表す文字列である。

    ファイルがダウンロードされるとき、HDアプリケーションのウィンドウタイトル領域にテキストとファイル名が出力されるが、指定された値がない場合は、製品名とバージョンが出力される。

Copyright ⓒ DEXTSolution Inc. All rights reserved