openFile(Vintasoft.Shared.WebFileInfoJS,function,function) Method

In This Topic

Sends an asynchronous request to a server, gets information about images, which are stored in files on server, clears the image collection and adds images to the image collection. This 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 fileId; // Type: WebFileInfoJS
var successFunc; // Type: function
var errorFunc; // Type: function

value = instance.openFile(fileId, successFunc, errorFunc);

function openFile(
   fileIdAn instance 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:
  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.
 
 : 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

fileId

An instance 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:

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.

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