getImageFilesInfos(Vintasoft.Shared.WebFileInfoJS[],function,function,Vintasoft.Shared.WebServiceJS) Method
In This Topic
Sends an asynchronous request to a server and gets information about images, which are stored in files on server.
Syntax
var instance = new Vintasoft.Shared.WebImageCollectionJS();
var value; // Type: any
// Parameters
var fileIds; // Type: WebFileInfoJS[]
var successFunc; // Type: function
var errorFunc; // Type: function
var service; // Type: WebServiceJS
value = instance.getImageFilesInfos(fileIds, successFunc, errorFunc, service);
function getImageFilesInfos(
: WebFileInfoJS[],
: Function,
: Function,
: WebServiceJS
) : 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.
- service
- WebServiceJS which allows to manage an image collection.
Exceptions
Exception | Description |
| Thrown if arguments have wrong types. |
Browser Compatibility
See Also