Constructor
function ImageToPdfClient(userName, apiKey)
Constructor for the PDFCrowd API client.
- Parameters:
-
-
userName
- Your username at PDFCrowd. -
apiKey
- Your API key.
-
Conversion Input
function convertUrl(url, callbacks)
Convert an image.
- Parameters:
-
-
url
- The address of the image to convert.- Constraint:
-
- Supported protocols are http:// and https://.
-
callbacks
- The object that defines the following functions:-
data(readStream)
- called when the output data can be read from readStream -
error(message, statusCode)
- called when an error occurs -
end()
- called when the conversion finishes
-
saveToFile(filePath[, callback])
- saves the output data to a file- filePath - the output file path
- callback(err, filePath) - called when the conversion finishes
-
sendPdfInHttpResponse(response[, fileName, disposition])
- sends the generated PDF in an HTTP response- response - the response object
- fileName - the desired file name
- disposition - the response content disposition, can be "attachment" or "inline", the default is "attachment".
-
-
function convertUrlToFile(url, filePath, callback)
Convert an image and write the result to a local file.
- Parameters:
-
-
url
- The address of the image to convert.- Constraint:
-
- Supported protocols are http:// and https://.
-
filePath
- The output file path. -
callback
- Thecallback(error, filePath)
function is called when the conversion finishes. The error object is present if an error occurred, filePath is the output file path.
-
function convertFile(file, callbacks)
Convert a local file.
- Parameters:
-
-
file
- The path to a local file to convert.
- Constraint:
-
- The file must exist and not be empty.
-
callbacks
- The object that defines the following functions:-
data(readStream)
- called when the output data can be read from readStream -
error(message, statusCode)
- called when an error occurs -
end()
- called when the conversion finishes
-
saveToFile(filePath[, callback])
- saves the output data to a file- filePath - the output file path
- callback(err, filePath) - called when the conversion finishes
-
sendPdfInHttpResponse(response[, fileName, disposition])
- sends the generated PDF in an HTTP response- response - the response object
- fileName - the desired file name
- disposition - the response content disposition, can be "attachment" or "inline", the default is "attachment".
-
-
function convertFileToFile(file, filePath, callback)
Convert a local file and write the result to a local file.
- Parameters:
-
-
file
- The path to a local file to convert.
- Constraint:
-
- The file must exist and not be empty.
-
filePath
- The output file path. -
callback
- Thecallback(error, filePath)
function is called when the conversion finishes. The error object is present if an error occurred, filePath is the output file path.
-
function convertRawData(data, callbacks)
Convert raw data.
- Parameters:
-
-
data
(byte[]) - The raw content to be converted. -
callbacks
- The object that defines the following functions:-
data(readStream)
- called when the output data can be read from readStream -
error(message, statusCode)
- called when an error occurs -
end()
- called when the conversion finishes
-
saveToFile(filePath[, callback])
- saves the output data to a file- filePath - the output file path
- callback(err, filePath) - called when the conversion finishes
-
sendPdfInHttpResponse(response[, fileName, disposition])
- sends the generated PDF in an HTTP response- response - the response object
- fileName - the desired file name
- disposition - the response content disposition, can be "attachment" or "inline", the default is "attachment".
-
-
function convertRawDataToFile(data, filePath, callback)
Convert raw data to a file.
- Parameters:
-
-
data
(byte[]) - The raw content to be converted. -
filePath
- The output file path. -
callback
- Thecallback(error, filePath)
function is called when the conversion finishes. The error object is present if an error occurred, filePath is the output file path.
-
function convertStream(inStream, callbacks)
Convert the contents of an input stream.
- Parameters:
-
-
inStream
(InputStream) - The input stream with source data.
-
callbacks
- The object that defines the following functions:-
data(readStream)
- called when the output data can be read from readStream -
error(message, statusCode)
- called when an error occurs -
end()
- called when the conversion finishes
-
saveToFile(filePath[, callback])
- saves the output data to a file- filePath - the output file path
- callback(err, filePath) - called when the conversion finishes
-
sendPdfInHttpResponse(response[, fileName, disposition])
- sends the generated PDF in an HTTP response- response - the response object
- fileName - the desired file name
- disposition - the response content disposition, can be "attachment" or "inline", the default is "attachment".
-
-
function convertStreamToFile(inStream, filePath, callback)
Convert the contents of an input stream and write the result to a local file.
- Parameters:
-
-
inStream
(InputStream) - The input stream with source data.
-
filePath
- The output file path. -
callback
- Thecallback(error, filePath)
function is called when the conversion finishes. The error object is present if an error occurred, filePath is the output file path.
-
Image Operations
Settings used for operations with images.
function setResize(resize)
Resize the image.
- Parameter:
-
-
resize
- The resize percentage or new image dimensions.- Default:
-
100%
-
- Examples:
-
-
Enlarge for high-res display:
setResize("200%")
-
Standard XGA screen resolution:
setResize("1024x768")
-
Enlarge for high-res display:
function setRotate(rotate)
Rotate the image.
- Parameter:
-
-
rotate
- The rotation specified in degrees.
-
function setCropAreaX(x)
Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area.
- Parameter:
-
-
x
- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
- Default:
-
0px
-
- Examples:
-
-
Crop extends beyond left edge:
setCropAreaX("-1in")
-
Skip narrow border area:
setCropAreaX("10mm")
-
Crop extends beyond left edge:
function setCropAreaY(y)
Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area.
- Parameter:
-
-
y
- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
- Default:
-
0px
-
- Examples:
-
-
Crop extends beyond left edge:
setCropAreaY("-1in")
-
Skip narrow border area:
setCropAreaY("10mm")
-
Crop extends beyond left edge:
function setCropAreaWidth(width)
Set the width of the content area. It should be at least 1 inch.
- Parameter:
-
-
width
- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
- Default:
-
The width of the print area.
-
- Examples:
-
-
Standard document crop width:
setCropAreaWidth("8in")
-
Full A4 page width crop:
setCropAreaWidth("210mm")
-
Standard document crop width:
function setCropAreaHeight(height)
Set the height of the content area. It should be at least 1 inch.
- Parameter:
-
-
height
- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
- Default:
-
The height of the print area.
-
- Examples:
-
-
Standard document crop width:
setCropAreaHeight("8in")
-
Full A4 page width crop:
setCropAreaHeight("210mm")
-
Standard document crop width:
function setCropArea(x, y, width, height)
Set the content area position and size. The content area enables to specify the part to be converted.
- Parameters:
-
-
x
- Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area.- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
- Default:
-
0px
-
y
- Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area.- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
- Default:
-
0px
-
width
- Set the width of the content area. It should be at least 1 inch.- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
- Default:
-
The width of the print area.
-
height
- Set the height of the content area. It should be at least 1 inch.- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
- Default:
-
The height of the print area.
-
function setRemoveBorders(value)
Remove borders of an image which does not change in color.
- Parameter:
-
-
value
(bool) - Set totrue
to remove borders.- Default:
-
false
-
Page Setup
function setPageSize(size)
Set the output page size.
- Parameter:
-
-
size
- Allowed Values:
-
-
A0
-
A1
-
A2
-
A3
-
A4
-
A5
-
A6
-
Letter
-
-
function setPageWidth(width)
Set the output page width.
- Parameter:
-
-
width
- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
-
- Examples:
-
-
A4 landscape / A3 portrait width:
setPageWidth("297mm")
-
US Letter/Legal standard width:
setPageWidth("8.5in")
-
A4 landscape / A3 portrait width:
function setPageHeight(height)
Set the output page height.
- Parameter:
-
-
height
- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
-
- Examples:
-
-
A3 standard height for posters:
setPageHeight("420mm")
-
US Letter standard height:
setPageHeight("11in")
-
A3 standard height for posters:
function setPageDimensions(width, height)
Set the output page dimensions. If no page size is specified, margins are applied as a border around the image.
- Parameters:
-
-
width
- Set the output page width.- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
-
height
- Set the output page height.- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
-
- Examples:
-
-
A4 portrait dimensions:
setPageDimensions("210mm", "297mm")
-
US Letter dimensions:
setPageDimensions("8.5in", "11in")
-
A3 portrait dimensions:
setPageDimensions("297mm", "420mm")
-
A4 portrait dimensions:
function setOrientation(orientation)
Set the output page orientation.
- Parameter:
-
-
orientation
- Allowed Values:
-
-
landscape
-
portrait
-
- Default:
-
portrait
-
function setPosition(position)
Set the image position on the page.
- Parameter:
-
-
position
- Allowed Values:
-
-
center
-
top
-
bottom
-
left
-
right
-
top-left
-
top-right
-
bottom-left
-
bottom-right
-
- Default:
-
center
-
function setPrintPageMode(mode)
Set the mode to print the image on the content area of the page.
- Parameter:
-
-
mode
- Allowed Values:
-
-
default
— No image scaling. -
fit
— Fit image to page with aspect ratio. -
stretch
— Stretch image to the page with no aspect ratio.
-
- Default:
-
default
-
function setMarginTop(top)
Set the output page top margin.
- Parameter:
-
-
top
- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
-
- Examples:
-
-
Wide margin for framing:
setMarginTop("1in")
-
Narrow professional margin:
setMarginTop("10mm")
-
Wide margin for framing:
function setMarginRight(right)
Set the output page right margin.
- Parameter:
-
-
right
- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
-
- Examples:
-
-
Wide margin for framing:
setMarginRight("1in")
-
Narrow professional margin:
setMarginRight("10mm")
-
Wide margin for framing:
function setMarginBottom(bottom)
Set the output page bottom margin.
- Parameter:
-
-
bottom
- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
-
- Examples:
-
-
Wide margin for framing:
setMarginBottom("1in")
-
Narrow professional margin:
setMarginBottom("10mm")
-
Wide margin for framing:
function setMarginLeft(left)
Set the output page left margin.
- Parameter:
-
-
left
- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
-
- Examples:
-
-
Wide margin for framing:
setMarginLeft("1in")
-
Narrow professional margin:
setMarginLeft("10mm")
-
Wide margin for framing:
function setPageMargins(top, right, bottom, left)
Set the output page margins.
- Parameters:
-
-
top
- Set the output page top margin.- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
-
right
- Set the output page right margin.- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
-
bottom
- Set the output page bottom margin.- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
-
left
- Set the output page left margin.- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
-
function setPageBackgroundColor(color)
The page background color in RGB or RGBA hexadecimal format. The color fills the entire page regardless of the margins. If not page size is specified and the image format supports background (e.g. PDF, PNG), the background color is applied too.
- Parameter:
-
-
color
- Constraint:
-
- The value must be in RRGGBB or RRGGBBAA hexadecimal format.
-
- Examples:
-
-
red color:
setPageBackgroundColor("FF0000")
-
green color:
setPageBackgroundColor("00ff00")
-
green color with 50% opacity:
setPageBackgroundColor("00ff0080")
-
red color:
function setDpi(dpi)
Set the DPI resolution of the input image. The DPI affects margin options specified in points too (e.g. 1 point is equal to 1 pixel in 96 DPI).
- Parameter:
-
-
dpi
(int) - The DPI value.- Default:
-
96
-
- Example:
-
-
The DPI used for printers. 1 inch contains 300 points:
setDpi(300)
-
The DPI used for printers. 1 inch contains 300 points:
Watermark & Background
function 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")
-
Multi-page PDF for watermarking:
function 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")
-
Download watermark from server:
function 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")
-
Multi-page PDF for watermarking:
function 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")
-
Download watermark from server:
function 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")
-
PDF template background:
function 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")
-
Download template background:
function 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")
-
PDF template background:
function 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")
-
Download template background:
PDF Format
Miscellaneous values for PDF output.
function setLinearize(value)
Create linearized PDF. This is also known as Fast Web View.
- Parameter:
-
-
value
(bool) - Set totrue
to create linearized PDF.- Default:
-
false
-
function setEncrypt(value)
Encrypt the PDF. This prevents search engines from indexing the contents.
- Parameter:
-
-
value
(bool) - Set totrue
to enable PDF encryption.- Default:
-
false
-
function 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")
-
Simple document password:
function 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")
-
Admin access password:
function setNoPrint(value)
Disallow printing of the output PDF.
- Parameter:
-
-
value
(bool) - Set totrue
to set the no-print flag in the output PDF.- Default:
-
false
-
function setNoModify(value)
Disallow modification of the output PDF.
- Parameter:
-
-
value
(bool) - Set totrue
to set the read-only only flag in the output PDF.- Default:
-
false
-
function setNoCopy(value)
Disallow text and graphics extraction from the output PDF.
- Parameter:
-
-
value
(bool) - Set totrue
to set the no-copy flag in the output PDF.- Default:
-
false
-
function setTitle(title)
Set the title of the PDF.
- Parameter:
-
-
title
- The title.
-
- Example:
-
-
Personal CV title:
setTitle("My Resume")
-
Personal CV title:
function setSubject(subject)
Set the subject of the PDF.
- Parameter:
-
-
subject
- The subject.
-
- Example:
-
-
Technical position subject:
setSubject("CV - Software Developer")
-
Technical position subject:
function setKeywords(keywords)
Associate keywords with the document.
- Parameter:
-
-
keywords
- The string with the keywords.
-
- Example:
-
-
Technical skills for searchability:
setKeywords("software developer, Unix, databases")
-
Technical skills for searchability:
Viewer Preferences
These preferences specify how a PDF viewer should present the document. The preferences may be ignored by some PDF viewers.
function 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.
-
-
function 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.
-
-
function setInitialZoomType(zoomType)
Specify how the page should be displayed when opened.
- Parameter:
-
-
zoomType
- 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.
-
-
function 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)
-
Start at second page:
function 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)
-
Half-size zoom level:
function setHideToolbar(value)
Specify whether to hide the viewer application's tool bars when the document is active.
- Parameter:
-
-
value
(bool) - Set totrue
to hide tool bars.- Default:
-
false
-
function 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 totrue
to hide ui elements.- Default:
-
false
-
function setFitWindow(value)
Specify whether to resize the document's window to fit the size of the first displayed page.
- Parameter:
-
-
value
(bool) - Set totrue
to resize the window.- Default:
-
false
-
function setCenterWindow(value)
Specify whether to position the document's window in the center of the screen.
- Parameter:
-
-
value
(bool) - Set totrue
to center the window.- Default:
-
false
-
function 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 totrue
to display the title.- Default:
-
false
-
Miscellaneous
function 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 totrue
to enable the debug logging.- Default:
-
false
-
function getDebugLogUrl() { return string; }
Get the URL of the debug log for the last conversion.
- Returns:
- string - The link to the debug log.
function 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.
function getConsumedCreditCount() { return int; }
Get the number of credits consumed by the last conversion.
- Returns:
- int - The number of credits.
function getJobId() { return string; }
Get the job id.
- Returns:
- string - The unique job identifier.
function getOutputSize() { return int; }
Get the size of the output in bytes.
- Returns:
- int - The count of bytes.
function getVersion() { return string; }
Get the version details.
- Returns:
- string - API version, converter version, and client version.
function 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")
-
Track job in analytics:
function setHttpProxy(proxy)
A proxy server used by the conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
- Parameter:
-
-
proxy
- Constraint:
-
- The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
-
- Examples:
-
-
Corporate proxy server:
setHttpProxy("myproxy.com:8080")
-
Direct IP proxy connection:
setHttpProxy("113.25.84.10:33333")
-
Corporate proxy server:
function setHttpsProxy(proxy)
A proxy server used by the conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
- Parameter:
-
-
proxy
- Constraint:
-
- The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
-
- Examples:
-
-
Secure proxy for HTTPS:
setHttpsProxy("myproxy.com:443")
-
Direct secure proxy IP:
setHttpsProxy("113.25.84.10:44333")
-
Secure proxy for HTTPS:
API Client Options
function 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
-
function setUseHttp(value)
Specify whether to use HTTP or HTTPS when connecting to the PDFCrowd API.
- Parameter:
-
-
value
(bool) - Set totrue
to use HTTP.- Default:
-
false
-
function 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.
-
function setUserAgent(agent)
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_nodejs_client/6.5.2 (https://pdfcrowd.com)
-
function setProxy(host, port, userName, 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. -
userName
- The username. -
password
- The password.
-
function 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)
-
Retry failed requests three times: