clearCache(function,function) Method

In This Topic

Sends an asynchronous request to a server to clear cache of image collection files on server. Function uses web service specified by the WebServiceJS.defaultAnnotationService property.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new Vintasoft.Imaging.Annotation.WebAnnotationViewCollectionJS();

var value; // Type: any

// Parameters
var successFunc; // Type: function
var errorFunc; // Type: function

value = instance.clearCache(successFunc, errorFunc);

function clearCache(
   successFuncFunction that will be executed if request is executed successfully.
 Here is function prototype "function __success(data)"
 The data parameter has the following properties:
  fileId (string): Image file identifier.
 
 : 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:
  fileId (string): Image file identifier.
 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

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:

fileId (string): Image file identifier.

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:
- fileId (string): Image file identifier.
- 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

56+

45+

Reference

WebAnnotationViewCollectionJS Class
WebAnnotationViewCollectionJS Members

Send Feedback