getImageFilesInfos(string[],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: string[]
var successFunc; // Type: function

value = instance.getImageFilesInfos(fileIds, successFunc);

function getImageFilesInfos(
   fileIdsAn array of strings, which represent file identifiers.
 : 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:
  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
) : any;

Parameters

fileIds

An array of strings, which represent file identifiers.

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.

Exceptions

Exception	Description
	Thrown if arguments have wrong types.

Browser Compatibility

Reference

WebImageCollectionJS Class
WebImageCollectionJS Members

Send Feedback