PDFreactor Ruby API Documentation

Parameters

serviceUrl → String

The URL to the PDFreactor Web Service.

Parameters

configuration → Configuration

The configuration.

connectionSettings → ConnectionSettings

An object containing optional settings for the communication between client and PDFreactor Web Service.

Parameters

configuration → Configuration

The configuration.

connectionSettings → ConnectionSettings

An object containing optional settings for the communication between client and PDFreactor Web Service.

Parameters

configuration → Configuration

The configuration.

stream → IO

The stream to write the resulting document to.

connectionSettings → ConnectionSettings

An object containing optional settings for the communication between client and PDFreactor Web Service.

Parameters

configuration → Configuration

The configuration.

connectionSettings → ConnectionSettings

An object containing optional settings for the communication between client and PDFreactor Web Service.

Parameters

assetPackage → IO

The stream to read the Asset Package from.

connectionSettings → ConnectionSettings

An object containing optional settings for the communication between client and PDFreactor Web Service.

Parameters

assetPackage → IO

The stream to read the Asset Package from.

connectionSettings → ConnectionSettings

An object containing optional settings for the communication between client and PDFreactor Web Service.

Parameters

assetPackage → IO

The stream to read the Asset Package from.

stream → IO

The stream to write the resulting document to.

connectionSettings → ConnectionSettings

An object containing optional settings for the communication between client and PDFreactor Web Service.

Parameters

assetPackage → IO

The stream to read the Asset Package from.

connectionSettings → ConnectionSettings

An object containing optional settings for the communication between client and PDFreactor Web Service.

Parameters

documentId → String

The documentId.

connectionSettings → ConnectionSettings

An object containing optional settings for the communication between client and PDFreactor Web Service.

Parameters

documentId → String

The document ID.

connectionSettings → ConnectionSettings

An object containing optional settings for the communication between client and PDFreactor Web Service.

Parameters

documentId → String

The document ID.

connectionSettings → ConnectionSettings

An object containing optional settings for the communication between client and PDFreactor Web Service.

Parameters

documentId → String

The document ID.

connectionSettings → ConnectionSettings

An object containing optional settings for the communication between client and PDFreactor Web Service.

Parameters

documentId → String

The document ID.

stream → IO

The stream to write the resulting document to.

connectionSettings → ConnectionSettings

An object containing optional settings for the communication between client and PDFreactor Web Service.

Parameters

documentId → String

The document ID.

pageNumber → Integer

The page number.

connectionSettings → ConnectionSettings

An object containing optional settings for the communication between client and PDFreactor Web Service.

Parameters

documentId → String

The document ID.

pageNumber → Integer

The page number.

stream → IO

The stream to write the resulting document to.

connectionSettings → ConnectionSettings

An object containing optional settings for the communication between client and PDFreactor Web Service.

Parameters

documentId → String

The document ID.

connectionSettings → ConnectionSettings

An object containing optional settings for the communication between client and PDFreactor Web Service.

Parameters

connectionSettings → ConnectionSettings

An object containing optional settings for the communication between client and PDFreactor Web Service.

Parameters

connectionSettings → ConnectionSettings

An object containing optional settings for the communication between client and PDFreactor Web Service.

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

Deprecated

Deprecated as of PDFreactor 11. Use Configuration.disableBookmarks instead.

addComments → Boolean

Enables or disables comments in the PDF document.

The default value is false.

addLinks → Boolean

Deprecated

Deprecated as of PDFreactor 11. Use Configuration.disableLinks instead.

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

Deprecated

Deprecated as of PDFreactor 12. Use EncryptionSettings::allowAnnotations instead.

allowAssembly → Boolean

Deprecated

Deprecated as of PDFreactor 12. Use EncryptionSettings::allowAssembly instead.

allowCopy → Boolean

Deprecated

Deprecated as of PDFreactor 12. Use EncryptionSettings::allowCopy instead.

allowDegradedPrinting → Boolean

Deprecated

Deprecated as of PDFreactor 12. Use EncryptionSettings::allowDegradedPrinting instead.

allowFillIn → Boolean

Deprecated

Deprecated as of PDFreactor 12. Use EncryptionSettings::allowFillIn instead.

allowModifyContents → Boolean

Deprecated

Deprecated as of PDFreactor 12. Use EncryptionSettings::allowModifyContents instead.

allowPrinting → Boolean

Deprecated

Deprecated as of PDFreactor 12. Use EncryptionSettings::allowPrinting instead.

allowScreenReaders → Boolean

Deprecated

Deprecated as of PDFreactor 12. Use EncryptionSettings::allowScreenReaders instead.

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

Deprecated

Deprecated as of PDFreactor 12. Use NetworkSettings::authenticationCredentials instead.

author → String

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

baseURL → String

Deprecated

Deprecated as of PDFreactor 11. Use Configuration.baseUrl instead.

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 Cleanup::CYBERNEKO.

The cleanup tool is only used for Configuration.documentType Doctype::XHTML. HTML5 utilizes an internal cleanup.

colorSpaceSettings → ColorSpaceSettings

Specifies color space related settings.

conformance → Conformance

Sets the conformance of the PDF.

The Conformance constants can be used as value. The default value specified is 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 ExceedingContentAnalyze::NONE.

  Use ExceedingContentAgainst constants to specify that exceeding this content starts exceeding content logging. The default value is 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.

conversionTimeout → Integer

Sets a timeout in seconds for the whole document conversion. If the timeout is exceeded, the conversion will be aborted.

A timeout of 0 or negative values mean that the conversion will never time out. This is also the default behavior if no timeout is specified.

cookies → Array(KeyValuePair)

Deprecated

Deprecated as of PDFreactor 12. Use NetworkSettings::cookies instead.

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 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 CssPropertySupport::HTML
• Validate all declared styles for properties supported by PDFreactor. Properties only supported by third party products are supported/taken as valid. See 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 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.

debugSettings → DebugSettings

Enables and configures debug settings, which add 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 exception will be returned.

disableBookmarks → Boolean

Disables bookmarks in the PDF document.

The default value is false.

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.

disableLinks → Boolean

Disables links in the PDF document.

The default value is false.

disablePdfStructureOptimization → Boolean

Disables the automatic optimization and compression of the PDF structure.

The default value is false.

document → Base64 | 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 Base64.

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 Doctype::AUTODETECT.

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

Deprecated

Deprecated as of PDFreactor 12. Use Configuration.encryptionSettings instead.

encryptionSettings → EncryptionSettings

Configures the PDF encryption settings. Specify an owner password and user password to allow or restrict access to certain PDF features such as copying or modifying.

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 to be tried when none of the fonts listed using the CSS property font-family can be found. It is also used in cases of per character font fallback, when none of the specified fonts contain the required character.

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

Deprecated

Deprecated as of PDFreactor 12. Use Configuration.disablePdfStructureOptimization instead.

httpsMode → HttpsMode

Deprecated

Deprecated as of PDFreactor 12. Use SecuritySettings::trustAllConnectionCertificates instead.

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.

inspectableSettings → InspectableSettings

When enabled, makes the converted document inspectable with the PDFreactor Development Tools.

Only works with OutputType::PDF output and requires a license key.

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.

javaScriptSettings → JavaScriptSettings

Specifies JavaScript related settings.

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 either as content or URL. If the license key is set to null then PDFreactor looks for a license key file 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.

logLevel → LogLevel

Sets the log level for the conversion log.

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

The default value is LogLevel::INFO.

logMaxLines → Integer

Sets the maximum amount of log entries that will be retained by the PDFreactor logs.

The default value is 100000.

A capacity of 0 is equivalent to the default value. A negative value means that the capacity will be unlimited.

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"

mergeDocuments → Array(Resource)

Deprecated

Deprecated as of PDFreactor 12. Use MergeSettings::documents instead.

mergeMode → MergeMode

Deprecated

Deprecated as of PDFreactor 12. Use MergeSettings::mode instead.

mergeSettings → MergeSettings

Configures the PDF merge settings. Specify which documents should be merged and how they should be merged (i.e. by appending, prepending or using them as an overlay.

networkSettings → NetworkSettings

Specifies settings for URL connections that PDFreactor establishes during the conversion to load resources.

outputFormat → OutputFormat

Sets the OutputFormat. If not specified, a PDF output format will be used.

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

Deprecated

Deprecated as of PDFreactor 12. Use MergeSettings::overlayRepeat instead.

ownerPassword → String

Deprecated

Deprecated as of PDFreactor 12. Use EncryptionSettings::ownerPassword instead.

pageOrder → PageOrder | String

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

If Configuration.mergeMode is set to 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 PagesPerSheetProperties::cols or PagesPerSheetProperties::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 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 96 ppi.

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 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.

quirksSettings → QuirksSettings

Allows to enable or disable behaviors that are otherwise depend on the doctype of the input document.

rawCookies → Array(KeyValuePair)

Deprecated

Deprecated as of PDFreactor 12. Use NetworkSettings::cookies instead.

requestHeaders → Array(KeyValuePair)

Deprecated

Deprecated as of PDFreactor 12. Use NetworkSettings::requestHeaders instead.

requestPriority → Integer

Specifies the priority of the conversion request. A higher priority means that the web service will adjust the conversion's position in the queue appropriately, so that it is converted before others with lower priority.

By default, asynchronous conversions have a priority of 0, synchronous conversions have a priority of 10.

resourceConnectTimeout → Integer

Deprecated

Deprecated as of PDFreactor 12. Use NetworkSettings::connectTimeout instead.

resourceReadTimeout → Integer

Deprecated

Deprecated as of PDFreactor 12. Use NetworkSettings::readTimeout instead.

segmentationSettings → SegmentationSettings

This property configures segmentation of the conversion, which helps with very large documents.

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 cryptographic filter that is used for signing.

subject → String

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

title → String

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

urlRewriteSettings → UrlRewriteSettings

Specifies settings for URL rewrites, which will transform URLs into others according to certain rules.

userPassword → String

Deprecated

Deprecated as of PDFreactor 12. Use EncryptionSettings::userPassword instead.

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.

Supports various ResourceSubtypes. Supported subtypes are: ResourceSubtype::JAVASCRIPT_CLASSIC, ResourceSubtype::JAVASCRIPT_IMPORTMAP and ResourceSubtype::JAVASCRIPT_MODULE. Other values are treated as ResourceSubtype::JAVASCRIPT_CLASSIC.

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.

validateConformance → Boolean

Enables PDFreactor to validate the generated PDF against the Conformance specified via Configuration.conformance.

Currently only PDF/A and PDF/UA validation is supported.

Please note that validation might take several minutes for larger documents.

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 Xmp::content and Xmp::uri are not set or null no custom XMP is embedded. If XmpPriority is also set to XmpPriority::HIGH automatic generation of required XMP is also suppressed. This may cause output PDFs to not achieve 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 → Base64

The binary content of the attachment. May be null.

description → String

The description of the attachment. If this is not set or null the value of Attachment::name is used.

name → String

The file name associated with the attachment. It is recommended to specify the correct file extension. If this is not set or null the name is derived from Attachment::url.

url → String

If Attachment::data is not set or set to 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, for example "1in", "1cm 1.5cm" or "10mm 20mm 10mm 30mm". null is interpreted as "1cm".

sheetSize → String

The size of the sheet as CSS value, for example "A3", "letter landscape", "15in 20in" or "20cm 30cm". null is interpreted as "A4 landscape".

spacing → String

The horizontal and vertical space between pages on a sheet as CSS value, for example "0.1in". null is interpreted as "1mm".

documents → Array(Document)

An array of documents requests.

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 to CallbackType::PROGRESS.

timeout → Integer

An optional timeout for the callback in milliseconds. 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.

cmykIccProfile → Resource

Specifies the ICC profile which defines the CMYK color space into or from which CSS colors and images are converted, if enabled.

conversionEnabled → Boolean

Enables the conversion of CSS colors and images to the target color space using the specified CMYK ICC profile or naively if there is none.

targetColorSpace → ColorSpace

Specifies the target color-space of the PDF, i.e. the color space that CSS keyword based colors are converted to.

When ColorSpaceSettings::conversionEnabled is true other CSS colors and images are converted as well.

It is also the color space for PDF/A and PDF/X documents.

Defaults to RGB.

cacheStatus → String

If a resource cache is used, indicates a status message concerning the cache status of this resource.

cached → Boolean

Whether the response was retrieved from a cache.

connected → Boolean

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

contentSize → Integer

The amount of content bytes downloaded or read from this connection.

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 (like "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.

requestContentSize → Integer

The amount of content bytes uploaded or written to this connection.

requestHeaders → Array(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.

resourceType → ResourceType

The type of resource (style sheet, image, etc.) transferred over this connection.

responseHeaders → Array(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.

cookies → Hash<String, String>

A collection of name-value-pairs representing the cookies that will be added to the HTTP request to the PDFreactor Web Service. This property is empty by default and additional cookies can be added as required. Cookies should only be added in special environments where it is necessary, e.g. when using a load balancer. If the PDFreactor Web Service's response contains any cookies, they will be added to this property, potentially overwriting cookies with the same name.

headers → Hash<String, String>

A collection of name-value-pairs representing the request headers that will be added to the HTTP request to the PDFreactor Web Service. This property is empty by default and additional headers can be added as required. Headers should only be added in special environments where it is necessary.

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.

domain → String

The domain attribute of the cookie. If null, the cookie is sent to any domain. Specifying no domain is discouraged since cross-domain cookies are not allowed according to the specification, but PDFreactor supports this behavior anyway to remain backwards compatible.

name → String

The name of the cookie. This property must be set or the cookie is considered invalid.

path → String

The path attribute of the cookie. If null, the cookie is sent to any path.

secure → Boolean

The secure attribute of the cookie. The default value is false.

value → String

The value of the cookie. This property must be set or the cookie is considered invalid.

supportQueryMode → CssPropertySupport

Adjusts the CSS property support behavior.

validationMode → CssPropertySupport

Adjusts the CSS property validation behavior.

all → Boolean

This is a convenience property that enables the following DebugSettings:

• DebugSettings::attachDocuments,
• DebugSettings::attachResources,
• DebugSettings::attachLogs,
• DebugSettings::appendLogs,
• DebugSettings::forceResult

appendLogs → Boolean

Specifies whether the logs will be appended to the resulting PDF.

attachConfiguration → Boolean

Specifies whether the configuration will be attached to the generated PDF.

attachDocuments → Boolean

Specifies whether all debug files belonging to the group "documents" will be attached to the generated PDF. Please see the manual for more information.

attachLogs → Boolean

Specifies whether all debug files belonging to the group "logs" will be attached to the generated PDF. Please see the manual for more information.

attachResources → Boolean

Specifies whether all debug files belonging to the group "resources" will be attached to the generated PDF. Please see the manual for more information.

forceResult → Boolean

Forces PDFreactor to return a result, regardless of any exceptions or errors that may have occurred during the conversion.

If an exception or error occurred during the conversion, its stack trace and the PDFreactor log is written as-is into the result data stream. This means that the resulting document will not be a valid PDF but can be opened with an appropriate text editor to view the log and errors.

id → String

The document ID.

name → String

The file name representing the document in the ZIP. If the document is a multi-image, you can use the '#' character in the file name as a placeholder for the page number.

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.

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.

ownerPassword → String

Sets the owner password of the PDF document.

type → Encryption

Sets the encryption.

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

userPassword → String

Sets the user password of the PDF document.

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 → Array(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).

authScheme → HttpAuthScheme

The authentication scheme for which these credentials are intended to be used.

A value of null means any scheme.

host → String

The host for which these credentials are intended to be used.

A value of null means any host.

password → String

The authentication password.

port → Integer

The port for which these credentials are intended to be used.

A value of null or -1 means any port.

protocol → HttpProtocol

The protocol for which these credentials are intended to be used.

A value of null means any protocol.

realm → String

The realm for which these credentials are intended to be used.

A value of null means any realm.

username → String

The authentication user name.

enabled → Boolean

Specifies whether to make the document inspectable.

endPage → Integer

Specifies an optional page number below which the DOM is not inspected.

Page numbers start at 1. The default 0 goes up the last page. Other values are inclusive.

startPage → Integer

Specifies an optional page number below which the DOM is not inspected.

Page numbers start at 1. The default 0 starts at the first page.

level → Integer

The level of the record.

levelName → String

The textual representation of the level.

message → String

The logged message.

sourceLocationInfo → SourceLocationInfo

The logged message.

timestamp → Integer

The timestamp.

debugIndentation → Integer

Specifies the amount of spaces per indentation level when using JavaScript debugging.

The default value is 0.

Note: This setting does not apply to the GraalJS JavaScipt engine.

debugMode → JavaScriptDebugMode

Specifies the debug mode.

Any other value than the default JavaScriptDebugMode::NONE impacts performance significantly and should not be used in production.

Note: This setting does not apply to the GraalJS JavaScipt engine.

disabled → Boolean

Specifies whether to not process JavaScript.

enabled → Boolean

Deprecated

Deprecated as of PDFreactor 12. Use JavaScriptSettings::disabled instead.

ignoreScriptElements → Boolean

Specifies whether to ignore <script> elements in the document, only executing user scripts.

javaScriptEngine → JavaScriptEngine

Sets the JavaScript engine to be used.

maxQueuedTasks → Integer

Specifies the maximum amount of tasks to be queued before ending JavaScript processing.

Values of 0 or less default to 1,000,000.

maxScriptElements → Integer

Specifies the maximum amount of script elements in the document to process.

Values of 0 or less default to 1,000,000.

maxTasksRepeated → Integer

Specifies the maximum number of times that the same task is allowed to be executed, before ending JavaScript processing.

Values of 0 or less default to 1,000.

Note: This setting does not apply to the GraalJS JavaScipt engine.

maxTasksWithoutDomChange → Integer

Specifies the maximum amount of tasks to be allowed to be queued, while the DOM does not change, before ending JavaScript processing.

Values of 0 or less default to 1,000.

maxVirtualTimeOffset → Integer

Specifies the maximum amount of virtual time in seconds to let pass before ending JavaScript processing.

Values of 0 or less default to 3,600 (1h).

noLayout → Boolean

Specifies whether to process JavaScript without causing document layouts or updates.

This can speed up conversions, but will break a significant amount of functionality and libraries.

noVirtualTime → Boolean

Specifies whether not to use virtual time for JavaScript.

Only use if required for a specific library.

statementLimit → Integer

Specifies the maximum amount of JavaScript statements in thousands, which a single task may execute. This limit allows to break out of infinite loops, but setting it too low may abort the conversion process unnecessarily.

When the limit of statements is exceeded, the conversion is aborted with a TimeoutException.

A value of 0 defaults to 1,000,000 (which equates to 1 billion statements per task).

Values smaller than 0 disable the limit.

Note: This setting does not apply to the GraalJS JavaScipt engine.

timeLapse → Boolean

Specifies whether to fast-forward the virtual time of JavaScript every time it is retrieved.

Only use if required for a specific library.

timeout → Integer

Sets a timeout in seconds for JavaScript processing If the timeout is exceeded, the conversion will be aborted.

A timeout of 0 or negative values mean that the conversion will never time out. This is also the default behavior if no timeout is specified.

key → String

The key.

value → String

The value.

records → Array(Record)

The log records of the main PDFreactor log.

recordsCss → Array(Record)

The log records of the PDFreactor CSS log.

recordsJavaScript → Array(JavaScriptRecord)

The log records of the PDFreactor JavaScript log.

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.

mediaFeature → MediaFeature

The media feature.

value → String

The value that is associated with the given media feature.

disableOverlayAnnotations → Boolean

If set to false, the annotations from the documents to be merged will not be included in the final document.

This is automatically disabled when a Conformance level other than Conformance::PDF is specified

documents → Array(Resource)

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

mode → MergeMode

Sets the merge mode.

The following merge methods can be used:

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

The default value is MergeMode::APPEND.

overlayContentDocument → OverlayContentDocument

Determines whether the converted document or the specified PDF document(s) is the content document for overlaying. The size of each overlaid page is taken from the content document, while the other is fit to that. Also PDF tags, if any, are only taken from the content document.

Use one of the OverlayContentDocument constants to specify the overlay content document. The default value is is OverlayContentDocument::CONVERTED.

overlayFit → OverlayFit

Determines how overlay pages that have different dimensions from the pages they are overlaying should be resized.

Use one of the OverlayFit constants to specify the overlay fit. The default value is is OverlayFit::FILL.

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 OverlayRepeat constants to specify the overlay repeat. The default value is OverlayRepeat::NONE.

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.).

authenticationCredentials → Array(HttpCredentials)

Enables access to resources that are secured via HTTP authentication.

connectTimeout → Integer

Sets a timeout in milliseconds for connecting to resources, such as HTTP requests to style sheets, images etc. If the connection could not be established until the timeout expires, the request will be aborted and the resource will not be loaded.

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

cookiePolicy → CookiePolicy

Specifies the cookie handling policy. By default, the policy is browser-like.

cookies → Array(Cookie)

Adds cookies to outgoing HTTP connections.

readTimeout → Integer

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

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

requestHeaders → Array(KeyValuePair)

Sets request headers to all outgoing HTTP connections. If the key already exists, the pair is overwritten.

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 written into one separate image per page.

Defaults to true when using PDFreactor::convert

pixelDensity → Integer

The pixel density of the output (image formats only). When neither 'width' nor 'height' is specified this is used to determine the dimensions of the image from the page size. Values <1 default to 96dpi.

See OutputFormat::pixelDensityUnit for the unit of this value (defaults to DPI).

pixelDensityUnit → ResolutionUnit

The unit of the pixel density. Defaults to dpi.

type → OutputType

The output format. See OutputType constants. Defaults to OutputType::PDF.

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 → Base64

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, for example "1in", "1cm 1.5cm" or "10mm 20mm 10mm 30mm". null is interpreted as "1cm".

sheetSize → String

The sheet size as CSS size, for example "A4", "letter landscape", "15in 20in" or "20cm 30cm". null is interpreted as "A4".

spacing → String

The horizontal and vertical space between pages on a sheet as CSS value, for example "0.1in" or "5mm 2mm". null is interpreted as "1mm".

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.

documentUrls → Array(String)

The relative URLs to the locations where you can download the generated documents once they are 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.

caseSensitiveClassSelectors → QuirksMode

By default in HTML CSS class selectors are case sensitive.

In the default QuirksMode::DETECT mode this behavior is disabled for old HTML doctypes or when there is no doctype.

To enable or disable it independently of the document this property can be set to QuirksMode::STANDARDS or QuirksMode::QUIRKS respectively.

minLineHeightFromContainer → QuirksMode

By default the line-height of text containers, e.g. paragraph elements, is used as the minimum line-height of their lines.

In the default QuirksMode::DETECT mode this behavior is disabled for old HTML doctypes or when there is no doctype.

To enable or disable it independently of the document this property can be set to QuirksMode::STANDARDS or QuirksMode::QUIRKS respectively.

level → Integer

The level of the record.

levelName → String

The textual representation of the level.

message → String

The logged message.

timestamp → Integer

The timestamp.

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 → Base64

The binary data of the resource.

password → String

If this Resource describes a PDF document and this document is protected by an user or owner password, use this method to specify the password the document should be opened with.

subtype → ResourceSubtype

The subtype of this resource. This is only relevant for properties that distinguish between multiple subtypes of resources with the same type, such as JavaScriptSettings.

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 → Array(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 → Base64

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 Base64.

documentArray → Array(Base64)

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.

documentUrls → Array(String)

The relative URLs to the locations where you can download the generated documents once they are 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 → Array(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 ro.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.

keepDocument → Boolean

Indicates whether or not the keepDocument property was set in the Configuration of this conversion. If true, additional requests can be made to retrieve this document.

log → Log

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

missingResources → Array(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.

enabled → Boolean

Enables or disables segmentation.

segmentSize → Integer

The preferred size (in number of pages) of the segments into which the conversion will be split.

Valid values range from 10 to 1000. Values of 0 or less default to 1,000.

keyAlias → String

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

keyPassword → String

The password for the certificate included in the keystore to be used to sign the PDF.

If none is provided, the keystore password will be used for the certificate.

keystorePassword → String

The password of the keystore.

keystoreType → KeystoreType

The format of the keystore, for example PKCS #12 or JKS. Use one of the KeystoreType constants as value.

keystoreURL → String

The URL to the keystore file.

signingMode → SigningMode

The cryptographic filter mode that is used to sign the PDF, like SELF_SIGNED, VERISIGN_SIGNED or WINCER_SIGNED.

Use one of the SigningMode constants as value.

columnEnd → Integer

The end column. A value of zero indicates that the exact column could not be determined.

columnStart → Integer

The start column. A value of zero indicates that the exact column could not be determined.

context → String

The context relative to the source, or null if its the top level context. Can also indicate an element with an appropriate attribute.

lineEnd → Integer

The end line. A value of zero indicates that the exact line could not be determined.

lineStart → Integer

The start line. A value of zero indicates that the exact line could not be determined.

snippet → String

An excerpt of the code that caused the log record.

source → String

The source script file or user script.

pattern → String

The regular expression pattern which is matched against each URL.

Note that the URLs are always absolute. If they are initially relative in the document or other resources, they are resolved.

substitution → String

If a URL matches the UrlRewriteRule::pattern, it is replaced by this substitution. Since the pattern is a regular expression, the substitution can include group identifiers or back references.

rules → Array(UrlRewriteRule)

The rules according to which URLs are rewritten.

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.

text → String

The version as text.

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 Xmp::content is not set or null.

Possible Causes

• This type of exception is thrown by the PDFreactor Web Service client. It has several sub classes, all indicating different issues. To react to specific problems, it is recommended to catch appropriate sub class exceptions.

Possible Causes

• This type of exception is produced by the client and indicates that a connection to the PDFreactor Web Service could not be established. Exceptions of this class do not necessarily indicate a problem with the PDFreactor Web Service, only that it could not be reached. This could have various reasons, including a non-functioning PDFreactor Web Service, a blocking firewall or an incorrectly configured service URL.

Possible Causes

• This type of exception is produced by the PDFreactor Web Service and indicates that the conversion could not be processed for some reason. Exceptions of this class mean that the PDFreactor Web Service is running. Please note that the client requires the 'X-RO-Error-ID' HTTP header to be present to convert the exception in the appropriate type. If that header is missing, exceptions will have this generic type instead.

Additional Properties

Possible Causes

• Asynchronous conversions are not available in this PDFreactor Web Service.

Additional Properties

Possible Causes

• The page number you specified is either below 0 or exceeds the document's total number of pages.

Additional Properties

Possible Causes

• The supplied configuration is valid, however the conversion could not be completed for some reason. See the error message for details.

Additional Properties

Possible Causes

• The configuration could not be processed and should be re-checked.

Additional Properties

Possible Causes

• Conversion does not exist.

Additional Properties

Possible Causes

• The version of the client that was used is outdated and no longer supported. This is only available for the PDFreactor REST clients.

Additional Properties

Possible Causes

• The supplied configuration was not valid for some reason. See the error message for details.

Additional Properties

Possible Causes

• No configuration was supplied to the operation.

Additional Properties

Possible Causes

• No input document was specified in the configuration.

Additional Properties

Possible Causes

• The server could not produce a result with a media type that matches the client's request. The configuration or Accept header should be adjusted accordingly.

Additional Properties

Possible Causes

• The PDFreactor Web Service is running and reachable, but not in a state to perform the requested operation.

Additional Properties

Possible Causes

• The client failed an authorization check, e.g. because a supplied API key was invalid.

Additional Properties

Possible Causes

• The supplied configuration was accepted by PDFreactor but could not be converted for some reason. See the error message for details.

Additional Properties

Possible Causes

• The supplied input data was accepted by PDFreactur but could not be processed for some reason. See the error message for details.

Additional Properties

Possible Causes

• A response was received but it could not be identified as a response from the PDFreactor Web Service.

Possible Causes

• The PDFreactor Web Service could not be reached.