authenticateFile(function,function) Method
In This Topic
Sends an asynchronous request to a server for authenticating the file using password.
Syntax
var instance = new Vintasoft.Imaging.UI.Panels.WebUiDocumentPasswordPanelJS(settings, fileId);
var value; // Type: any
// Parameters
var successFunc; // Type: function
var errorFunc; // Type: function
value = instance.authenticateFile(successFunc, errorFunc);
function authenticateFile(
: Function,
: 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): A file identifier.
- isAuthenticationRequired (boolean): A value indicating whether the file authentication is required.
- isAuthenticationSucceeded (boolean): A value indicating whether the file authentication is succeeded.
- 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
See Also
