addFileWithAuthentication(Vintasoft.Shared.WebFileInfoJS,function) Method
In This Topic
Sends an asynchronous request to a server, gets information (with file authentication) about images, which are stored in file on server and adds images to the web document viewer.
Syntax
var instance = new Vintasoft.Imaging.UI.WebDocumentViewerBaseJS(settings);
var value; // Type: any
// Parameters
var fileId; // Type: WebFileInfoJS
var successFunc; // Type: function
value = instance.addFileWithAuthentication(fileId, successFunc);
function addFileWithAuthentication(
: WebFileInfoJS,
: Function
) : any;
Parameters
- fileId
- An instance of WebFileInfoJS class.
- 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 images in image file.
- isAuthenticationRequired (boolean): A value indicating whether current image file requres authentication.
- images (object): An array of WebImageJS objects created using imageInfos property.
Remarks
The method raises the fileOpened event if file is opened successfully.
Example
ThisJavaScriptcodeshowshowtoopenfile,whichisstoredonserverandhavepassword,inwebdocumentviewer:
// add file with authentication - the web document viewer will show the password dialog only if specified password is not correct
docViewer1.addFileWithAuthentication(
new Vintasoft.Shared.WebFileInfoJS("pdfDocumentWithPassword.pdf", 'password'),
function(data) {
console.log("File is opened successfully.");
}
);
Browser Compatibility
See Also
