loadState(function,function,Vintasoft.Shared.WebServiceJS) Method
In This Topic
Sends an asynchronous request to a server for restoring state of image collection from server.
Syntax
var instance = new Vintasoft.Shared.WebImageCollectionJS();
var value; // Type: any
// Parameters
var successFunc; // Type: function
var errorFunc; // Type: function
var service; // Type: WebServiceJS
value = instance.loadState(successFunc, errorFunc, service);
function loadState(
: Function,
: Function,
: WebServiceJS
) : any;
Parameters
- 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 cached image collection.
- 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.
- service
- WebServiceJS which allows to manage an image collection.
Exceptions
Exception | Description |
| Thrown if arguments have wrong types. |
Browser Compatibility
See Also