Pdfcrowd.HtmlToImageClient (com.pdfcrowd:pdfcrowd 6.5.3 API)

java.lang.Object
- com.pdfcrowd.Pdfcrowd.HtmlToImageClient

Enclosing class:: Pdfcrowd

public static final class Pdfcrowd.HtmlToImageClient
extends Object

Conversion from HTML to image.

Constructor Summary

Constructors
Constructor and Description

HtmlToImageClient(String userName, String apiKey)
Constructor for the PDFCrowd API client.

Constructors
Constructor and Description
`HtmlToImageClient(String userName, String apiKey)` Constructor for the PDFCrowd API client.

Method Summary

All Methods Instance Methods Concrete Methods
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[]`	`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[]`	`convertString(String text)` Convert a string.
`void`	`convertStringToFile(String text, String filePath)` Convert a string and write the output to a file.
`void`	`convertStringToStream(String text, OutputStream outStream)` Convert a string and write the output to an output stream.
`byte[]`	`convertUrl(String url)` Convert a web page.
`void`	`convertUrlToFile(String url, String filePath)` Convert a web page and write the result to a local file.
`void`	`convertUrlToStream(String url, OutputStream outStream)` Convert a web page 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`	`getRemainingCreditCount()` Get the number of conversion credits available in your account.
`String`	`getVersion()` Get the version details.
`Pdfcrowd.HtmlToImageClient`	`setAutoDetectElementToConvert(boolean value)` The main HTML element for conversion is detected automatically.
`Pdfcrowd.HtmlToImageClient`	`setBackgroundColor(String color)` The output image background color.
`Pdfcrowd.HtmlToImageClient`	`setBlockAds(boolean value)` Try to block ads.
`Pdfcrowd.HtmlToImageClient`	`setClientCertificate(String certificate)` A client certificate to authenticate the converter on your web server.
`Pdfcrowd.HtmlToImageClient`	`setClientCertificatePassword(String password)` A password for PKCS12 file with a client certificate if it is needed.
`Pdfcrowd.HtmlToImageClient`	`setClientUserAgent(String agent)` Specifies the User-Agent HTTP header that the client library will use when interacting with the API.
`Pdfcrowd.HtmlToImageClient`	`setConverterUserAgent(String agent)` Specifies the User-Agent HTTP header that will be used by the converter when a request is made to the converted web page.
`Pdfcrowd.HtmlToImageClient`	`setConverterVersion(String version)` Set the converter version.
`Pdfcrowd.HtmlToImageClient`	`setCookies(String cookies)` Set HTTP cookies to be included in all requests made by the converter.
`Pdfcrowd.HtmlToImageClient`	`setCustomCss(String css)` Apply custom CSS to the input HTML document.
`Pdfcrowd.HtmlToImageClient`	`setCustomHttpHeader(String header)` Set a custom HTTP header to be included in all requests made by the converter.
`Pdfcrowd.HtmlToImageClient`	`setCustomJavascript(String javascript)` Run a custom JavaScript after the document is loaded and ready to print.
`Pdfcrowd.HtmlToImageClient`	`setDataAutoEscape(boolean value)` Auto escape HTML symbols in the input data before placing them into the output.
`Pdfcrowd.HtmlToImageClient`	`setDataEncoding(String encoding)` Set the encoding of the data file set by setDataFile.
`Pdfcrowd.HtmlToImageClient`	`setDataFile(String dataFile)` Load the input data for template rendering from the specified file.
`Pdfcrowd.HtmlToImageClient`	`setDataFormat(String dataFormat)` Specify the input data format.
`Pdfcrowd.HtmlToImageClient`	`setDataIgnoreUndefined(boolean value)` Ignore undefined variables in the HTML template.
`Pdfcrowd.HtmlToImageClient`	`setDataOptions(String options)` Set the advanced data options:`csv_delimiter` - The CSV data delimiter, the default is `,`.`xml_remove_root` - Remove the root XML element from the input data.`data_root` - The name of the root element inserted into the input data without a root node (e.g.
`Pdfcrowd.HtmlToImageClient`	`setDataString(String dataString)` Set the input data for template rendering.
`Pdfcrowd.HtmlToImageClient`	`setDataTrimBlocks(boolean value)` Auto trim whitespace around each template command block.
`Pdfcrowd.HtmlToImageClient`	`setDebugLog(boolean value)` Turn on the debug logging.
`Pdfcrowd.HtmlToImageClient`	`setDefaultEncoding(String encoding)` Set the default HTML content text encoding.
`Pdfcrowd.HtmlToImageClient`	`setDisableImageLoading(boolean value)` Do not load images.
`Pdfcrowd.HtmlToImageClient`	`setDisableJavascript(boolean value)` Do not execute JavaScript.
`Pdfcrowd.HtmlToImageClient`	`setDisableRemoteFonts(boolean value)` Disable loading fonts from remote sources.
`Pdfcrowd.HtmlToImageClient`	`setElementToConvert(String selectors)` Convert only the specified element from the main document and its children.
`Pdfcrowd.HtmlToImageClient`	`setElementToConvertMode(String mode)` Specify the DOM handling when only a part of the document is converted.
`Pdfcrowd.HtmlToImageClient`	`setFailOnAnyUrlError(boolean failOnError)` Abort the conversion if any of the sub-request HTTP status code is greater than or equal to 400 or if some sub-requests are still pending.
`Pdfcrowd.HtmlToImageClient`	`setFailOnMainUrlError(boolean failOnError)` Abort the conversion if the main URL HTTP status code is greater than or equal to 400.
`Pdfcrowd.HtmlToImageClient`	`setHttpAuth(String userName, String password)` Set credentials to access HTTP base authentication protected websites.
`Pdfcrowd.HtmlToImageClient`	`setHttpAuthPassword(String password)`
`Pdfcrowd.HtmlToImageClient`	`setHttpAuthUserName(String userName)`
`Pdfcrowd.HtmlToImageClient`	`setHttpProxy(String proxy)` A proxy server used by the conversion process for accessing the source URLs with HTTP scheme.
`Pdfcrowd.HtmlToImageClient`	`setHttpsProxy(String proxy)` A proxy server used by the conversion process for accessing the source URLs with HTTPS scheme.
`Pdfcrowd.HtmlToImageClient`	`setJavascriptDelay(int delay)` Wait the specified number of milliseconds to finish all JavaScript after the document is loaded.
`Pdfcrowd.HtmlToImageClient`	`setLoadIframes(String iframes)` Specifies how iframes are handled.
`Pdfcrowd.HtmlToImageClient`	`setLocale(String locale)` Set the locale for the conversion.
`Pdfcrowd.HtmlToImageClient`	`setMaxLoadingTime(int maxTime)` Set the maximum time to load the page and its resources.
`Pdfcrowd.HtmlToImageClient`	`setNoBackground(boolean value)` Do not print the background graphics.
`Pdfcrowd.HtmlToImageClient`	`setNoXpdfcrowdHeader(boolean value)` Do not send the X-Pdfcrowd HTTP header in PDFCrowd HTTP requests.
`Pdfcrowd.HtmlToImageClient`	`setOnLoadJavascript(String javascript)` Run a custom JavaScript right after the document is loaded.
`Pdfcrowd.HtmlToImageClient`	`setOutputFormat(String outputFormat)` The format of the output file.
`Pdfcrowd.HtmlToImageClient`	`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.HtmlToImageClient`	`setReadabilityEnhancements(String enhancements)` The input HTML is automatically enhanced to improve the readability.
`Pdfcrowd.HtmlToImageClient`	`setRetryCount(int count)` Specifies the number of automatic retries when the 502 or 503 HTTP status code is received.
`Pdfcrowd.HtmlToImageClient`	`setScaleFactor(int factor)` Set the scaling factor (zoom) for the output image.
`Pdfcrowd.HtmlToImageClient`	`setScreenshotHeight(int height)` Set the output image height in pixels.
`Pdfcrowd.HtmlToImageClient`	`setScreenshotWidth(int width)` Set the output image width in pixels.
`Pdfcrowd.HtmlToImageClient`	`setSubprocessReferrer(String referrer)`
`Pdfcrowd.HtmlToImageClient`	`setTag(String tag)` Tag the conversion with a custom value.
`Pdfcrowd.HtmlToImageClient`	`setUseHttp(boolean value)` Specify whether to use HTTP or HTTPS when connecting to the PDFCrowd API.
`Pdfcrowd.HtmlToImageClient`	`setUseMobileUserAgent(boolean value)` Use a mobile user agent.
`Pdfcrowd.HtmlToImageClient`	`setUsePrintMedia(boolean value)` Use the print version of the page if available (@media print).
`Pdfcrowd.HtmlToImageClient`	`setUserAgent(String agent)` Set a custom user agent HTTP header.
`Pdfcrowd.HtmlToImageClient`	`setVerifySslCertificates(boolean value)` Do not allow insecure HTTPS connections.
`Pdfcrowd.HtmlToImageClient`	`setWaitForElement(String selectors)` Wait for the specified element in a source document.
`Pdfcrowd.HtmlToImageClient`	`setZipMainFilename(String filename)` Set the file name of the main HTML document stored in the input archive.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HtmlToImageClient
```
public HtmlToImageClient(String userName,
                         String apiKey)
```
    Constructor for the PDFCrowd API client.
    
    Parameters:
    
    userName - Your username at PDFCrowd.
    
    apiKey - Your API key.
- Method Detail
  - setOutputFormat
```
public Pdfcrowd.HtmlToImageClient setOutputFormat(String outputFormat)
```
    The format of the output file.
    
    Parameters:
    
    outputFormat - Allowed values are png, jpg, gif, tiff, bmp, ico, ppm, pgm, pbm, pnm, psb, pct, ras, tga, sgi, sun, webp.
    
    Returns:
    
    The converter object.
  - convertUrl
```
public byte[] convertUrl(String url)
```
    Convert a web page.
    
    Parameters:
    
    url - The address of the web page to convert. Supported protocols are http:// and https://.
    
    Returns:
    
    Byte array containing the conversion output.
  - convertUrlToStream
```
public void convertUrlToStream(String url,
                               OutputStream outStream)
```
    Convert a web page and write the result to an output stream.
    
    Parameters:
    
    url - The address of the web page to convert. Supported protocols are http:// and https://.
    
    outStream - The output stream that will contain the conversion output.
  - convertUrlToFile
```
public void convertUrlToFile(String url,
                             String filePath)
                      throws IOException
```
    Convert a web page and write the result to a local file.
    
    Parameters:
    
    url - The address of the web page to convert. Supported protocols are http:// and https://.
    
    filePath - The output file path. The string must not be empty.
    
    Throws:
    
    IOException
  - convertFile
```
public byte[] convertFile(String file)
```
    Convert a local file.
    
    Parameters:
    
    file - The path to a local file to convert.
    The file can be either a single file or an archive (.tar.gz, .tar.bz2, or .zip).
    If the HTML document refers to local external assets (images, style sheets, javascript), zip the document together with the assets. The file must exist and not be empty. The file name must have a valid extension.
    
    Returns:
    
    Byte array containing the conversion output.
  - convertFileToStream
```
public void convertFileToStream(String file,
                                OutputStream outStream)
```
    Convert a local file and write the result to an output stream.
    
    Parameters:
    
    file - The path to a local file to convert.
    The file can be either a single file or an archive (.tar.gz, .tar.bz2, or .zip).
    If the HTML document refers to local external assets (images, style sheets, javascript), zip the document together with the assets. The file must exist and not be empty. The file name must have a valid extension.
    
    outStream - The output stream that will contain the conversion output.
  - convertFileToFile
```
public void convertFileToFile(String file,
                              String filePath)
                       throws IOException
```
    Convert a local file and write the result to a local file.
    
    Parameters:
    
    file - The path to a local file to convert.
    The file can be either a single file or an archive (.tar.gz, .tar.bz2, or .zip).
    If the HTML document refers to local external assets (images, style sheets, javascript), zip the document together with the assets. The file must exist and not be empty. The file name must have a valid extension.
    
    filePath - The output file path. The string must not be empty.
    
    Throws:
    
    IOException
  - convertString
```
public byte[] convertString(String text)
```
    Convert a string.
    
    Parameters:
    
    text - The string content to convert. The string must not be empty.
    
    Returns:
    
    Byte array containing the conversion output.
  - convertStringToStream
```
public void convertStringToStream(String text,
                                  OutputStream outStream)
```
    Convert a string and write the output to an output stream.
    
    Parameters:
    
    text - The string content to convert. The string must not be empty.
    
    outStream - The output stream that will contain the conversion output.
  - convertStringToFile
```
public void convertStringToFile(String text,
                                String filePath)
                         throws IOException
```
    Convert a string and write the output to a file.
    
    Parameters:
    
    text - The string content to convert. The string must not be empty.
    
    filePath - The output file path. The string must not be empty.
    
    Throws:
    
    IOException
  - convertStream
```
public byte[] convertStream(InputStream inStream)
                     throws IOException
```
    Convert the contents of an input stream.
    
    Parameters:
    
    inStream - The input stream with source data.
    The stream can contain either HTML code or an archive (.zip, .tar.gz, .tar.bz2).
    The archive can contain HTML code and its external assets (images, style sheets, javascript).
    
    Returns:
    
    Byte array containing the conversion output.
    
    Throws:
    
    IOException
  - convertStreamToStream
```
public void convertStreamToStream(InputStream inStream,
                                  OutputStream outStream)
                           throws IOException
```
    Convert the contents of an input stream and write the result to an output stream.
    
    Parameters:
    
    inStream - The input stream with source data.
    The stream can contain either HTML code or an archive (.zip, .tar.gz, .tar.bz2).
    The archive can contain HTML code and its external assets (images, style sheets, javascript).
    
    outStream - The output stream that will contain the conversion output.
    
    Throws:
    
    IOException
  - convertStreamToFile
```
public void convertStreamToFile(InputStream inStream,
                                String filePath)
                         throws IOException
```
    Convert the contents of an input stream and write the result to a local file.
    
    Parameters:
    
    inStream - The input stream with source data.
    The stream can contain either HTML code or an archive (.zip, .tar.gz, .tar.bz2).
    The archive can contain HTML code and its external assets (images, style sheets, javascript).
    
    filePath - The output file path. The string must not be empty.
    
    Throws:
    
    IOException
  - setZipMainFilename
```
public Pdfcrowd.HtmlToImageClient setZipMainFilename(String filename)
```
    Set the file name of the main HTML document stored in the input archive. If not specified, the first HTML file in the archive is used for conversion. Use this method if the input archive contains multiple HTML documents.
    
    Parameters:
    
    filename - The file name.
    
    Returns:
    
    The converter object.
  - setScreenshotWidth
```
public Pdfcrowd.HtmlToImageClient setScreenshotWidth(int width)
```
    Set the output image width in pixels.
    
    Parameters:
    
    width - The accepted range is 96-65000.
    
    Returns:
    
    The converter object.
  - setScreenshotHeight
```
public Pdfcrowd.HtmlToImageClient setScreenshotHeight(int height)
```
    Set the output image height in pixels. If it is not specified, actual document height is used.
    
    Parameters:
    
    height - Must be a positive integer.
    
    Returns:
    
    The converter object.
  - setScaleFactor
```
public Pdfcrowd.HtmlToImageClient setScaleFactor(int factor)
```
    Set the scaling factor (zoom) for the output image.
    
    Parameters:
    
    factor - The percentage value. Must be a positive integer.
    
    Returns:
    
    The converter object.
  - setBackgroundColor
```
public Pdfcrowd.HtmlToImageClient setBackgroundColor(String color)
```
    The output image background color.
    
    Parameters:
    
    color - The value must be in RRGGBB or RRGGBBAA hexadecimal format.
    
    Returns:
    
    The converter object.
  - setUsePrintMedia
```
public Pdfcrowd.HtmlToImageClient setUsePrintMedia(boolean value)
```
    Use the print version of the page if available (@media print).
    
    Parameters:
    
    value - Set to true to use the print version of the page.
    
    Returns:
    
    The converter object.
  - setNoBackground
```
public Pdfcrowd.HtmlToImageClient setNoBackground(boolean value)
```
    Do not print the background graphics.
    
    Parameters:
    
    value - Set to true to disable the background graphics.
    
    Returns:
    
    The converter object.
  - setDisableJavascript
```
public Pdfcrowd.HtmlToImageClient setDisableJavascript(boolean value)
```
    Do not execute JavaScript.
    
    Parameters:
    
    value - Set to true to disable JavaScript in web pages.
    
    Returns:
    
    The converter object.
  - setDisableImageLoading
```
public Pdfcrowd.HtmlToImageClient setDisableImageLoading(boolean value)
```
    Do not load images.
    
    Parameters:
    
    value - Set to true to disable loading of images.
    
    Returns:
    
    The converter object.
  - setDisableRemoteFonts
```
public Pdfcrowd.HtmlToImageClient setDisableRemoteFonts(boolean value)
```
    Disable loading fonts from remote sources.
    
    Parameters:
    
    value - Set to true disable loading remote fonts.
    
    Returns:
    
    The converter object.
  - setUseMobileUserAgent
```
public Pdfcrowd.HtmlToImageClient setUseMobileUserAgent(boolean value)
```
    Use a mobile user agent.
    
    Parameters:
    
    value - Set to true to use a mobile user agent.
    
    Returns:
    
    The converter object.
  - setLoadIframes
```
public Pdfcrowd.HtmlToImageClient setLoadIframes(String iframes)
```
    Specifies how iframes are handled.
    
    Parameters:
    
    iframes - Allowed values are all, same-origin, none.
    
    Returns:
    
    The converter object.
  - setBlockAds
```
public Pdfcrowd.HtmlToImageClient setBlockAds(boolean value)
```
    Try to block ads. Enabling this option can produce smaller output and speed up the conversion.
    
    Parameters:
    
    value - Set to true to block ads in web pages.
    
    Returns:
    
    The converter object.
  - setDefaultEncoding
```
public Pdfcrowd.HtmlToImageClient setDefaultEncoding(String encoding)
```
    Set the default HTML content text encoding.
    
    Parameters:
    
    encoding - The text encoding of the HTML content.
    
    Returns:
    
    The converter object.
  - setLocale
```
public Pdfcrowd.HtmlToImageClient setLocale(String locale)
```
    Set the locale for the conversion. This may affect the output format of dates, times and numbers.
    
    Parameters:
    
    locale - The locale code according to ISO 639.
    
    Returns:
    
    The converter object.
  - setHttpAuthUserName
```
public Pdfcrowd.HtmlToImageClient setHttpAuthUserName(String userName)
```
  - setHttpAuthPassword
```
public Pdfcrowd.HtmlToImageClient setHttpAuthPassword(String password)
```
  - setHttpAuth
```
public Pdfcrowd.HtmlToImageClient setHttpAuth(String userName,
                                              String password)
```
    Set credentials to access HTTP base authentication protected websites.
    
    Parameters:
    
    userName - Set the HTTP authentication user name.
    
    password - Set the HTTP authentication password.
    
    Returns:
    
    The converter object.
  - setCookies
```
public Pdfcrowd.HtmlToImageClient setCookies(String cookies)
```
    Set HTTP cookies to be included in all requests made by the converter.
    
    Parameters:
    
    cookies - The cookie string.
    
    Returns:
    
    The converter object.
  - setVerifySslCertificates
```
public Pdfcrowd.HtmlToImageClient setVerifySslCertificates(boolean value)
```
    Do not allow insecure HTTPS connections.
    
    Parameters:
    
    value - Set to true to enable SSL certificate verification.
    
    Returns:
    
    The converter object.
  - setFailOnMainUrlError
```
public Pdfcrowd.HtmlToImageClient setFailOnMainUrlError(boolean failOnError)
```
    Abort the conversion if the main URL HTTP status code is greater than or equal to 400.
    
    Parameters:
    
    failOnError - Set to true to abort the conversion.
    
    Returns:
    
    The converter object.
  - setFailOnAnyUrlError
```
public Pdfcrowd.HtmlToImageClient setFailOnAnyUrlError(boolean failOnError)
```
    Abort the conversion if any of the sub-request HTTP status code is greater than or equal to 400 or if some sub-requests are still pending. See details in a debug log.
    
    Parameters:
    
    failOnError - Set to true to abort the conversion.
    
    Returns:
    
    The converter object.
  - setNoXpdfcrowdHeader
```
public Pdfcrowd.HtmlToImageClient setNoXpdfcrowdHeader(boolean value)
```
    Do not send the X-Pdfcrowd HTTP header in PDFCrowd HTTP requests.
    
    Parameters:
    
    value - Set to true to disable sending X-Pdfcrowd HTTP header.
    
    Returns:
    
    The converter object.
  - setCustomCss
```
public Pdfcrowd.HtmlToImageClient setCustomCss(String css)
```
    Apply custom CSS to the input HTML document. It allows you to modify the visual appearance and layout of your HTML content dynamically. Tip: Using !important in custom CSS provides a way to prioritize and override conflicting styles.
    
    Parameters:
    
    css - A string containing valid CSS. The string must not be empty.
    
    Returns:
    
    The converter object.
  - setCustomJavascript
```
public Pdfcrowd.HtmlToImageClient setCustomJavascript(String javascript)
```
    Run a custom JavaScript after the document is loaded and ready to print. The script is intended for post-load DOM manipulation (add/remove elements, update CSS, ...). In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our JavaScript library.
    
    Parameters:
    
    javascript - A string containing a JavaScript code. The string must not be empty.
    
    Returns:
    
    The converter object.
  - setOnLoadJavascript
```
public Pdfcrowd.HtmlToImageClient setOnLoadJavascript(String javascript)
```
    Run a custom JavaScript right after the document is loaded. The script is intended for early DOM manipulation (add/remove elements, update CSS, ...). In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our JavaScript library.
    
    Parameters:
    
    javascript - A string containing a JavaScript code. The string must not be empty.
    
    Returns:
    
    The converter object.
  - setCustomHttpHeader
```
public Pdfcrowd.HtmlToImageClient setCustomHttpHeader(String header)
```
    Set a custom HTTP header to be included in all requests made by the converter.
    
    Parameters:
    
    header - A string containing the header name and value separated by a colon.
    
    Returns:
    
    The converter object.
  - setJavascriptDelay
```
public Pdfcrowd.HtmlToImageClient setJavascriptDelay(int delay)
```
    Wait the specified number of milliseconds to finish all JavaScript after the document is loaded. Your license defines the maximum wait time by "Max Delay" parameter.
    
    Parameters:
    
    delay - The number of milliseconds to wait. Must be a positive integer or 0.
    
    Returns:
    
    The converter object.
  - setElementToConvert
```
public Pdfcrowd.HtmlToImageClient setElementToConvert(String selectors)
```
    Convert only the specified element from the main document and its children. The element is specified by one or more CSS selectors. If the element is not found, the conversion fails. If multiple elements are found, the first one is used.
    
    Parameters:
    
    selectors - One or more CSS selectors separated by commas. The string must not be empty.
    
    Returns:
    
    The converter object.
  - setElementToConvertMode
```
public Pdfcrowd.HtmlToImageClient setElementToConvertMode(String mode)
```
    Specify the DOM handling when only a part of the document is converted. This can affect the CSS rules used.
    
    Parameters:
    
    mode - Allowed values are cut-out, remove-siblings, hide-siblings.
    
    Returns:
    
    The converter object.
  - setWaitForElement
```
public Pdfcrowd.HtmlToImageClient setWaitForElement(String selectors)
```
    Wait for the specified element in a source document. The element is specified by one or more CSS selectors. The element is searched for in the main document and all iframes. If the element is not found, the conversion fails. Your license defines the maximum wait time by "Max Delay" parameter.
    
    Parameters:
    
    selectors - One or more CSS selectors separated by commas. The string must not be empty.
    
    Returns:
    
    The converter object.
  - setAutoDetectElementToConvert
```
public Pdfcrowd.HtmlToImageClient setAutoDetectElementToConvert(boolean value)
```
    The main HTML element for conversion is detected automatically.
    
    Parameters:
    
    value - Set to true to detect the main element.
    
    Returns:
    
    The converter object.
  - setReadabilityEnhancements
```
public Pdfcrowd.HtmlToImageClient setReadabilityEnhancements(String enhancements)
```
    The input HTML is automatically enhanced to improve the readability.
    
    Parameters:
    
    enhancements - Allowed values are none, readability-v1, readability-v2, readability-v3, readability-v4.
    
    Returns:
    
    The converter object.
  - setDataString
```
public Pdfcrowd.HtmlToImageClient setDataString(String dataString)
```
    Set the input data for template rendering. The data format can be JSON, XML, YAML or CSV.
    
    Parameters:
    
    dataString - The input data string.
    
    Returns:
    
    The converter object.
  - setDataFile
```
public Pdfcrowd.HtmlToImageClient setDataFile(String dataFile)
```
    Load the input data for template rendering from the specified file. The data format can be JSON, XML, YAML or CSV.
    
    Parameters:
    
    dataFile - The file path to a local file containing the input data.
    
    Returns:
    
    The converter object.
  - setDataFormat
```
public Pdfcrowd.HtmlToImageClient setDataFormat(String dataFormat)
```
    Specify the input data format.
    
    Parameters:
    
    dataFormat - The data format. Allowed values are auto, json, xml, yaml, csv.
    
    Returns:
    
    The converter object.
  - setDataEncoding
```
public Pdfcrowd.HtmlToImageClient setDataEncoding(String encoding)
```
    Set the encoding of the data file set by setDataFile.
    
    Parameters:
    
    encoding - The data file encoding.
    
    Returns:
    
    The converter object.
  - setDataIgnoreUndefined
```
public Pdfcrowd.HtmlToImageClient setDataIgnoreUndefined(boolean value)
```
    Ignore undefined variables in the HTML template. The default mode is strict so any undefined variable causes the conversion to fail. You can use {% if variable is defined %} to check if the variable is defined.
    
    Parameters:
    
    value - Set to true to ignore undefined variables.
    
    Returns:
    
    The converter object.
  - setDataAutoEscape
```
public Pdfcrowd.HtmlToImageClient setDataAutoEscape(boolean value)
```
    Auto escape HTML symbols in the input data before placing them into the output.
    
    Parameters:
    
    value - Set to true to turn auto escaping on.
    
    Returns:
    
    The converter object.
  - setDataTrimBlocks
```
public Pdfcrowd.HtmlToImageClient setDataTrimBlocks(boolean value)
```
    Auto trim whitespace around each template command block.
    
    Parameters:
    
    value - Set to true to turn auto trimming on.
    
    Returns:
    
    The converter object.
  - setDataOptions
```
public Pdfcrowd.HtmlToImageClient setDataOptions(String options)
```
    Set the advanced data options:
    - csv_delimiter - The CSV data delimiter, the default is ,.
    - xml_remove_root - Remove the root XML element from the input data.
    - data_root - The name of the root element inserted into the input data without a root node (e.g. CSV), the default is data.
    Parameters:
    
    options - Comma separated list of options.
    
    Returns:
    
    The converter object.
  - setDebugLog
```
public Pdfcrowd.HtmlToImageClient setDebugLog(boolean 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.
    
    Parameters:
    
    value - Set to true to enable the debug logging.
    
    Returns:
    
    The converter object.
  - getDebugLogUrl
```
public String getDebugLogUrl()
```
    Get the URL of the debug log for the last conversion.
    
    Returns:
    
    The link to the debug log.
  - getRemainingCreditCount
```
public int getRemainingCreditCount()
```
    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:
    
    The number of credits.
  - getConsumedCreditCount
```
public int getConsumedCreditCount()
```
    Get the number of credits consumed by the last conversion.
    
    Returns:
    
    The number of credits.
  - getJobId
```
public String getJobId()
```
    Get the job id.
    
    Returns:
    
    The unique job identifier.
  - getOutputSize
```
public int getOutputSize()
```
    Get the size of the output in bytes.
    
    Returns:
    
    The count of bytes.
  - getVersion
```
public String getVersion()
```
    Get the version details.
    
    Returns:
    
    API version, converter version, and client version.
  - setTag
```
public Pdfcrowd.HtmlToImageClient setTag(String tag)
```
    Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
    
    Parameters:
    
    tag - A string with the custom tag.
    
    Returns:
    
    The converter object.
  - setHttpProxy
```
public Pdfcrowd.HtmlToImageClient setHttpProxy(String 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.
    
    Parameters:
    
    proxy - The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
    
    Returns:
    
    The converter object.
  - setHttpsProxy
```
public Pdfcrowd.HtmlToImageClient setHttpsProxy(String 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.
    
    Parameters:
    
    proxy - The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
    
    Returns:
    
    The converter object.
  - setClientCertificate
```
public Pdfcrowd.HtmlToImageClient setClientCertificate(String certificate)
```
    A client certificate to authenticate the converter on your web server. The certificate is used for two-way SSL/TLS authentication and adds extra security.
    
    Parameters:
    
    certificate - The file must be in PKCS12 format. The file must exist and not be empty.
    
    Returns:
    
    The converter object.
  - setClientCertificatePassword
```
public Pdfcrowd.HtmlToImageClient setClientCertificatePassword(String password)
```
    A password for PKCS12 file with a client certificate if it is needed.
    
    Parameters:
    
    password -
    
    Returns:
    
    The converter object.
  - setMaxLoadingTime
```
public Pdfcrowd.HtmlToImageClient setMaxLoadingTime(int maxTime)
```
    Set the maximum time to load the page and its resources. After this time, all requests will be considered successful. This can be useful to ensure that the conversion does not timeout. Use this method if there is no other way to fix page loading.
    
    Parameters:
    
    maxTime - The number of seconds to wait. The accepted range is 10-30.
    
    Returns:
    
    The converter object.
  - setSubprocessReferrer
```
public Pdfcrowd.HtmlToImageClient setSubprocessReferrer(String referrer)
```
  - setConverterUserAgent
```
public Pdfcrowd.HtmlToImageClient setConverterUserAgent(String agent)
```
    Specifies the User-Agent HTTP header that will be used by the converter when a request is made to the converted web page.
    
    Parameters:
    
    agent - The user agent.
    
    Returns:
    
    The converter object.
  - setConverterVersion
```
public Pdfcrowd.HtmlToImageClient setConverterVersion(String version)
```
    Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.
    
    Parameters:
    
    version - The version identifier. Allowed values are 24.04, 20.10, 18.10, latest.
    
    Returns:
    
    The converter object.
  - setUseHttp
```
public Pdfcrowd.HtmlToImageClient setUseHttp(boolean value)
```
    Specify whether to use HTTP or HTTPS when connecting to the PDFCrowd API. Warning: Using HTTP is insecure as data sent over HTTP is not encrypted. Enable this option only if you know what you are doing.
    
    Parameters:
    
    value - Set to true to use HTTP.
    
    Returns:
    
    The converter object.
  - setClientUserAgent
```
public Pdfcrowd.HtmlToImageClient setClientUserAgent(String agent)
```
    Specifies the User-Agent HTTP header that the client library will use when interacting with the API.
    
    Parameters:
    
    agent - The user agent string.
    
    Returns:
    
    The converter object.
  - setUserAgent
```
public Pdfcrowd.HtmlToImageClient setUserAgent(String agent)
```
    Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
    
    Parameters:
    
    agent - The user agent string.
    
    Returns:
    
    The converter object.
  - setProxy
```
public Pdfcrowd.HtmlToImageClient 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.
    
    Parameters:
    
    host - The proxy hostname.
    
    port - The proxy port.
    
    userName - The username.
    
    password - The password.
    
    Returns:
    
    The converter object.
  - setRetryCount
```
public Pdfcrowd.HtmlToImageClient setRetryCount(int 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.
    
    Parameters:
    
    count - Number of retries.
    
    Returns:
    
    The converter object.

Class Pdfcrowd.HtmlToImageClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HtmlToImageClient

Method Detail

setOutputFormat

convertUrl

convertUrlToStream

convertUrlToFile

convertFile

convertFileToStream

convertFileToFile

convertString

convertStringToStream

convertStringToFile

convertStream

convertStreamToStream

convertStreamToFile

setZipMainFilename

setScreenshotWidth

setScreenshotHeight

setScaleFactor

setBackgroundColor

setUsePrintMedia

setNoBackground

setDisableJavascript

setDisableImageLoading

setDisableRemoteFonts

setUseMobileUserAgent

setLoadIframes

setBlockAds

setDefaultEncoding

setLocale

setHttpAuthUserName

setHttpAuthPassword

setHttpAuth

setCookies

setVerifySslCertificates

setFailOnMainUrlError

setFailOnAnyUrlError

setNoXpdfcrowdHeader

setCustomCss

setCustomJavascript

setOnLoadJavascript

setCustomHttpHeader

setJavascriptDelay

setElementToConvert

setElementToConvertMode

setWaitForElement

setAutoDetectElementToConvert

setReadabilityEnhancements

setDataString

setDataFile

setDataFormat

setDataEncoding

setDataIgnoreUndefined

setDataAutoEscape

setDataTrimBlocks

setDataOptions

setDebugLog

getDebugLogUrl

getRemainingCreditCount

getConsumedCreditCount

getJobId

getOutputSize

getVersion

setTag

setHttpProxy

setHttpsProxy

setClientCertificate

setClientCertificatePassword

setMaxLoadingTime

setSubprocessReferrer

setConverterUserAgent

setConverterVersion

setUseHttp

setClientUserAgent

setUserAgent