Dynamsoft.FileUploader

/**
 * Initialize and create a FileUploader instance.
 * @param URL Specify a path to retrieve the FileUploader library.
 * @param successCallback A callback function that is executed if the request succeeds.
 * @param failureCallback A callback function that is executed if the request fails.
 * @argument uploadManager A FileUploader instance.
 * @argument errorCode The error code.
 * @argument errorString The error string.
 */
Init(
    URL: string,
    successCallback: (
        uploadManager: UploadManager
    ) => void,
    failureCallback: (
        errorCode: number,
        errorString: string
    ) => void
): void;

/**
 * Create an upload job.
 */
CreateJob(): Job;

interface Job {
    /**
     * Specify the block size (in bytes). By default, it's 10240.
     */
    BlockSize: number;
    /**
     * Specify the file name.
     */
    FileName: string;
    /**
     * Specify the fields in the HTTP Post Form.
     */
    FormField: FormField;
    /**
     * Specify custom HTTP Post request headers.
     * Example: job.HttpHeader["Content-Type"] = "text/plain";
     */
    HttpHeader: object;
    /**
     * Return the Http version.
     */
    readonly HttpVersion: string;
    /**
     * A callback triggered when the job succeeds.
     * @argument job Specify the job.
     * @argument errorCode The error code.
     * @argument errorString The error string.
     */
    OnRunFailure: (
        job: Job,
        errorCode: number,
        errorString: string
    ) => void;
    /**
     * A callback triggered when the job succeeds.
     * @argument job Specify the job.
     */
    OnRunSuccess: (job: Job) => void;
    /**
     * A callback triggered multiple times during the upload.
     * @argument job Specify the job.
     * @argument percentage Return the percentage.
     */
    OnUploadTransferPercentage: (
        job: Job,
        percentage: number
    ) => void;
    /**
     * Specify the URL of the script to receive the upload.
     */
    ServerUrl: string;
    /**
     * Specify the main content of the job, i.e. the file(s).
     */
    SourceValue: SourceValue;
    /**
     * Specify the number of threads (<=4) for the upload.
     */
    ThreadNum: number;
    /**
     * Return the version of the job.
     */
    readonly Version: number;
}
interface SourceValue {
    /**
     * Specify the block size. By default, it's 10240.
     * @param source A URL to specify the content of the file.
     * Normally it's generated by {GenerateURLForUploadData()}
     * @param name Specify the name of the file.
     * @param key Specify the key of the file in the request. This key can be used to retrieve the file content in server-side scripts.
     */
    Add: (
        source: string,
        name: string,
        key ? : string
    ) => void;
}
interface FormField {
    /**
     * Specify the block size. By default, it's 10240.
     * @param key Specify the key of the field.
     * @param value Sepcify the value of the field.
     */
    Add: (
        key: string,
        value: string
    ) => void;
}

/**
 * Start uploading (processing the specified job).
 * @param job Specify the job.
 */
Run(job: Job): boolean;

/**
 * Cancel a job.
 * @param job Specify the job.
 */
Cancel(job: Job): boolean;

/**
 * Cancel all jobs.
 */
CancelAllUpload(): boolean;

/**
 * Generates a URL that will be used by the upload module to fetch the file/data to upload.
 * @param Number[] The indices of the images in the buffer. The index is 0-based.
 * @param EnumDWT_ImageType The format in which you'd like the images to be uploaded.
 * @param successCallback A callback function triggered when the operation succeeds. This function will return the result URL.
 * @param failureCallback A callback function triggered when the operation fails.
 * @argument resultURL The result URL.
 * @argument errorCode The error code.
 * @argument errorString The error string.
 
 */
GenerateURLForUploadData(
    Number[]: array,
    EnumDWT_ImageType: Dynamsoft.DWT.EnumDWT_ImageType | number,
    successCallback: (
        resultURL: resultURL
    ) => void,
    failureCallback: (
        errorCode: number,
        errorString: string
    ) => void
): void;

/**
 * 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';
 */
ServerUrl: string;

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

/**
 * 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. This object has a method Add to add file to the job.
 */
SourceValue: object;

/**
 * Specifies extra fields to be uploaded in the same HTTP post.
 */
FormField: object;

/**
 * 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.
 * @argument obj  A job object.
 * @argument sPercentage The percentage of the completion of the job.
 */
.OnUploadTransferPercentage = function(obj: Object , sPercentage: number){};

/**
 * The event is triggered when an upload job completes successfully.
 * @argument obj  A job object.
 */
.OnRunSuccess = function(obj: Object){};

/**
 * The event is triggered when an upload job completes successfully.
 * @argument obj  A job object.
 * @argument errorCode The error code.
 * @argument errorString The error string.
 */
.OnRunFailure = function(
obj: Object
errorCode: number,
errorString: string
){};