PDFreactor JavaScript API Documentation

Parameters

serviceUrl → String

The URL to the PDFreactor Web Service.

Parameters

configuration → Configuration

The configuration.

success → Function(Result)

The success handler with the result as argument.

error → Function(String)

The error handler with the error message as argument.

Reasons:

• No input document was specified in the configuration.
• The supplied configuration was not valid for some reason. See the error message for details.
• The version of the client that was used is outdated and no longer supported. This is only available for the PDFreactor REST wrapper clients.
• The client failed an authorization check, e.g. because a supplied API key was invalid.
• The supplied configuration was accepted by PDFreactor but could not be converted for some reason. See the error message for details.
• No configuration was supplied to the operation.
• The configuration could not be processed and should be re-checked.
• The supplied configuration is valid, however the conversion could not be completed for some reason. See the error message for details.
• A response was received but it could not be identified as a response from the PDFreactor Web Service.
• The PDFreactor Web Service could not be reached.

Parameters

configuration → Configuration

The configuration.

success → Function(String)

The success handler with the document ID as argument.

error → Function(String)

The error handler with the error message as argument.

Reasons:

• No input document was specified in the configuration.
• The supplied configuration was not valid for some reason. See the error message for details.
• The version of the client that was used is outdated and no longer supported. This is only available for the PDFreactor REST wrapper clients.
• The client failed an authorization check, e.g. because a supplied API key was invalid.
• The supplied configuration was accepted by PDFreactor but could not be converted for some reason. See the error message for details.
• No configuration was supplied to the operation.
• The configuration could not be processed and should be re-checked.
• The supplied configuration is valid, however the conversion could not be completed for some reason. See the error message for details.
• Asynchronous conversions are unavailable.
• A response was received but it could not be identified as a response from the PDFreactor Web Service.
• The PDFreactor Web Service could not be reached.

Parameters

documentId → String

The documentId.

success → Function(Progress)

The success handler with the progress as argument.

error → Function(String)

The error handler with the error message as argument.

Reasons:

• The client failed an authorization check, e.g. because a supplied API key was invalid.
• Conversion does not exist
• A response was received but it could not be identified as a response from the PDFreactor Web Service.
• The PDFreactor Web Service could not be reached.

Parameters

documentId → String

The document ID.

success → Function(Result)

The success handler with the result as argument.

error → Function(String)

The error handler with the error message as argument.

Reasons:

• The client failed an authorization check, e.g. because a supplied API key was invalid.
• Conversion does not exist
• A response was received but it could not be identified as a response from the PDFreactor Web Service.
• The PDFreactor Web Service could not be reached.

Parameters

documentId → String

The document ID.

success → Function(Result)

The success handler with the result as argument.

error → Function(String)

The error handler with the error message as argument.

Reasons:

• The client failed an authorization check, e.g. because a supplied API key was invalid.
• Conversion does not exist
• A response was received but it could not be identified as a response from the PDFreactor Web Service.
• The PDFreactor Web Service could not be reached.

Parameters

documentId → String

The document ID.

success → Function()

The success handler.

error → Function(String)

The error handler with the error message as argument.

Reasons:

• The client failed an authorization check, e.g. because a supplied API key was invalid.
• Conversion does not exist
• A response was received but it could not be identified as a response from the PDFreactor Web Service.
• The PDFreactor Web Service could not be reached.

Parameters

success → Function()

The success handler.

error → Function(String)

The error handler with the error message as argument.

Reasons:

• The client failed an authorization check, e.g. because a supplied API key was invalid.
• The PDFreactor Web Service is running but not functional.
• A response was received but it could not be identified as a response from the PDFreactor Web Service.
• The PDFreactor Web Service could not be reached.

Parameters

success → Function(Version)

The success handler with the version as argument.

error → Function(String)

The error handler with the error message as argument.

Parameters

documentId → String

The document ID.

Parameters

documentId → String

The document ID.

addAttachments → Boolean

Enables or disables attachments specified in style sheets.

The default value is false.

addBookmarks → Boolean

Enables or disables bookmarks in the PDF document.

The default value is false.

addComments → Boolean

Enables or disables comments in the PDF document.

The default value is false.

addLinks → Boolean

Enables or disables links in the PDF document.

The default value is false.

addOverprint → Boolean

Enables or disables overprinting.

The default value is false.

addPreviewImages → Boolean

Enables or disables embedding of image previews per page in the PDF document.

The default value is false.

addTags → Boolean

Enables or disables tagging of the PDF document.

The default value is false.

allowAnnotations → Boolean

Enables or disables the 'annotations' restriction in the PDF document.

The default value is false.

allowAssembly → Boolean

Enables or disables the 'assembly' restriction in the PDF document.

The default value is false.

allowCopy → Boolean

Enables or disables the 'copy' restriction in the PDF document.

The default value is false.

allowDegradedPrinting → Boolean

Enables or disables the 'degraded printing' restriction in the PDF document.

The default value is false.

allowFillIn → Boolean

Enables or disables the 'fill in' restriction in the PDF document.

The default value is false.

allowModifyContents → Boolean

Enables or disables the 'modify contents' restriction in the PDF document.

The default value is false.

allowPrinting → Boolean

Enables or disables the 'printing' restriction in the PDF document.

The default value is false.

allowScreenReaders → Boolean

Enables or disables the 'screen readers' restriction in the PDF document.

The default value is false.

appendLog → Boolean

Specifies whether or not the log data should be added to the PDF document.

The default value is false.

attachments → Array<Attachment>

Adds a file attachment to PDF document.

authenticationCredentials → KeyValuePair

Enables access to resources that are secured via Basic or Digest authentication.

author → String

Sets the value of the author field of the PDF document.

baseURL → String

Sets the base URL of the document.

To resolve relative URLs to absolute URLs a reference (base) URL is required. This reference URL is usually the system id of the document.

This method can be used to specify another reference URL. If this URL is not null then it will be used instead of the system id.

The default value is null.

bookletMode → BookletMode

Convenience method to set pages-per-sheet properties and page order in one step to create a booklet.

callbacks → Array<Callback>

Adds callbacks to the conversion which will be called at specific times. All callbacks perform a POST request to the specified URL with the specified content type and a certain model which depends on the callback event.

For each callback, you can specify a timeout. If no timeout is specified, the server's default timeout for callbacks is used. A value of zero or negative values indicate an infinite timeout, however the PDFreactor server may have a maximum timeout configured, in which case that will be the used value.

Some callbacks might be called regularly during the course of a conversion. For these callbacks you can specify an interval to control how frequently they are called.

cleanupTool → Cleanup

Sets the cleanup tool to use for documents with unparsable content.

The Cleanup constants can be used as value. The default value specified is PDFreactor.Cleanup.CYBERNEKO.

The cleanup tool is only used for PDFreactor.Doctype.XHTML. HTML5 utilizes an internal cleanup.

conformance → Conformance

Sets the conformance of the PDF.

The Conformance constants can be used as value. The default value specified is PDFreactor.Conformance.PDF.

contentObserver → ContentObserver

Specifies parts of the document's content that should be observed and logged in greater detail. Data logged this way can be programmatically retrieved after the conversion has finished. The following can be observed:

• Content exceeding boundary containers.

  Use ExceedingContentAnalyze constants to specify which kind of content should be observed for exceeding content logging. The default value is PDFreactor.ExceedingContentAnalyze.NONE.

  Use ExceedingContentAgainst constants to specify that exceeding this content starts exceeding content logging. The default value is PDFreactor.ExceedingContentAgainst.NONE.

• Resources that could not be loaded.
• URL connection attempts made by PDFreactor.

continuousOutput → ContinuousOutput

Enables the conversion of the input document into one image.

conversionName → String

Sets a name for the conversion. If a name is set, it will be logged at level "info". The name can be an arbitrary string but should be unique for every conversion or application so that the log output can be matched to a specific conversion or application later.

cookies → Array<KeyValuePair>

Adds a cookie to all outgoing HTTP connections. The parameters are URL encoded (see Configuration.rawCookies). If the key already exists, the pair is overwritten.

creator → String

Sets the value of creator field of the PDF document.

cssSettings → CssSettings

Specifies the behavior of PDFreactor regarding the support and validation of CSS properties and their declaration. The following modes can be set:

• Do not validate at all, consider all declared style as valid. See PDFreactor.CssPropertySupport.ALL
• Validate all declared styles for properties only supported by PDFreactor. Properties only supported by third party products are not supported/taken as invalid. See PDFreactor.CssPropertySupport.HTML
• Validate all declared styles for properties supported by PDFreactor. Properties only supported by third party products are supported/taken as valid. See PDFreactor.CssPropertySupport.HTML_THIRD_PARTY
• All properties supported by third party products are supported/taken as valid. All declared styles for properties not supported by third party products but supported by PDFreactor will be validated. See PDFreactor.CssPropertySupport.HTML_THIRD_PARTY_LENIENT

customDocumentProperties → Array<KeyValuePair>

Adds a custom property to the PDF document. An existing property of the same name will be replaced.

defaultColorSpace → ColorSpace

Sets whether to convert color key words to CMYK instead of RGB.

The ColorSpace constants can be used as value. The default value specified is PDFreactor.ColorSpace.RGB.

disableFontEmbedding → Boolean

Sets whether fonts will not be embedded into the resulting PDF. Setting this to true will reduce the file size of the output document. However, the resulting PDF documents are no longer guaranteed to look identical on all systems.

The default value is false.

document → Binary | String

The input document. This can either be a URL string, XML or HTML source code string. Alternatively, the input document can be specified directly as Binary or as Base64-encoded string.

documentDefaultLanguage → String

Sets the language used for documents having no explicit language attribute set.

The language code is used to resolve the lang() selector correct and to determine the correct language used for hyphenation.

documentType → Doctype

Sets the document type.

The Doctype constants can be used to specify the document type. The default value specified is PDFreactor.Doctype.AUTODETECT.

enableDebugMode → Boolean

Enables debug mode, which adds additional information to the output.

If enabled, exceptions during the conversion will not be thrown. In such a case, instead of a document a string containing the log and exeption will be returned.

encoding → String

Sets the encoding of the document.

If this value is set to null or it is empty then the encoding will be detected automatically.

The default value is null.

encryption → Encryption

Sets the encryption.

Use one of the Encryption constants to specify the encryption. The default value is PDFreactor.Encryption.NONE.

errorPolicies → Array<ErrorPolicy>

Specifies error policies that will be used for the conversion. Depending on the policy, the conversion will fail if the appropriate criteria are not met.

fontAliases → Array<Font>

Registers an alias font family for an existing font.

This function is limited to fonts loaded automatically from system folders.

fontFallback → Array<String>

Sets a list of fallback font families used for character substitution. This list is iterated for characters that can not be displayed with any of the fonts specified via the CSS property font-family.

fonts → Array<Font>

Loads a font from a URL which can be used via the CSS property font-family.

forceGrayscaleImage → Boolean

If the output format is an image format, this setting controls whether a grayscale image should be returned. This can not be combined with transparency.

fullCompression → Boolean

Enables or disables full compression of the PDF document.

The default value is false.

httpsMode → HttpsMode

Sets the HTTPS mode. In closed environment lenient can be the preferred setting to avoid HTTPS issues that are not security critical

The default value specified is PDFreactor.HttpsMode.STRICT.

ignoreAlpha → Boolean

Sets whether the alpha value of CSS RGBA colors is ignored. This can be used to avoid conformance issues in PDF/A-1.

integrationStyleSheets → Array<Resource>

Adds an integration style sheet to the document.

There are two ways to specify the style sheet:

1. Specifying the style sheet only using an URI.
2. Specifying the style sheet by the content of the style sheet and alternatively setting a URI to resolve relative elements. If no URI is specified then the system id/base URL of the document will be used.

javaScriptMode → JavaScriptMode

Sets the JavaScript Mode.

The default value specified is PDFreactor.JavaScriptMode.DISABLED.

keepDocument → Boolean

If set to true prevents the document from being deleted from the PDFreactor Web Service after it has been accessed. This only works for asynchronous conversions.

keywords → String

Sets the value of the keywords field of the PDF document.

licenseKey → String

Sets the license key using a string. If the license key is set to null then PDFreactor looks for a 'licensekey.xml' file in the same directory where the 'PDFreactor.jar' file is located. If no license key could be found then PDFreactor runs in evaluation mode.

The default value is null.

logExceedingContent → LogExceedingContent

Deprecated

Deprecated as of PDFreactor 9. Use Configuration.contentObserver instead.

logLevel → LogLevel

Sets the log level.

Use one of the LogLevel constants to specify the log level.

The default value is PDFreactor.LogLevel.NONE.

mediaFeatureValues → Array<MediaFeatureValue>

Defines the value of a Media Feature which is used to resolve CSS3 media queries.

mediaTypes → Array<String>

Sets the media types that are used to resolve CSS3 media queries.

Please note that this overrides the default media types of PDFreactor, which are:

print, paged, visual, bitmap, static, -ro-pdfreactor

mergeByteArray → Binary

Deprecated

Deprecated as of PDFreactor 9. Use Configuration.mergeDocuments instead.

mergeByteArrays → Array<byte[]>

Deprecated

Deprecated as of PDFreactor 9. Use Configuration.mergeDocuments instead.

mergeDocuments → Array<Resource>

This method sets external PDF documents which will be merged with the PDF document generated by the HTML source.

mergeMode → MergeMode

Sets the merge mode.

The following merge methods can be used:

• append (PDFreactor.MergeMode.APPEND)
• prepend (PDFreactor.MergeMode.PREPEND)
• overlay above the content of the generated PDF (PDFreactor.MergeMode.OVERLAY)
• overlay below the content of the generated PDF (PDFreactor.MergeMode.OVERLAY_BELOW)

The default value is PDFreactor.MergeMode.APPEND.

mergeURL → String

Deprecated

Deprecated as of PDFreactor 9. Use Configuration.mergeDocuments instead.

mergeURLs → Array<String>

Deprecated

Deprecated as of PDFreactor 9. Use Configuration.mergeDocuments instead.

outputFormat → OutputFormat

Sets the output format. The default value is PDF. For image formats the width or height in pixels must be specified. When either dimension is <1 it is computed based on the other dimension and the aspect ratio of the input document.

outputIntent → OutputIntent

Sets the output intent including the identifier and the ICC profile to be embedded into the PDF.

Set either the profile URL or the profile data, not both. Certain PDF/X formats require neither, just a known identifier.

overlayRepeat → OverlayRepeat

If one of the documents of an overlay process is shorter than the other, this method allows repeating either its last page or all of its pages in order to overlay all pages of the longer document.

Use one of the OBERLAY_REPEAT_ constants to specify the overlay repeat. The default value is PDFreactor.OverlayRepeat.NONE.

ownerPassword → String

Sets the owner password of the PDF document.

The default value is null.

pageOrder → PageOrder | String

Sets the page order of the direct result of the conversion.

If Configuration.mergeMode is set to PDFreactor.MergeMode.ARRANGE, this method is also used to specify the position of inserted pages from an existing PDF.

A description of the syntax can be found in the manual.

pagesPerSheetProperties → PagesPerSheetProperties

Sets the properties of a sheet on which multiple pages are being arranged.

If cols or rows is less than 1, no pages-per-sheet processing is done. This is the case by default.

Use one of the PagesPerSheetDirection constants to specify the the direction. The default value is PDFreactor.PagesPerSheetDirection.RIGHT_DOWN.

pdfScriptAction → Array<PdfScriptAction>

Sets a pair of trigger event and PDF script. The script is triggered on the specified event.

A PDF script is JavaScript that is executed by a PDF viewer (e.g. Adobe Reader). Note that most viewers do not support this feature.

PDF Scripts can also be set by using the proprietary CSS property pdf-script-action. More information on this property can be found in the manual.

Please note, that scripts set via CSS have a higher priority. If two scripts are registered on the same event, but one via API and the other via the CSS property, the script set in the CSS will override the other one.

pixelsPerInch → Integer

Sets the pixels per inch.

Changing this value changes the physical length of sizes specified in px (including those specified via HTML attributes).

The default value is 96ppi.

pixelsPerInchShrinkToFit → Boolean

Whether the pixels per inch should be adapted automatically to avoid content exceeding pages.

postTransformationDocumentType → Doctype

Sets the document type after the XSL-Transformations have been applied.

The Doctype constants can be used to specify the document type. The default value specified is PDFreactor.Doctype.AUTODETECT.

printDialogPrompt → Boolean

Enables or disables a print dialog to be shown upon opening the generated PDF document by a PDF viewer.

The default value is false.

processingPreferences → Array<ProcessingPreferences>

Preferences that influence the conversion process without changing the output

Use the ProcessingPreferences constants to specify the processing preferences. By default no processing preference is set.

rawCookies → Array<KeyValuePair>

Adds a cookie to all outgoing HTTP connections. The parameters are not URL encoded (see Configuration.cookies). If the key already exists, the pair is overwritten.

requestHeaders → Array<KeyValuePair>

Adds a request header to all outgoing HTTP connections. If the key already exists, the pair is overwritten.

resourceRequestTimeout → Integer

Sets a timeout in milliseconds for requests to resources, such as HTTP requests to style sheets, images etc. If the server does not respond until the timeout, the request will be aborted and the resource will not be loaded.

A timeout of 0 means that the request will not time out. A negative value means that no timeout will be set. The default value is 60000 (1min).

signPDF → SignPDF

Sets a digital certificate to sign the newly created PDF.

Requires a keystore file. The included certificate may be self-signed.

Use the KeystoreType constants to specify the keystore type.

Use the SigningMode constants to specify the signing mode.

subject → String

Sets the value of the subject field of the PDF document.

throwLicenseExceptions → Boolean

Deprecated

Deprecated as of PDFreactor 9. Use Configuration.errorPolicies instead.

title → String

Sets the value of the title field of the PDF document.

userPassword → String

Sets the user password of the PDF document.

The default value is null.

userScripts → Array<Resource>

Adds an user script to the document.

There are two ways to specify the script:

1. Specifying the script only by an URI.
2. Specifying the script by the content of the script and alternatively setting a URI to resolve relative elements. If no URI is specified then the system id/base URL of the document will be used.

userStyleSheets → Array<Resource>

Adds a user style sheet to the document.

There are two ways to specify the style sheet:

1. Specifying the style sheet only using an URI.
2. Specifying the style sheet by the content of the style sheet and alternatively setting a URI to resolve relative elements. If no URI is specified then the system id/base URL of the document will be used.

viewerPreferences → Array<ViewerPreferences>

Sets the page layout and page mode preferences of the PDF.

Use the ViewerPreferences constants to specify the viewer preferences. By default no viewer preference is set.

xmp → Xmp

Sets custom XMP to be embedded into the PDF document.

If both content and URI are set to null no custom XMP is embedded. If priority is also set to PDFreactor.XmpPriority.HIGH automatic generation of required XMP is also suppressed. This may cause output PDFs to not archive a specified conformance.

xsltMode → Boolean

Enables or disables XSLT transformations.

Set this value to true to enable XSLT transformations or to false to disable XSLT transformations.

The default value is false.

xsltStyleSheets → Array<Resource>

Adds an XSLT style sheet to the document.

There are two ways to specify the style sheet:

1. Specifying the style sheet only by an URI.
2. Specifying the style sheet by the content of the style sheet and alternatively setting a URI to resolve relative elements. If no URI is specified then the system id/base URL of the document will be used.

data → Binary

The binary content of the attachment. May be null.

description → String

The description of the attachment. If this is null the name is used.

name → String

The file name associated with the attachment. It is recommended to specify the correct file extension. If this is null the name is derived from the URL.

url → String

If data is null, the attachment will be retrieved from this URL. If this is "#" the input document URL is used instead.

rtl → Boolean

Whether or not the reading order of the booklet should be right-to-left.

sheetMargin → String

The sheet margin as CSS margin value, e.g. 1in, 5cm, 10mm 20mm 10mm 30mm. null is interpreted as 0mm.

sheetSize → String

The size of the sheet as CSS value, e.g. A3, letter landscape, 15in 20in, 20cm 30cm.

contentType → ContentType

The content type of the payload that is posted.

interval → Integer

The interval in seconds at which to trigger repeating callbacks. Only applies PDFreactor.CallbackType.PROGRESS.

timeout → Integer

An optional timeout for the callback. A value of zero or negative values are treated as an infinite timeout.

type → CallbackType

The event to trigger the callback.

url → String

The URL to call back.

connected → Boolean

Whether a URL connection could be established by PDFreactor. If this is false, see PDFreactor.Connection.error for details.

duration → Integer

The duration in milliseconds how long this connection remained open.

error → String

The error message if the connection could not be established.

method → String

The request method used by the underlying HTTP request (e.g. "GET", "POST", etc.) or null if this is not an HTTP connection or the connection could not be established.

protocol → String

The protocol of the URL connection.

requestHeaders → KeyValuePair

The request headers.

Note: If a header has multiple values, there will be one KeyValuePair for each value with the header name as key.

responseHeaders → KeyValuePair

The response headers.

Note: If a header has multiple values, there will be one KeyValuePair for each value with the header name as key.

statusCode → Integer

The response code for HTTP connections or 0 for all other connections.

statusMessage → String

The response message for the response code or null if the response code is 0 or the message could not be determined.

timestamp → Integer

The time stamp of this connection.

url → String

The URL.

connections → Boolean

Enables observation of URL connections done by PDFreactor.

exceedingContentAgainst → ExceedingContentAgainst

Enables observation of exceeding content either against the page edges, page content areas or containers.

exceedingContentAnalyze → ExceedingContentAnalyze

Enables observation of exceeding content and optionally of boxes.

missingResources → Boolean

Enables observation of resources that could not be loaded.

height → Integer

Equivalent to the height of a browser window (view port). For values <1 the entire height of the document is used.

width → Integer

Equivalent to the width of a browser window (view port). Values <1 enable paginated output.

supportQueryMode → CssPropertySupport

Adjusts the CSS property support behavior.

validationMode → CssPropertySupport

Adjusts the CSS property validation behavior.

bottom → Boolean

Returns whether the content exceeds the page at the bottom.

box → Boolean

Returns whether the exceeding content is a box instead of text or image content.

containerBottom → Integer

Returns the bottom coordinate of the the container box in the page in pixels. Depending on the settings this box may be the page

containerLeft → Integer

Returns the left coordinate of the the container box in the page in pixels. Depending on the settings this box may be the page

containerRight → Integer

Returns the right coordinate of the the container box in the page in pixels. Depending on the settings this box may be the page

containerTop → Integer

Returns the top coordinate of the the container box in the page in pixels. Depending on the settings this box may be the page

description → String

Returns a description of the content. In case of text content, the text is returned. In case of images the URL is returned if available.

exceedingBoxBottom → Integer

Returns the bottom coordinate of the the exceeding box in the page in pixels.

exceedingBoxLeft → Integer

Returns the left coordinate of the the exceeding box in the page in pixels.

exceedingBoxRight → Integer

Returns the right coordinate of the the exceeding box in the page in pixels.

exceedingBoxTop → Integer

Returns the top coordinate of the the exceeding box in the page in pixels.

html → String

Returns the HTML of the box that contains the exceeding content.

left → Boolean

Returns whether the content exceeds the page to the left.

pageBottom → Integer

Returns the bottom coordinate of the the page in pixels.

pageLeft → Integer

Returns the left coordinate of the the page in pixels.

pageNumber → Integer

Returns the number of the page that contains the exceeding content.

pageRight → Integer

Returns the right coordinate of the the page in pixels.

pageTop → Integer

Returns the top coordinate of the the page in pixels.

path → Integer

Returns an array of integers denoting the indexes of the ancestors of the DOM node corresponding to the box containing the exceeding content, starting from below the root node down to the element itself.

right → Boolean

Returns whether the content exceeds the page to the right.

summary → String

Returns a summary of this exceeding content object.

top → Boolean

Returns whether the content exceeds the page at the top.

bold → Boolean

Whether the alias will be labeled bold.

family → String

The alias name for that font.

italic → Boolean

Whether the alias will be labeled italic.

source → String

The source URL of the font (when adding new fonts) or the name of an existing font family (when creating an alias).

callbackUrl → String

If this object was created for a callback, this property indicates the callback's URL.

contentType → String

The content type of the resulting document as a MIME type string. Depends on what OutputType was set in the Configuration. If none was set, the content type defaults to "application/pdf".

conversionName → String

Returns the name of the conversion if it was specified via Configuration.conversionName.

documentId → String

The document ID of the conversion. This ID can be used to poll the progress or retrieve the result.

documentUrl → String

The relative URL to the location where you can download the generated document once it is finished.

startDate → Date

The date and time when the conversion was started on the server.

key → String

The key

value → String

The value

records → Array<Record>

The log records.

logExceedingContentAgainst → ExceedingContentAgainst

Enables logging of exceeding content either against the page edges, page content areas or containers.

logExceedingContentAnalyze → ExceedingContentAnalyze

Enables logging of exceeding content and optionally of boxes.

level → Integer

The level of the record.

message → String

The logged message.

timestamp → Integer

The timestamp.

mediaFeature → MediaFeature

The media feature.

value → String

The value that is associated with the given media feature.

message → String

The message indicating why the resource could not be found.

resource → String

The resource identifier. Usually a URL string.

type → ResourceType

The type of resource (style sheet, image, etc.).

height → Integer

The height of the output in pixels (image formats only). Values <1 will be computed based on the specified width and the aspect ratio of the input document.

multiImage → Boolean

Indicates whether the image output will be paginated into multiple images.

type → OutputType

the output format. See OutputType constants

width → Integer

The with of the output in pixels (image formats only). Values <1 will be computed based on the specified height and the aspect ratio of the input document.

data → Binary

The profile data

identifier → OutputIntentDefaultProfile | String

The identifier

url → String

The profile URL

cols → Integer

The number of columns per sheet.

direction → PagesPerSheetDirection

The direction in which the pages are ordered on a sheet.

rows → Integer

The number of rows per sheet.

sheetMargin → String

The sheet margin as CSS margin, e.g. 1in, 5cm, 10mm 20mm 10mm 30mm. null is interpreted as 0mm.

sheetSize → String

The sheet size as CSS size, e.g. A4, letter landscape, 15in 20in, 20cm 30cm.

spacing → String

The horizontal and vertical space between pages on a sheet as CSS value, e.g. 1in, 5mm 2mm. null is interpreted as 0mm.

script → String

The script source that should be executed.

triggerEvent → PdfScriptTriggerEvent

The event on which the script is executed. Value is a PdfScriptTriggerEvent constant.

callbackUrl → String

If this object was created for a callback, this property indicates the callback's URL.

contentType → String

The content type of the resulting document as a MIME type string. Depends on what OutputType was set in the Configuration. If none was set, the content type defaults to "application/pdf".

conversionName → String

Returns the name of the conversion if it was specified via Configuration.conversionName.

documentId → String

The document ID of the conversion. This ID can be used to poll the progress or retrieve the result.

documentUrl → String

The relative URL to the location where you can download the generated document once it is finished.

finished → Boolean

Indicates whether the conversion is finished yet.

log → Log

The log of the conversion.

progress → Integer

The current progress of the conversion. The value is between 0 and 100.

startDate → Date

The date and time when the conversion was started on the server.

beforeDocumentScripts → Boolean

Use true to cause PDFreactor to run the script before all scripts inside the document and false to run it after. Only supported for JavaScript-type resources.

content → String

The content of the resource. Only supported for Style Sheet- and Script-type resources.

data → Binary

The binary data of the resource.

uri → String

The URI of the resource.

callbackUrl → String

If this object was created for a callback, this property indicates the callback's URL.

connections → Connection

Provides a log about all URL connections attempted by PDFreactor, including information about HTTP request and result, should the connection be an HTTP or HTTPS connection. Depends on the mode set via Configuration.contentObserver.

contentType → String

The content type of the resulting document as a MIME type string. Depends on what OutputType was set in the Configuration. If none was set, the content type defaults to "application/pdf".

conversionName → String

Returns the name of the conversion if it was specified via Configuration.conversionName.

document → Binary

The resulting PDF or image.

This is not present if only the document's metadata was retrieved.

Alternatively, the input document can be specified directly as Binary or as Base64-encoded string.

documentArray → Array<Binary>

The resulting image as a collection of separate images, each representing a single page. This property is only present if the configuration option "multiImage" was set to true.

This is also not present if only the document's metadata was retrieved.

documentId → String

The document ID of the conversion. This ID can be used to poll the progress or retrieve the result.

documentUrl → String

The relative URL to the location where you can download the generated document once it is finished.

endDate → Date

The date and time when the conversion was finished on the server.

error → String

Returns the error messages that might have been generated during rendering.

exceedingContents → ExceedingContent

Provides information about content exceeding its page or parent. Depends on the mode set via "logExceedingContents".

javaScriptExports → String

Returns data that has been exported from document JavaScript via exports if set, null otherwise. If the JavaScript data is not a string, it will be converted to JSON. If the data can't be converted, a generic string representation is used or null if none is available.

log → Log

Returns the log messages generated during rendering based on the log level.

missingResources → MissingResource

Provides information about resources that could not be loaded during the conversion. Depends on the mode set via Configuration.contentObserver.

numberOfPages → Integer

Returns the number of pages of the document after conversion.

numberOfPagesLiteral → Integer

Returns the number of pages of the resulting PDF (including, e.g., merge operations), otherwise it will return the number pages of the laid out input document.

startDate → Date

The date and time when the conversion was started on the server.

beforeDocumentScripts → Boolean

Use true to cause PDFreactor to run the script before all scripts inside the document and false to run it after. Only supported for JavaScript-type resources.

content → String

The content of the resource. Only supported for Style Sheet- and Script-type resources.

data → Binary

The binary data of the resource.

uri → String

The URI of the resource.

keyAlias → String

The alias of the certificate included in the keystore to be used to sign the PDF.

keystorePassword → String

The password of the keystore.

keystoreType → KeystoreType

The format of the keystore, i.e. pkcs12 or jks. Use one of the KeystoreType constants as value.

keystoreURL → String

The URL to the keystore file.

signingMode → SigningMode

The mode that is used to sign the PDF, i.e. self-signed, Windows certificate or VeriSign. Use one of the SigningMode constants as value.

build → Integer

The build number.

label → String

The label of the version.

major → Integer

The major version.

micro → Integer

The micro version.

minor → Integer

The minor version.

revision → String

The revision number.

content → String

XMP, as an XML string, to be embedded into the PDF document.

priority → XmpPriority

Priority of this XMP over XMP generated automatically for the conformance requirements of certain output formats.

uri → String

URI to XMP to be embedded into the PDF document, if content is null.