addFile(string,function) Method
In This Topic
Sends an asynchronous request to a server, gets information about images, which are stored in files on server, and adds images to the image collection. This function uses web service specified by WebServiceJS.defaultImageCollectionService property.
Syntax
var instance = new Vintasoft.Shared.WebImageCollectionJS();
var value; // Type: any
// Parameters
var fileId; // Type: string
var successFunc; // Type: function
value = instance.addFile(fileId, successFunc);
function addFile(
: string,
: Function
) : 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:
- 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.
Exceptions
Exception | Description |
| Thrown if arguments have wrong types. |
Browser Compatibility
See Also