Constructor and Description |
---|
PdfToHtmlClient(String userName,
String apiKey)
Constructor for the Pdfcrowd API client.
|
Modifier and Type | Method and Description |
---|---|
byte[] |
convertFile(String file)
Convert a local file.
|
void |
convertFileToFile(String file,
String filePath)
Convert a local file and write the result to a local file.
|
void |
convertFileToStream(String file,
OutputStream outStream)
Convert a local file and write the result to an output stream.
|
byte[] |
convertRawData(byte[] data)
Convert raw data.
|
void |
convertRawDataToFile(byte[] data,
String filePath)
Convert raw data to a file.
|
void |
convertRawDataToStream(byte[] data,
OutputStream outStream)
Convert raw data and write the result to an output stream.
|
byte[] |
convertStream(InputStream inStream)
Convert the contents of an input stream.
|
void |
convertStreamToFile(InputStream inStream,
String filePath)
Convert the contents of an input stream and write the result to a local file.
|
void |
convertStreamToStream(InputStream inStream,
OutputStream outStream)
Convert the contents of an input stream and write the result to an output stream.
|
byte[] |
convertUrl(String url)
Convert a PDF.
|
void |
convertUrlToFile(String url,
String filePath)
Convert a PDF and write the result to a local file.
|
void |
convertUrlToStream(String url,
OutputStream outStream)
Convert a PDF and write the result to an output stream.
|
int |
getConsumedCreditCount()
Get the number of credits consumed by the last conversion.
|
String |
getDebugLogUrl()
Get the URL of the debug log for the last conversion.
|
String |
getJobId()
Get the job id.
|
int |
getOutputSize()
Get the size of the output in bytes.
|
int |
getPageCount()
Get the number of pages in the output document.
|
int |
getRemainingCreditCount()
Get the number of conversion credits available in your account.
|
String |
getVersion()
Get the version details.
|
boolean |
isZippedOutput()
A helper method to determine if the output file is a zip archive.
|
Pdfcrowd.PdfToHtmlClient |
setAuthor(String author)
Set the HTML author.
|
Pdfcrowd.PdfToHtmlClient |
setCssMode(String mode)
Specifies where the style sheets are stored.
|
Pdfcrowd.PdfToHtmlClient |
setDebugLog(boolean value)
Turn on the debug logging.
|
Pdfcrowd.PdfToHtmlClient |
setDpi(int dpi)
Set the output graphics DPI.
|
Pdfcrowd.PdfToHtmlClient |
setFontMode(String mode)
Specifies where the fonts are stored.
|
Pdfcrowd.PdfToHtmlClient |
setForceZip(boolean value)
Enforces the zip output format.
|
Pdfcrowd.PdfToHtmlClient |
setHttpProxy(String proxy)
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTP scheme.
|
Pdfcrowd.PdfToHtmlClient |
setHttpsProxy(String proxy)
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTPS scheme.
|
Pdfcrowd.PdfToHtmlClient |
setImageFormat(String imageFormat)
Specifies the format for the output images.
|
Pdfcrowd.PdfToHtmlClient |
setImageMode(String mode)
Specifies where the images are stored.
|
Pdfcrowd.PdfToHtmlClient |
setKeywords(String keywords)
Associate keywords with the HTML document.
|
Pdfcrowd.PdfToHtmlClient |
setPdfPassword(String password)
Password to open the encrypted PDF file.
|
Pdfcrowd.PdfToHtmlClient |
setPrintPageRange(String pages)
Set the page range to print.
|
Pdfcrowd.PdfToHtmlClient |
setProxy(String host,
int port,
String userName,
String password)
Specifies an HTTP proxy that the API client library will use to connect to the internet.
|
Pdfcrowd.PdfToHtmlClient |
setRetryCount(int count)
Specifies the number of automatic retries when the 502 or 503 HTTP status code is received.
|
Pdfcrowd.PdfToHtmlClient |
setScaleFactor(int factor)
Set the scaling factor (zoom) for the main page area.
|
Pdfcrowd.PdfToHtmlClient |
setSplitLigatures(boolean value)
Converts ligatures, two or more letters combined into a single glyph, back into their individual ASCII characters.
|
Pdfcrowd.PdfToHtmlClient |
setSubject(String subject)
Set the HTML subject.
|
Pdfcrowd.PdfToHtmlClient |
setTag(String tag)
Tag the conversion with a custom value.
|
Pdfcrowd.PdfToHtmlClient |
setTitle(String title)
Set the HTML title.
|
Pdfcrowd.PdfToHtmlClient |
setUseHttp(boolean value)
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
|
Pdfcrowd.PdfToHtmlClient |
setUserAgent(String agent)
Set a custom user agent HTTP header.
|
public byte[] convertUrl(String url)
url
- The address of the PDF to convert. The supported protocols are http:// and https://.public void convertUrlToStream(String url, OutputStream outStream)
url
- The address of the PDF to convert. The supported protocols are http:// and https://.outStream
- The output stream that will contain the conversion output.public void convertUrlToFile(String url, String filePath) throws IOException
url
- The address of the PDF to convert. The supported protocols are http:// and https://.filePath
- The output file path. The string must not be empty. The converter generates an HTML or ZIP file. If ZIP file is generated, the file path must have a ZIP or zip extension.IOException
public byte[] convertFile(String file)
file
- The path to a local file to convert.public void convertFileToStream(String file, OutputStream outStream)
file
- The path to a local file to convert.outStream
- The output stream that will contain the conversion output.public void convertFileToFile(String file, String filePath) throws IOException
file
- The path to a local file to convert.filePath
- The output file path. The string must not be empty. The converter generates an HTML or ZIP file. If ZIP file is generated, the file path must have a ZIP or zip extension.IOException
public byte[] convertRawData(byte[] data)
data
- The raw content to be converted.public void convertRawDataToStream(byte[] data, OutputStream outStream)
data
- The raw content to be converted.outStream
- The output stream that will contain the conversion output.public void convertRawDataToFile(byte[] data, String filePath) throws IOException
data
- The raw content to be converted.filePath
- The output file path. The string must not be empty. The converter generates an HTML or ZIP file. If ZIP file is generated, the file path must have a ZIP or zip extension.IOException
public byte[] convertStream(InputStream inStream) throws IOException
inStream
- The input stream with source data.IOException
public void convertStreamToStream(InputStream inStream, OutputStream outStream) throws IOException
inStream
- The input stream with source data.outStream
- The output stream that will contain the conversion output.IOException
public void convertStreamToFile(InputStream inStream, String filePath) throws IOException
inStream
- The input stream with source data.filePath
- The output file path. The string must not be empty. The converter generates an HTML or ZIP file. If ZIP file is generated, the file path must have a ZIP or zip extension.IOException
public Pdfcrowd.PdfToHtmlClient setPdfPassword(String password)
password
- The input PDF password.public Pdfcrowd.PdfToHtmlClient setScaleFactor(int factor)
factor
- The percentage value. Must be a positive integer number.public Pdfcrowd.PdfToHtmlClient setPrintPageRange(String pages)
pages
- A comma separated list of page numbers or ranges.public Pdfcrowd.PdfToHtmlClient setDpi(int dpi)
dpi
- The DPI value.public Pdfcrowd.PdfToHtmlClient setImageMode(String mode)
mode
- The image storage mode. Allowed values are embed, separate, none.public Pdfcrowd.PdfToHtmlClient setImageFormat(String imageFormat)
imageFormat
- The image format. Allowed values are png, jpg, svg.public Pdfcrowd.PdfToHtmlClient setCssMode(String mode)
mode
- The style sheet storage mode. Allowed values are embed, separate.public Pdfcrowd.PdfToHtmlClient setFontMode(String mode)
mode
- The font storage mode. Allowed values are embed, separate.public Pdfcrowd.PdfToHtmlClient setSplitLigatures(boolean value)
value
- Set to true to split ligatures.public boolean isZippedOutput()
public Pdfcrowd.PdfToHtmlClient setForceZip(boolean value)
value
- Set to true to get the output as a zip archive.public Pdfcrowd.PdfToHtmlClient setTitle(String title)
title
- The HTML title.public Pdfcrowd.PdfToHtmlClient setSubject(String subject)
subject
- The HTML subject.public Pdfcrowd.PdfToHtmlClient setAuthor(String author)
author
- The HTML author.public Pdfcrowd.PdfToHtmlClient setKeywords(String keywords)
keywords
- The string containing the keywords.public Pdfcrowd.PdfToHtmlClient setDebugLog(boolean value)
value
- Set to true to enable the debug logging.public String getDebugLogUrl()
public int getRemainingCreditCount()
public int getConsumedCreditCount()
public String getJobId()
public int getPageCount()
public int getOutputSize()
public String getVersion()
public Pdfcrowd.PdfToHtmlClient setTag(String tag)
tag
- A string with the custom tag.public Pdfcrowd.PdfToHtmlClient setHttpProxy(String proxy)
proxy
- The value must have format DOMAIN_OR_IP_ADDRESS:PORT.public Pdfcrowd.PdfToHtmlClient setHttpsProxy(String proxy)
proxy
- The value must have format DOMAIN_OR_IP_ADDRESS:PORT.public Pdfcrowd.PdfToHtmlClient setUseHttp(boolean value)
value
- Set to true to use HTTP.public Pdfcrowd.PdfToHtmlClient setUserAgent(String agent)
agent
- The user agent string.public Pdfcrowd.PdfToHtmlClient setProxy(String host, int port, String userName, String password)
host
- The proxy hostname.port
- The proxy port.userName
- The username.password
- The password.public Pdfcrowd.PdfToHtmlClient setRetryCount(int count)
count
- Number of retries.Copyright © 2024. All rights reserved.