getImageFilesInfos(Vintasoft.Shared.WebFileInfoJS[],function,function) Method

In This Topic

Sends an asynchronous request to a server and gets information about images, which are stored in files on server. Function uses web service specified by WebServiceJS.defaultImageCollectionService property.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new Vintasoft.Shared.WebImageCollectionJS();

var value; // Type: any

// Parameters
var fileIds; // Type: WebFileInfoJS[]
var successFunc; // Type: function
var errorFunc; // Type: function

value = instance.getImageFilesInfos(fileIds, successFunc, errorFunc);

function getImageFilesInfos(
   fileIdsAn array of instances of WebFileInfoJS class.
 : WebFileInfoJS[], 
   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 of informations about images in image files. Information is object with following properties:
  imageInfos (object): Information about images in image file.
 isAuthenticationRequired (boolean): A value indicating whether current image file requres authentication.
 
 
 images (object): An array of WebImageJS objects created using imageInfos property from all files.
 
 : 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
) : any;

Parameters

fileIds

An array of instances of WebFileInfoJS class.

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 of informations about images in image files. Information is object with following properties:
- imageInfos (object): Information about images in image file.
- isAuthenticationRequired (boolean): A value indicating whether current image file requres authentication.
images (object): An array of WebImageJS objects created using imageInfos property from all files.

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.

Exceptions

Exception	Description
	Thrown if arguments have wrong types.

Browser Compatibility

Reference

WebImageCollectionJS Class
WebImageCollectionJS Members

Send Feedback