downloadFile(string,function) Method

In This Topic

Downloads a file from server.

Syntax

Javascript (Usage)
Javascript (Specification)

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

var value; // Type: any

// Parameters
var fileId; // Type: string
var successFunc; // Type: function

value = instance.downloadFile(fileId, successFunc);

function downloadFile(
   fileIdA string that represents the identifier of file that should be downloaded.
 : 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:
  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.
 
 : Function
) : any;

Parameters

fileId

A string that represents the identifier of file that should be downloaded.

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.

Exceptions

Exception	Description
	Thrown if argument has wrong type.

Example

JavaScript

ThisJavaScriptcodeshowshowtodownloadaspecifiedfilefromserver:
                  // download a file from server
                  docViewer1.downloadFile(
                      "pdfDocumentWithPassword.pdf",
                      function(data) {
                          console.log("File is downloaded successfully.");
                      }
                  );

Browser Compatibility

56+

45+

Reference

WebDocumentViewerBaseJS Class
WebDocumentViewerBaseJS Members

Send Feedback