compressPdf Method

In This Topic

Sends an asynchronous request to compress a PDF file.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new Vintasoft.Imaging.Pdf.WebPdfDocumentCompressorJS();

var value; // Type: any

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

value = instance.compressPdf(fileId, outFilename, successFunc, errorFunc);

function compressPdf(
   fileIdThe name of PDF file that should be compressed.
 : string, 
   outFilenameThe output name of compressed PDF file.
 : 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): The output name of compressed PDF file.
 
 : 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

The name of PDF file that should be compressed.

outFilename

The output name of compressed PDF file.

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): The output name of compressed PDF 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:
- 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

56+

45+

Reference

WebPdfDocumentCompressorJS Class
WebPdfDocumentCompressorJS Members

Send Feedback