uploadImageFiles Method

In This Topic

Sends an asynchronous request to a server for uploading the image files to a server.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new Vintasoft.Imaging.VintasoftFileAPI();

var value; // Type: any

// Parameters
var files; // Type: object
var successFunc; // Type: function
var errorFunc; // Type: function
var service; // Type: WebServiceJS

value = instance.uploadImageFiles(files, successFunc, errorFunc, service);

function uploadImageFiles(
   filesFiles from the HTML INPUT object of FILE type.
 : object, 
   successFuncFunction that will be executed if request is executed successfully.
 Here is function prototype "function __success(data)". The data parameter has the following properties:
  files (object): Array with information about the uploaded image files.
 Information about uploaded image file is object with following properties:  fileId (string): Image file identifier.
 success (boolean): Indicates that the image file is uploaded successfully.
 blocked (boolean): Indicates that the image file is blocked by another request.
 errorMessage (string): String that describes an error occurred during image file uploading.
 
 
 
 : Function, 
   errorFuncFunction that will be executed if request is failed.
 Here is function prototype "function __error(data)".
 The data parameter can be:
  An object with following properties:
  errorMessage (string): Error message.
 blocked (boolean): Indicates that the requested action is blocked by another request.
 
 if exception is catched inside web service. 
 Otherwise, jqXHR object.
 
 : Function, 
   serviceAn instance, of WebServiceJS class, which will serve the request of this function.
 : WebServiceJS
) : any;

Parameters

files

Files from the HTML INPUT object of FILE type.

successFunc

Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)". The data parameter has the following properties:

files (object): Array with information about the uploaded image files.
Information about uploaded image file is object with following properties:
- fileId (string): Image file identifier.
- success (boolean): Indicates that the image file is uploaded successfully.
- blocked (boolean): Indicates that the image file is blocked by another request.
- errorMessage (string): String that describes an error occurred during image file uploading.

errorFunc

Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:

An object with following properties:
- errorMessage (string): Error message.
- blocked (boolean): Indicates that the requested action is blocked by another request.
if exception is catched inside web service.
Otherwise, jqXHR object.

service

An instance, of WebServiceJS class, which will serve the request of this function.

Exceptions

Exception	Description
	Thrown if arguments have wrong types.

Browser Compatibility

56+

45+

Reference

VintasoftFileAPI Class
VintasoftFileAPI Members

Send Feedback