---
layout: default-layout
needAutoGenerateSidebar: true
needGenerateH3Content: true
title: Dynamic Web TWAIN SDK API Reference - Uploader APIs
keywords: Dynamic Web TWAIN, Documentation, API Reference, Uploader APIs
breadcrumbText: File Uploader
description: Dynamic Web TWAIN SDK Documentation API Reference Uploader APIs Page
---
# 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**
```typescript
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`](#uploadmanager).
`failureCallback`: A callback function that is executed if the request fails.
- `errorCode`: The error code.
- `errorString`: The error string.
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.0+ |
v14.0+ |
v14.0+ |
v14.0+ |
**Example**
```javascript
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()`](#createjob) | [`Run()`](#run) | [`Cancel()`](#cancel) | [`CancelAllUpload()`](#cancelallupload) |
### CreateJob()
Create an upload job.
**Syntax**
```typescript
CreateJob(): Job;
```
Please refer to [`Job`](#job).
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.0+ |
v14.0+ |
v14.0+ |
v14.0+ |
### Run()
Start uploading (processing the specified job).
**Syntax**
```typescript
Run(job: Job): boolean;
```
**Parameters**
`job`: Specify the job.
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.0+ |
v14.0+ |
v14.0+ |
v14.0+ |
### Cancel()
Cancel a job.
**Syntax**
```typescript
Cancel(job: Job): boolean;
```
**Parameters**
`job`: Specify the job.
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.0+ |
v14.0+ |
v14.0+ |
v14.0+ |
### CancelAllupload()
Cancel all jobs.
**Syntax**
```typescript
CancelAllUpload(): boolean;
```
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.0+ |
v14.0+ |
v14.0+ |
v14.0+ |
**Usage notes**
[`Cancel()`](#cancel) or [`CancelAllUpload()`](#cancelallupload) should be called in the event [`OnUploadTransferPercentage`](#onuploadtransferpercentage).
**Example**
```javascript
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**
| [`BlockSize`](#blocksize) | [`FileName`](#filename) | [`FormField`](#formfield) |
| [`HttpHeader`](#httpheader) | [`HttpVersion`](#httpversion) | [`ServerUrl`](#serverurl) |
| [`SourceValue`](#sourcevalue) | [`ThreadNum`](#threadnum) | [`Version`](#version) |
**Events**
| |
| :---------------------------------------------------------- | :------------------------------ | ------------------------------- |
| [`OnUploadTransferPercentage`](#onuploadtransferpercentage) | [`OnRunSuccess`](#onrunsuccess) | [`OnRunFailure`](#onrunfailure) |
### BlockSize
Specify the block size (in bytes). By default, it's 10240.
**Syntax**
```typescript
BlockSize: number;
```
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.0+ |
v14.0+ |
v14.0+ |
v14.0+ |
### FileName
Specify the file name.
**Syntax**
```typescript
FileName: string;
```
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.0+ |
v14.0+ |
v14.0+ |
v14.0+ |
### FormField
Specifies extra fields to be uploaded in the same HTTP post.
**Syntax**
```typescript
FormField: FormField;
```
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.0+ |
v14.0+ |
v14.0+ |
v14.0+ |
**Usage notes**
Use the `Add()` method of the Object to add fields for uploading. Please refer to [`FormField`](/_articles/info/api/interfaces.md#formfield).
**Example**
```javascript
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**
```typescript
HttpHeader: object;
```
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.0+ |
v14.0+ |
v14.0+ |
v14.0+ |
**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**
```typescript
readonly HttpVersion: string;
```
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.0+ |
v14.0+ |
v14.0+ |
v14.0+ |
### 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**
```typescript
ServerUrl: string;
```
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.0+ |
v14.0+ |
v14.0+ |
v14.0+ |
### 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()`](/_articles/info/api/WebTwain_Util.md#generateurlforuploaddata).
**Syntax**
```typescript
SourceValue: SourceValue;
```
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.0+ |
v14.0+ |
v14.0+ |
v14.0+ |
**Usage notes**
Use the `Add()` method of the Object to add data for uploading. Please refer to [`SourceValue`](/_articles/info/api/interfaces.md#sourcevalue).
**Example**
```javascript
job.SourceValue.Add(url, fileName);
```
### ThreadNum
Specify the number of threads (<=4) for the upload.
**Syntax**
```typescript
ThreadNum: number;
```
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.0+ |
v14.0+ |
v14.0+ |
v14.0+ |
### Version
Return the version of the job.
**Syntax**
```typescript
readonly Version: number;
```
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.0+ |
v14.0+ |
v14.0+ |
v14.0+ |
### 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**
```typescript
OnUploadTransferPercentage: (
job: Job,
percentage: number
) => void;
```
**Parameters**
`job`: A job object.
`sPercentage`: The percentage of the completion of the job.
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.0+ |
v14.0+ |
v14.0+ |
v14.0+ |
**Example**
```javascript
job.OnUploadTransferPercentage = FileUpload_OnUploadTransferPercentage;
function FileUpload_ OnUploadTransferPercentage (job, sPercentage){
console.log(sPercentage);
}
```
### OnRunSuccess
The event is triggered when an upload job completes successfully.
**Syntax**
```typescript
OnRunSuccess: (job: Job) => void;
```
**Parameters**
`job`: A job object.
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.0+ |
v14.0+ |
v14.0+ |
v14.0+ |
**Example**
```javascript
job.OnRunSuccess = FileUpload_OnRunSuccess;
function FileUpload_OnRunSuccess(job) {
alert(" upload completed ");
}
```
### OnRunFailure
The event is triggered when an upload job completes successfully.
**Syntax**
```typescript
OnRunFailure: (
job: Job,
errorCode: number,
errorString: string
) => void;
```
**Parameters**
`job`: A job object.
`errorCode`: The error code.
`errorString`: The error string.
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.0+ |
v14.0+ |
v14.0+ |
v14.0+ |
**Example**
```javascript
job.OnRunFailure = FileUpload_OnRunFailure;
function FileUpload_OnRunFailure(job, errorCode, errorString) {
alert(errorString);
}
```