FileUploader Module

The File Uploader is an independent component that is dedicated to file uploading.

Dynamsoft.FileUploader

Init()

Initialize and create a FileUploader instance.

Syntax

Init(
    URL: string,
    successCallback: (uploadManager: UploadManager) => void,
    failureCallback: (errorCode: number, errorString: string) => void
): void;

Parameters

URL: Specify a path to retrieve the FileUploader library.

successCallback: A callback function that is executed if the request succeeds.

• uploadManager: A FileUploader instance. Please refer to UploadManager.

failureCallback: A callback function that is executed if the request fails.

• errorCode: The error code.
• errorString: The error string.

Availability

Example

var dsUploadManager;
Dynamsoft.FileUploader.Init(
    "",
    function (obj) {
        dsUploadManager = obj;
    },
    function () {},
);

Usage notes

The FileUploader library is installed with Dynamic Web TWAIN Service by default, therefore, URL can be left empty “”.

UploadManager

Methods

CreateJob()

Create an upload job.

Syntax

CreateJob(): Job;

Please refer to Job.

Availability

Run()

Start uploading (processing the specified job).

Syntax

Run(job: Job): boolean;

Parameters

job: Specify the job.

Availability

Cancel()

Cancel a job.

Syntax

Cancel(job: Job): boolean;

Parameters

job: Specify the job.

Availability

CancelAllupload()

Cancel all jobs.

Syntax

CancelAllUpload(): boolean;

Availability

Usage notes

Cancel() or CancelAllUpload() should be called in the event OnUploadTransferPercentage.

Example

var dsUploadManager;
Dynamsoft.FileUploader.Init(
    "",
    function (obj) {
        dsUploadManager = obj;
        var job = dsUploadManager.CreateJob();
        job.OnUploadTransferPercentage = FileUpload_OnUploadTransferPercentage;
        dsUploadManager.Run(job);

        function FileUpload_OnUploadTransferPercentage(job, iPercentage) {
            console.log("job cancelled!");
            dsUploadManager.Cancel(job);
        }
    },
    function () {},
);

Job

Properties

Events

BlockSize

Specify the block size (in bytes). By default, it’s 10240.

Syntax

BlockSize: number;

Availability

FileName

Specify the file name.

Syntax

FileName: string;

Availability

FormField

Specifies extra fields to be uploaded in the same HTTP post.

Syntax

FormField: FormField;

Availability

Usage notes

Use the Add() method of the Object to add fields for uploading. Please refer to FormField.

Example

job.FormField.Add("customField", "FormFieldValue");

HttpHeader

Specifies headers in the the HTTP Post Request of the upload job. For example: job.HttpHeader["Content-Type"] = "text/plain";

Syntax

HttpHeader: object;

Availability

Usage notes

By default, HttpHeader is an empty object. If left as it is, default headers are used. Otherwise, the headers set by this property will be added to the HTTP Post Request or replace existing ones with the same names.

HttpVersion

Return the Http version.

Syntax

readonly HttpVersion: string;

Availability

ServerUrl

Specifies the target of the HTTP Post Request of the upload job. This typically is a file on the server. For example: job.ServerUrl = 'http://www.dynamsoft.com/ScanAndUpload/Actions/SaveToFile.aspx';

Syntax

ServerUrl: string;

Availability

SourceValue

Specifies the files to be uploaded and the name for it. The files are specified by URLs which can be created with the method GenerateURLForUploadData().

Syntax

SourceValue: SourceValue;

Availability

Usage notes

Use the Add() method of the Object to add data for uploading. Please refer to SourceValue.

Example

job.SourceValue.Add(url, fileName);

ThreadNum

Specify the number of threads (<=4) for the upload.

Syntax

ThreadNum: number;

Availability

Version

Return the version of the job.

Syntax

readonly Version: number;

Availability

OnUploadTransferPercentage

The event is triggered during the execution of an upload job. It has a parameter which specifies the percentage of the completion of the job.

Syntax

OnUploadTransferPercentage: (
    job: Job,
    percentage: number
) => void;

Parameters

job: A job object.

sPercentage: The percentage of the completion of the job.

Availability

Example

job.OnUploadTransferPercentage = FileUpload_OnUploadTransferPercentage;
function FileUpload_ OnUploadTransferPercentage (job, sPercentage){
    console.log(sPercentage);
}

OnRunSuccess

The event is triggered when an upload job completes successfully.

Syntax

OnRunSuccess: (job: Job) => void;

Parameters

job: A job object.

Availability

Example

job.OnRunSuccess = FileUpload_OnRunSuccess;
function FileUpload_OnRunSuccess(job) {
    alert(" upload completed ");
}

OnRunFailure

The event is triggered when an upload job completes successfully.

Syntax

OnRunFailure: (
    job: Job,
    errorCode: number,
    errorString: string
) => void;

Parameters

job: A job object.

errorCode: The error code.

errorString: The error string.

Availability

Example

job.OnRunFailure = FileUpload_OnRunFailure;
function FileUpload_OnRunFailure(job, errorCode, errorString) {
    alert(errorString);
}