downloadImageFile(string,function,function,Vintasoft.Shared.WebServiceJS) Method

In This Topic

Sends an asynchronous request to a server for downloading a file from a server.

Syntax

Javascript (Usage)
Javascript (Specification)

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

var value; // Type: any

// Parameters
var fileId; // Type: string
var successFunc; // Type: function
var errorFunc; // Type: function
var service; // Type: WebServiceJS

value = instance.downloadImageFile(fileId, successFunc, errorFunc, service);

function downloadImageFile(
   fileIdA string, which represents a file identifier.
 : string, 
   successFuncFunction that will be executed if request is executed successfully.
 Here is function prototype "function __success(data)".
 The data parameter has the following properties:
  filename (string): File name.
 blob (object): Blob object that contains file.
 xmlHttpRequest (object): XmlHttpRequest object.
 
 : 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.
 
 if exception is catched inside web service. 
 Otherwise, ProgressEvent object.
 
 : Function, 
   serviceAn instance, of WebServiceJS class, which will serve the request of this function.
 : WebServiceJS
) : any;

Parameters

fileId

A string, which represents a file identifier.

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:

filename (string): File name.
blob (object): Blob object that contains file.
xmlHttpRequest (object): XmlHttpRequest object.

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.
if exception is catched inside web service.
Otherwise, ProgressEvent 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