www.dextsolution.com
DEXTUPLOAD
X5
menu toggleリファレンス > イベント

onDX5UploadBegin

  • 1.0.0.0以上

  • 説明

    onDX5UploadBegin関数は、アップロードが開始されると呼び出されるコールバック関数である。

    function onDX5UploadBegin(id) {
        ...
    }
  • 形式

    # グローバルでイベントハンドラを宣言 
    function onDX5UploadBegin(id) { ... }
    
    # コンポーネント生成時にイベントハンドラを登録する(3.10.0.0バージョン以上)
    dx5.create({
        ...
        events: {
            uploadBegin: function(id) { ... }
        }
    });
    
    
  • パラメータ

    名前 形式 説明
    id String イベントが発生したコンポーネントのID

onDX5UploadCompleted

  • 1.0.0.0以上

  • 説明

    onDX5UploadCompleted関数は、アップロードが完了したときに呼び出されるコールバック関数である。

    サーバーから送信される応答データを確認するには、この関数が呼び出された後に確認すればよい。

    function onDX5UploadCompleted(id) {
        var result = "";
        // ORAF方式であれば、
        result = dx5.get(id).getResponses(0);
        // OROFまたはEXTS方式であれば、
        result = dx5.get(id).getResponses().join("\n");
        alert("アップロードが完了しました。\n応答データは、次のとおりである。\n" + result);
    }
  • 形式

    # グローバルでイベントハンドラを宣言
    function onDX5UploadCompleted(id) { ... }
    
    # コンポーネント生成時にイベントハンドラを登録する(3.10.0.0バージョン以上)
    dx5.create({
        ...
        events: {
            uploadCompleted: function(id) { ... }
        }
    });
    
  • パラメータ

    名前 形式 説明
    id String イベントが発生したコンポーネントのID
    result(4.0.0.0以上) Array<{ id: String, response: String }>

    getResponsesメソッドを使わずに、イベントコールバック関数のパラメータから直接応答データを取得することができます。

    • id: アップロードされたアイテムの id

    • response: アップロードされた項目の応答データ

    ORAFの場合、resultの長さは1であり、要素のid属性の値は空文字列です。

onDX5UploadItemEnd

  • 1.0.0.0以上

  • 説明

    onDX5UploadItemEnd関数は、個々のファイルごとにアップロードが完了するときに呼び出されるコールバック関数である。

    ORAF方式でアップロードすると、このイベントが発生しない。

    function onDX5UploadItemEnd(id, itemId) {
        ...
    }
  • 形式

    # グローバルでイベントハンドラを宣言
    function onDX5UploadItemEnd(id, itemId) { ... }
    
    # コンポーネント生成時にイベントハンドラを登録する(3.10.0.0バージョン以上)
    dx5.create({
        ...
        events: {
            uploadItemEnd: function(id, itemId) { ... }
        }
    });
    
  • パラメータ

    名前 形式 説明
    id String イベントが発生したコンポーネントのID
    itemId String 項目の一意のID

onDX5UploadItemStart

  • 1.0.0.0以上

  • 説明

    onDX5UploadItemStart関数は、個々のファイルごとにアップロードが開始されると呼び出されるコールバック関数である。

    ORAF方式でアップロードすると、このイベントが発生しない。

    function onDX5UploadItemStart(id) {
        ...
    }
  • 形式

    # グローバルでイベントハンドラを宣言
    function onDX5UploadItemStart(id, itemId) { ... }
    
    # コンポーネント生成時にイベントハンドラを登録する(3.10.0.0バージョン以上)
    dx5.create({
        ...
        events: {
            uploadItemStart: function(id, itemId) { ... }
        }
    });
    
  • パラメータ

    名前 形式 説明
    id String イベントが発生したコンポーネントのID
    itemId String 項目の一意のID

onDX5UploadStopped

  • 1.0.0.0以上

  • 説明

    onDX5UploadStopped関数は、アップロードが強制的に停止された後に呼び出されるコールバック関数である。

    function onDX5UploadStopped(id) {
        alert("アップロードが停止された。");
    }
  • 形式

    # グローバルでイベントハンドラを宣言
    function onDX5UploadStopped(id) { ... }
    
    # コンポーネント生成時にイベントハンドラを登録する(3.10.0.0バージョン以上)
    dx5.create({
        ...
        events: {
            uploadStopped: function(id) { ... }
        }
    });
    
  • パラメータ

    名前 形式 説明
    id String イベントが発生したコンポーネントのID