authenticateFile(string,string,function,function) Method

In This Topic

Sends an asynchronous request to authenticate a file with password.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new Vintasoft.Imaging.UI.WebDocumentViewerBaseJS(settings);

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(
   fileIdA file identifier.
 : string, 
   filePasswordA file password.
 : string, 
   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): A file identifier.
 filePassword (string): A file password.
 
 : 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:
  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

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): A file identifier.
filePassword (string): A file password.

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.

Browser Compatibility

56+

45+

Reference

WebDocumentViewerBaseJS Class
WebDocumentViewerBaseJS Members

Send Feedback