authenticateFile(string,string,function,function) Method
In This Topic
Sends an asynchronous request (using default web service) to a server for checking that specified password is correct for specified file on server.
Syntax
var instance = new Vintasoft.Imaging.VintasoftFileAPI();
var value; // Type: any
// Parameters
var fileId; // Type: string
var filePassword; // Type: string
var successFunc; // Type: function
var errorFunc; // Type: function
value = instance.authenticateFile(fileId, filePassword, successFunc, errorFunc);
function authenticateFile(
: string,
: string,
: Function,
: Function
) : any;
Parameters
- fileId
- A file identifier.
- filePassword
- A file password.
- 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.
- isAuthenticationRequired (boolean): a value indicating whether source image file requres authentication.
- isCorrect (boolean): a value indicating whether password is correct for source image file.
- 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
See Also
