PDF to PDF / Ruby Reference

class PdfToPdfClient

All setter methods return PdfToPdfClient object unless specified otherwise.

Constructor

def initialize(user_name, api_key)

Constructor for the PDFCrowd API client.

Parameters:
  • user_name - Your username at PDFCrowd.
  • api_key - Your API key.

PDF Manipulation

def setAction(action)

Specifies the action to be performed on the input PDFs.

Parameter:
  • action
    Allowed Values:
    • join — Concatenate input PDFs into a single one.
    • shuffle — Collate pages from input PDFs into a single one, take one page at a time from each input PDF. This is useful when combining two scanned documents containing odd and even pages.
    • extract — Extract pages from input PDF.
    • delete — Delete pages from input PDF.
    Default:
    join

def convert() { return byte[]; }

Perform an action on the input files.

Returns:
byte[] - Byte array containing the output PDF.

def convertToStream(out_stream)

Perform an action on the input files and write the output PDF to an output stream.

Parameter:
  • out_stream (OutputStream) - The output stream that will contain the output PDF.

def convertToFile(file_path)

Perform an action on the input files and write the output PDF to a file.

Parameter:
  • file_path - The output file path.

def addPdfFile(file_path)

Add a PDF file to the list of the input PDFs.

Parameter:
  • file_path - The file path to a local PDF file.
    Constraint:
    • The file must exist and not be empty.

def addPdfRawData(data)

Add in-memory raw PDF data to the list of the input PDFs.
Typical usage is for adding PDF created by another PDFCrowd converter.

Example in PHP:
$clientPdf2Pdf->addPdfRawData($clientHtml2Pdf->convertUrl('http://www.example.com'));

Parameter:
  • data (byte[]) - The raw PDF data.
    Constraint:
    • The input data must be PDF content.

def setInputPdfPassword(password)

Password to open the encrypted PDF file.

Availability:
API client >= 5.4.0, converter >= 20.10. See versioning.
Parameter:
  • password - The input PDF password.

def setPageRange(pages)

Set the page range for extract or delete action.

Parameter:
  • pages
    Constraint:
    • A comma separated list of page numbers or ranges.
Examples:
  • Just the second page is selected: setPageRange("2")
  • The first and the third page are selected: setPageRange("1,3")
  • Everything except the first page is selected: setPageRange("2-")
  • Just first 3 pages are selected: setPageRange("-3")
  • Pages 3, 6, 7, 8 and 9 are selected: setPageRange("3,6-9")

Watermark & Background

def setPageWatermark(watermark)

Apply a watermark to each page of the output PDF file. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark.

Parameter:
  • watermark - The file path to a local file.
    Constraint:
    • The file must exist and not be empty.
Examples:
  • Multi-page PDF for watermarking: setPageWatermark("/home/user/john/watermark.pdf")
  • Transparent PNG overlay: setPageWatermark("/home/user/john/watermark.png")

def setPageWatermarkUrl(url)

Load a file from the specified URL and apply the file as a watermark to each page of the output PDF. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark.

Parameter:
  • url
    Constraint:
    • Supported protocols are http:// and https://.
Examples:
  • Download watermark from server: setPageWatermarkUrl("http://myserver.com/watermark.pdf")
  • Remote logo watermark: setPageWatermarkUrl("http://myserver.com/watermark.png")

def setMultipageWatermark(watermark)

Apply each page of a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.

Parameter:
  • watermark - The file path to a local file.
    Constraint:
    • The file must exist and not be empty.
Examples:
  • Multi-page PDF for watermarking: setMultipageWatermark("/home/user/john/watermark.pdf")
  • Transparent PNG overlay: setMultipageWatermark("/home/user/john/watermark.png")

def setMultipageWatermarkUrl(url)

Load a file from the specified URL and apply each page of the file as a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.

Parameter:
  • url
    Constraint:
    • Supported protocols are http:// and https://.
Examples:
  • Download watermark from server: setMultipageWatermarkUrl("http://myserver.com/watermark.pdf")
  • Remote logo watermark: setMultipageWatermarkUrl("http://myserver.com/watermark.png")

def setPageBackground(background)

Apply a background to each page of the output PDF file. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background.

Parameter:
  • background - The file path to a local file.
    Constraint:
    • The file must exist and not be empty.
Examples:
  • PDF template background: setPageBackground("/home/user/john/background.pdf")
  • Image texture background: setPageBackground("/home/user/john/background.png")

def setPageBackgroundUrl(url)

Load a file from the specified URL and apply the file as a background to each page of the output PDF. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background.

Parameter:
  • url
    Constraint:
    • Supported protocols are http:// and https://.
Examples:
  • Download template background: setPageBackgroundUrl("http://myserver.com/background.pdf")
  • Remote background pattern: setPageBackgroundUrl("http://myserver.com/background.png")

def setMultipageBackground(background)

Apply each page of a background to the corresponding page of the output PDF. A background can be either a PDF or an image.

Parameter:
  • background - The file path to a local file.
    Constraint:
    • The file must exist and not be empty.
Examples:
  • PDF template background: setMultipageBackground("/home/user/john/background.pdf")
  • Image texture background: setMultipageBackground("/home/user/john/background.png")

def setMultipageBackgroundUrl(url)

Load a file from the specified URL and apply each page of the file as a background to the corresponding page of the output PDF. A background can be either a PDF or an image.

Parameter:
  • url
    Constraint:
    • Supported protocols are http:// and https://.
Examples:
  • Download template background: setMultipageBackgroundUrl("http://myserver.com/background.pdf")
  • Remote background pattern: setMultipageBackgroundUrl("http://myserver.com/background.png")

PDF Format

Miscellaneous values for PDF output.

def setLinearize(value)

Create linearized PDF. This is also known as Fast Web View.

Parameter:
  • value (bool) - Set to true to create linearized PDF.
    Default:
    false

def setEncrypt(value)

Encrypt the PDF. This prevents search engines from indexing the contents.

Parameter:
  • value (bool) - Set to true to enable PDF encryption.
    Default:
    false

def setUserPassword(password)

Protect the PDF with a user password. When a PDF has a user password, it must be supplied in order to view the document and to perform operations allowed by the access permissions.

Parameter:
  • password - The user password.
Example:
  • Simple document password: setUserPassword("123456")

def setOwnerPassword(password)

Protect the PDF with an owner password. Supplying an owner password grants unlimited access to the PDF including changing the passwords and access permissions.

Parameter:
  • password - The owner password.
Example:
  • Admin access password: setOwnerPassword("123456")

def setNoPrint(value)

Disallow printing of the output PDF.

Parameter:
  • value (bool) - Set to true to set the no-print flag in the output PDF.
    Default:
    false

def setNoModify(value)

Disallow modification of the output PDF.

Parameter:
  • value (bool) - Set to true to set the read-only only flag in the output PDF.
    Default:
    false

def setNoCopy(value)

Disallow text and graphics extraction from the output PDF.

Parameter:
  • value (bool) - Set to true to set the no-copy flag in the output PDF.
    Default:
    false

def setTitle(title)

Set the title of the PDF.

Parameter:
  • title - The title.
Example:
  • Personal CV title: setTitle("My Resume")

def setSubject(subject)

Set the subject of the PDF.

Parameter:
  • subject - The subject.
Example:
  • Technical position subject: setSubject("CV - Software Developer")

def setAuthor(author)

Set the author of the PDF.

Parameter:
  • author - The author.
Example:
  • Document author name: setAuthor("John Doe")

def setKeywords(keywords)

Associate keywords with the document.

Parameter:
  • keywords - The string with the keywords.
Example:
  • Technical skills for searchability: setKeywords("software developer, Unix, databases")

def setUseMetadataFrom(index)

Use metadata (title, subject, author and keywords) from the n-th input PDF.

Parameter:
  • index (int) - Set the index of the input PDF file from which to use the metadata. 0 means no metadata.
    Constraint:
    • Must be a positive integer or 0.
Example:
  • Use metadata from the first input PDF: setUseMetadataFrom(1)

Viewer Preferences

These preferences specify how a PDF viewer should present the document. The preferences may be ignored by some PDF viewers.

def setPageLayout(layout)

Specify the page layout to be used when the document is opened.

Parameter:
  • layout
    Allowed Values:
    • single-page — Display one page at a time.
    • one-column — Display the pages in one column.
    • two-column-left — Display the pages in two columns, with odd-numbered pages on the left.
    • two-column-right — Display the pages in two columns, with odd-numbered pages on the right.

def setPageMode(mode)

Specify how the document should be displayed when opened.

Parameter:
  • mode
    Allowed Values:
    • full-screen — Full-screen mode.
    • thumbnails — Thumbnail images are visible.
    • outlines — Document outline is visible.

def setInitialZoomType(zoom_type)

Specify how the page should be displayed when opened.

Parameter:
  • zoom_type
    Allowed Values:
    • fit-width — The page content is magnified just enough to fit the entire width of the page within the window.
    • fit-height — The page content is magnified just enough to fit the entire height of the page within the window.
    • fit-page — The page content is magnified just enough to fit the entire page within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the page within the window in the other dimension.

def setInitialPage(page)

Display the specified page when the document is opened.

Parameter:
  • page (int)
    Constraint:
    • Must be a positive integer.
Example:
  • Start at second page: setInitialPage(2)

def setInitialZoom(zoom)

Specify the initial page zoom in percents when the document is opened.

Parameter:
  • zoom (int)
    Constraint:
    • Must be a positive integer.
Example:
  • Half-size zoom level: setInitialZoom(50)

def setHideToolbar(value)

Specify whether to hide the viewer application's tool bars when the document is active.

Parameter:
  • value (bool) - Set to true to hide tool bars.
    Default:
    false

def setHideMenubar(value)

Specify whether to hide the viewer application's menu bar when the document is active.

Parameter:
  • value (bool) - Set to true to hide the menu bar.
    Default:
    false

def setHideWindowUi(value)

Specify whether to hide user interface elements in the document's window (such as scroll bars and navigation controls), leaving only the document's contents displayed.

Parameter:
  • value (bool) - Set to true to hide ui elements.
    Default:
    false

def setFitWindow(value)

Specify whether to resize the document's window to fit the size of the first displayed page.

Parameter:
  • value (bool) - Set to true to resize the window.
    Default:
    false

def setCenterWindow(value)

Specify whether to position the document's window in the center of the screen.

Parameter:
  • value (bool) - Set to true to center the window.
    Default:
    false

def setDisplayTitle(value)

Specify whether the window's title bar should display the document title. If false , the title bar should instead display the name of the PDF file containing the document.

Parameter:
  • value (bool) - Set to true to display the title.
    Default:
    false

def setRightToLeft(value)

Set the predominant reading order for text to right-to-left. This option has no direct effect on the document's contents or page numbering but can be used to determine the relative positioning of pages when displayed side by side or printed n-up

Parameter:
  • value (bool) - Set to true to set right-to-left reading order.
    Default:
    false

Miscellaneous

def setDebugLog(value)

Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.

Parameter:
  • value (bool) - Set to true to enable the debug logging.
    Default:
    false

def getDebugLogUrl() { return string; }

Get the URL of the debug log for the last conversion.

Returns:
string - The link to the debug log.

def getRemainingCreditCount() { return int; }

Get the number of conversion credits available in your account.
This method can only be called after a call to one of the convertXtoY methods.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.

Returns:
int - The number of credits.

def getConsumedCreditCount() { return int; }

Get the number of credits consumed by the last conversion.

Returns:
int - The number of credits.

def getJobId() { return string; }

Get the job id.

Returns:
string - The unique job identifier.

def getPageCount() { return int; }

Get the number of pages in the output document.

Returns:
int - The page count.

def getOutputSize() { return int; }

Get the size of the output in bytes.

Returns:
int - The count of bytes.

def getVersion() { return string; }

Get the version details.

Returns:
string - API version, converter version, and client version.

def setTag(tag)

Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.

Parameter:
  • tag - A string with the custom tag.
Example:
  • Track job in analytics: setTag("client-1234")

API Client Options

def setConverterVersion(version)

Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.

Availability:
API client >= 5.0.0. See versioning.
Parameter:
  • version - The version identifier.
    Allowed Values:
    • 24.04 — Version 24.04.
    • 20.10 — Version 20.10.
    • 18.10 — Version 18.10.
    • latest — Version 20.10 is used.
    Default:
    24.04

def setUseHttp(value)

Specify whether to use HTTP or HTTPS when connecting to the PDFCrowd API.

Parameter:
  • value (bool) - Set to true to use HTTP.
    Default:
    false

def setClientUserAgent(agent)

Specifies the User-Agent HTTP header that the client library will use when interacting with the API.

Availability:
API client >= 6.4.0 See versioning.
Parameter:
  • agent - The user agent string.

def setUserAgent(agent)

Deprecated Replaced with: setClientUserAgent

Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.

Parameter:
  • agent - The user agent string.
    Default:
    pdfcrowd_ruby_client/6.5.3 (https://pdfcrowd.com)

def setProxy(host, port, user_name, password)

Specifies an HTTP proxy that the API client library will use to connect to the internet.

Parameters:
  • host - The proxy hostname.
  • port (int) - The proxy port.
  • user_name - The username.
  • password - The password.

def setRetryCount(count)

Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.

Parameter:
  • count (int) - Number of retries.
    Default:
    1
Example:
  • Retry failed requests three times: setRetryCount(3)