Class: Pdfcrowd::HtmlToImageClient

Inherits:
Object
  • Object
show all
Defined in:
lib/pdfcrowd.rb

Overview

Conversion from HTML to image.

Instance Method Summary collapse

Constructor Details

#initialize(user_name, api_key) ⇒ HtmlToImageClient

Constructor for the Pdfcrowd API client.

  • user_name - Your username at Pdfcrowd.

  • api_key - Your API key.



2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
 
# File 'lib/pdfcrowd.rb', line 2404

def initialize(user_name, api_key)
    @helper = ConnectionHelper.new(user_name, api_key)
    @fields = {
        'input_format'=>'html',
        'output_format'=>'png'
    }
    @file_id = 1
    @files = {}
    @raw_data = {}
end

Instance Method Details

#convertFile(file) ⇒ Object

Convert a local file.

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



2478
2479
2480
2481
2482
2483
2484
2485
 
# File 'lib/pdfcrowd.rb', line 2478

def convertFile(file)
    if (!(File.file?(file) && !File.zero?(file)))
        raise Error.new(Pdfcrowd.create_invalid_value_message(file, "convertFile", "html-to-image", "The file must exist and not be empty.", "convert_file"), 470);
    end
    
    @files['file'] = file
    @helper.post(@fields, @files, @raw_data)
end

#convertFileToFile(file, file_path) ⇒ Object

Convert a local file and write the result to a local file.

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

  • file_path - The output file path. The string must not be empty.



2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
 
# File 'lib/pdfcrowd.rb', line 2504

def convertFileToFile(file, file_path)
    if (!(!file_path.nil? && !file_path.empty?))
        raise Error.new(Pdfcrowd.create_invalid_value_message(file_path, "convertFileToFile::file_path", "html-to-image", "The string must not be empty.", "convert_file_to_file"), 470);
    end
    
    output_file = open(file_path, "wb")
    begin
        convertFileToStream(file, output_file)
        output_file.close()
    rescue Error => why
        output_file.close()
        FileUtils.rm(file_path)
        raise
    end
end

#convertFileToStream(file, out_stream) ⇒ Object

Convert a local file and write the result to an output stream.

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

  • out_stream - The output stream that will contain the conversion output.



2491
2492
2493
2494
2495
2496
2497
2498
 
# File 'lib/pdfcrowd.rb', line 2491

def convertFileToStream(file, out_stream)
    if (!(File.file?(file) && !File.zero?(file)))
        raise Error.new(Pdfcrowd.create_invalid_value_message(file, "convertFileToStream::file", "html-to-image", "The file must exist and not be empty.", "convert_file_to_stream"), 470);
    end
    
    @files['file'] = file
    @helper.post(@fields, @files, @raw_data, out_stream)
end

#convertStream(in_stream) ⇒ Object

Convert the contents of an input stream.

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



2570
2571
2572
2573
 
# File 'lib/pdfcrowd.rb', line 2570

def convertStream(in_stream)
    @raw_data['stream'] = in_stream.read
    @helper.post(@fields, @files, @raw_data)
end

#convertStreamToFile(in_stream, file_path) ⇒ Object

Convert the contents of an input stream and write the result to a local file.

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

  • file_path - The output file path. The string must not be empty.



2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
 
# File 'lib/pdfcrowd.rb', line 2588

def convertStreamToFile(in_stream, file_path)
    if (!(!file_path.nil? && !file_path.empty?))
        raise Error.new(Pdfcrowd.create_invalid_value_message(file_path, "convertStreamToFile::file_path", "html-to-image", "The string must not be empty.", "convert_stream_to_file"), 470);
    end
    
    output_file = open(file_path, "wb")
    begin
        convertStreamToStream(in_stream, output_file)
        output_file.close()
    rescue Error => why
        output_file.close()
        FileUtils.rm(file_path)
        raise
    end
end

#convertStreamToStream(in_stream, out_stream) ⇒ Object

Convert the contents of an input stream and write the result to an output stream.

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

  • out_stream - The output stream that will contain the conversion output.



2579
2580
2581
2582
 
# File 'lib/pdfcrowd.rb', line 2579

def convertStreamToStream(in_stream, out_stream)
    @raw_data['stream'] = in_stream.read
    @helper.post(@fields, @files, @raw_data, out_stream)
end

#convertString(text) ⇒ Object

Convert a string.

  • text - The string content to convert. The string must not be empty.

  • Returns - Byte array containing the conversion output.



2524
2525
2526
2527
2528
2529
2530
2531
 
# File 'lib/pdfcrowd.rb', line 2524

def convertString(text)
    if (!(!text.nil? && !text.empty?))
        raise Error.new(Pdfcrowd.create_invalid_value_message(text, "convertString", "html-to-image", "The string must not be empty.", "convert_string"), 470);
    end
    
    @fields['text'] = text
    @helper.post(@fields, @files, @raw_data)
end

#convertStringToFile(text, file_path) ⇒ Object

Convert a string and write the output to a file.

  • text - The string content to convert. The string must not be empty.

  • file_path - The output file path. The string must not be empty.



2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
 
# File 'lib/pdfcrowd.rb', line 2550

def convertStringToFile(text, file_path)
    if (!(!file_path.nil? && !file_path.empty?))
        raise Error.new(Pdfcrowd.create_invalid_value_message(file_path, "convertStringToFile::file_path", "html-to-image", "The string must not be empty.", "convert_string_to_file"), 470);
    end
    
    output_file = open(file_path, "wb")
    begin
        convertStringToStream(text, output_file)
        output_file.close()
    rescue Error => why
        output_file.close()
        FileUtils.rm(file_path)
        raise
    end
end

#convertStringToStream(text, out_stream) ⇒ Object

Convert a string and write the output to an output stream.

  • text - The string content to convert. The string must not be empty.

  • out_stream - The output stream that will contain the conversion output.



2537
2538
2539
2540
2541
2542
2543
2544
 
# File 'lib/pdfcrowd.rb', line 2537

def convertStringToStream(text, out_stream)
    if (!(!text.nil? && !text.empty?))
        raise Error.new(Pdfcrowd.create_invalid_value_message(text, "convertStringToStream::text", "html-to-image", "The string must not be empty.", "convert_string_to_stream"), 470);
    end
    
    @fields['text'] = text
    @helper.post(@fields, @files, @raw_data, out_stream)
end

#convertUrl(url) ⇒ Object

Convert a web page.

  • url - The address of the web page to convert. The supported protocols are http:// and https://.

  • Returns - Byte array containing the conversion output.



2432
2433
2434
2435
2436
2437
2438
2439
 
# File 'lib/pdfcrowd.rb', line 2432

def convertUrl(url)
    unless /(?i)^https?:\/\/.*$/.match(url)
        raise Error.new(Pdfcrowd.create_invalid_value_message(url, "convertUrl", "html-to-image", "The supported protocols are http:// and https://.", "convert_url"), 470);
    end
    
    @fields['url'] = url
    @helper.post(@fields, @files, @raw_data)
end

#convertUrlToFile(url, file_path) ⇒ Object

Convert a web page and write the result to a local file.

  • url - The address of the web page to convert. The supported protocols are http:// and https://.

  • file_path - The output file path. The string must not be empty.



2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
 
# File 'lib/pdfcrowd.rb', line 2458

def convertUrlToFile(url, file_path)
    if (!(!file_path.nil? && !file_path.empty?))
        raise Error.new(Pdfcrowd.create_invalid_value_message(file_path, "convertUrlToFile::file_path", "html-to-image", "The string must not be empty.", "convert_url_to_file"), 470);
    end
    
    output_file = open(file_path, "wb")
    begin
        convertUrlToStream(url, output_file)
        output_file.close()
    rescue Error => why
        output_file.close()
        FileUtils.rm(file_path)
        raise
    end
end

#convertUrlToStream(url, out_stream) ⇒ Object

Convert a web page and write the result to an output stream.

  • url - The address of the web page to convert. The supported protocols are http:// and https://.

  • out_stream - The output stream that will contain the conversion output.



2445
2446
2447
2448
2449
2450
2451
2452
 
# File 'lib/pdfcrowd.rb', line 2445

def convertUrlToStream(url, out_stream)
    unless /(?i)^https?:\/\/.*$/.match(url)
        raise Error.new(Pdfcrowd.create_invalid_value_message(url, "convertUrlToStream::url", "html-to-image", "The supported protocols are http:// and https://.", "convert_url_to_stream"), 470);
    end
    
    @fields['url'] = url
    @helper.post(@fields, @files, @raw_data, out_stream)
end

#getConsumedCreditCount ⇒ Object

Get the number of credits consumed by the last conversion.

  • Returns - The number of credits.



3048
3049
3050
 
# File 'lib/pdfcrowd.rb', line 3048

def getConsumedCreditCount()
    return @helper.getConsumedCreditCount()
end

#getDebugLogUrl ⇒ Object

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

  • Returns - The link to the debug log.



3033
3034
3035
 
# File 'lib/pdfcrowd.rb', line 3033

def getDebugLogUrl()
    return @helper.getDebugLogUrl()
end

#getJobId ⇒ Object

Get the job id.

  • Returns - The unique job identifier.



3054
3055
3056
 
# File 'lib/pdfcrowd.rb', line 3054

def getJobId()
    return @helper.getJobId()
end

#getOutputSize ⇒ Object

Get the size of the output in bytes.

  • Returns - The count of bytes.



3060
3061
3062
 
# File 'lib/pdfcrowd.rb', line 3060

def getOutputSize()
    return @helper.getOutputSize()
end

#getRemainingCreditCount ⇒ Object

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.



3042
3043
3044
 
# File 'lib/pdfcrowd.rb', line 3042

def getRemainingCreditCount()
    return @helper.getRemainingCreditCount()
end

#getVersion ⇒ Object

Get the version details.

  • Returns - API version, converter version, and client version.



3066
3067
3068
 
# File 'lib/pdfcrowd.rb', line 3066

def getVersion()
    return "client " + CLIENT_VERSION + ", API v2, converter " + @helper.getConverterVersion()
end

#setAutoDetectElementToConvert(value) ⇒ Object

The main HTML element for conversion is detected automatically.

  • value - Set to true to detect the main element.

  • Returns - The converter object.



2876
2877
2878
2879
 
# File 'lib/pdfcrowd.rb', line 2876

def setAutoDetectElementToConvert(value)
    @fields['auto_detect_element_to_convert'] = value
    self
end

#setBackgroundColor(color) ⇒ Object

The output image background color.

  • color - The value must be in RRGGBB or RRGGBBAA hexadecimal format.

  • Returns - The converter object.



2937
2938
2939
2940
2941
2942
2943
2944
 
# File 'lib/pdfcrowd.rb', line 2937

def setBackgroundColor(color)
    unless /^[0-9a-fA-F]{6,8}$/.match(color)
        raise Error.new(Pdfcrowd.create_invalid_value_message(color, "setBackgroundColor", "html-to-image", "The value must be in RRGGBB or RRGGBBAA hexadecimal format.", "set_background_color"), 470);
    end
    
    @fields['background_color'] = color
    self
end

#setBlockAds(value) ⇒ Object

Try to block ads. Enabling this option can produce smaller output and speed up the conversion.

  • value - Set to true to block ads in web pages.

  • Returns - The converter object.



2684
2685
2686
2687
 
# File 'lib/pdfcrowd.rb', line 2684

def setBlockAds(value)
    @fields['block_ads'] = value
    self
end

#setClientCertificate(certificate) ⇒ Object

A client certificate to authenticate Pdfcrowd converter on your web server. The certificate is used for two-way SSL/TLS authentication and adds extra security.

  • certificate - The file must be in PKCS12 format. The file must exist and not be empty.

  • Returns - The converter object.



3109
3110
3111
3112
3113
3114
3115
3116
 
# File 'lib/pdfcrowd.rb', line 3109

def setClientCertificate(certificate)
    if (!(File.file?(certificate) && !File.zero?(certificate)))
        raise Error.new(Pdfcrowd.create_invalid_value_message(certificate, "setClientCertificate", "html-to-image", "The file must exist and not be empty.", "set_client_certificate"), 470);
    end
    
    @files['client_certificate'] = certificate
    self
end

#setClientCertificatePassword(password) ⇒ Object

A password for PKCS12 file with a client certificate if it is needed.

  • password -

  • Returns - The converter object.



3122
3123
3124
3125
 
# File 'lib/pdfcrowd.rb', line 3122

def setClientCertificatePassword(password)
    @fields['client_certificate_password'] = password
    self
end

#setConverterVersion(version) ⇒ Object

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

  • version - The version identifier. Allowed values are latest, 20.10, 18.10.

  • Returns - The converter object.



3131
3132
3133
3134
3135
3136
3137
3138
 
# File 'lib/pdfcrowd.rb', line 3131

def setConverterVersion(version)
    unless /(?i)^(latest|20.10|18.10)$/.match(version)
        raise Error.new(Pdfcrowd.create_invalid_value_message(version, "setConverterVersion", "html-to-image", "Allowed values are latest, 20.10, 18.10.", "set_converter_version"), 470);
    end
    
    @helper.setConverterVersion(version)
    self
end

#setCookies(cookies) ⇒ Object

Set cookies that are sent in Pdfcrowd HTTP requests.

  • cookies - The cookie string.

  • Returns - The converter object.



2740
2741
2742
2743
 
# File 'lib/pdfcrowd.rb', line 2740

def setCookies(cookies)
    @fields['cookies'] = cookies
    self
end

#setCustomHttpHeader(header) ⇒ Object

Set a custom HTTP header that is sent in Pdfcrowd HTTP requests.

  • header - A string containing the header name and value separated by a colon.

  • Returns - The converter object.



2811
2812
2813
2814
2815
2816
2817
2818
 
# File 'lib/pdfcrowd.rb', line 2811

def setCustomHttpHeader(header)
    unless /^.+:.+$/.match(header)
        raise Error.new(Pdfcrowd.create_invalid_value_message(header, "setCustomHttpHeader", "html-to-image", "A string containing the header name and value separated by a colon.", "set_custom_http_header"), 470);
    end
    
    @fields['custom_http_header'] = header
    self
end

#setCustomJavascript(javascript) ⇒ Object

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.

  • javascript - A string containing a JavaScript code. The string must not be empty.

  • Returns - The converter object.



2785
2786
2787
2788
2789
2790
2791
2792
 
# File 'lib/pdfcrowd.rb', line 2785

def setCustomJavascript(javascript)
    if (!(!javascript.nil? && !javascript.empty?))
        raise Error.new(Pdfcrowd.create_invalid_value_message(javascript, "setCustomJavascript", "html-to-image", "The string must not be empty.", "set_custom_javascript"), 470);
    end
    
    @fields['custom_javascript'] = javascript
    self
end

#setDataAutoEscape(value) ⇒ Object

Auto escape HTML symbols in the input data before placing them into the output.

  • value - Set to true to turn auto escaping on.

  • Returns - The converter object.



2999
3000
3001
3002
 
# File 'lib/pdfcrowd.rb', line 2999

def setDataAutoEscape(value)
    @fields['data_auto_escape'] = value
    self
end

#setDataEncoding(encoding) ⇒ Object

Set the encoding of the data file set by setDataFile.

  • encoding - The data file encoding.

  • Returns - The converter object.



2981
2982
2983
2984
 
# File 'lib/pdfcrowd.rb', line 2981

def setDataEncoding(encoding)
    @fields['data_encoding'] = encoding
    self
end

#setDataFile(data_file) ⇒ Object

Load the input data for template rendering from the specified file. The data format can be JSON, XML, YAML or CSV.

  • data_file - The file path to a local file containing the input data.

  • Returns - The converter object.



2959
2960
2961
2962
 
# File 'lib/pdfcrowd.rb', line 2959

def setDataFile(data_file)
    @files['data_file'] = data_file
    self
end

#setDataFormat(data_format) ⇒ Object

Specify the input data format.

  • data_format - The data format. Allowed values are auto, json, xml, yaml, csv.

  • Returns - The converter object.



2968
2969
2970
2971
2972
2973
2974
2975
 
# File 'lib/pdfcrowd.rb', line 2968

def setDataFormat(data_format)
    unless /(?i)^(auto|json|xml|yaml|csv)$/.match(data_format)
        raise Error.new(Pdfcrowd.create_invalid_value_message(data_format, "setDataFormat", "html-to-image", "Allowed values are auto, json, xml, yaml, csv.", "set_data_format"), 470);
    end
    
    @fields['data_format'] = data_format
    self
end

#setDataIgnoreUndefined(value) ⇒ Object

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.

  • value - Set to true to ignore undefined variables.

  • Returns - The converter object.



2990
2991
2992
2993
 
# File 'lib/pdfcrowd.rb', line 2990

def setDataIgnoreUndefined(value)
    @fields['data_ignore_undefined'] = value
    self
end

#setDataOptions(options) ⇒ Object

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.

  • options - Comma separated list of options.

  • Returns - The converter object.



3017
3018
3019
3020
 
# File 'lib/pdfcrowd.rb', line 3017

def setDataOptions(options)
    @fields['data_options'] = options
    self
end

#setDataString(data_string) ⇒ Object

Set the input data for template rendering. The data format can be JSON, XML, YAML or CSV.

  • data_string - The input data string.

  • Returns - The converter object.



2950
2951
2952
2953
 
# File 'lib/pdfcrowd.rb', line 2950

def setDataString(data_string)
    @fields['data_string'] = data_string
    self
end

#setDataTrimBlocks(value) ⇒ Object

Auto trim whitespace around each template command block.

  • value - Set to true to turn auto trimming on.

  • Returns - The converter object.



3008
3009
3010
3011
 
# File 'lib/pdfcrowd.rb', line 3008

def setDataTrimBlocks(value)
    @fields['data_trim_blocks'] = value
    self
end

#setDebugLog(value) ⇒ Object

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.

  • value - Set to true to enable the debug logging.

  • Returns - The converter object.



3026
3027
3028
3029
 
# File 'lib/pdfcrowd.rb', line 3026

def setDebugLog(value)
    @fields['debug_log'] = value
    self
end

#setDefaultEncoding(encoding) ⇒ Object

Set the default HTML content text encoding.

  • encoding - The text encoding of the HTML content.

  • Returns - The converter object.



2693
2694
2695
2696
 
# File 'lib/pdfcrowd.rb', line 2693

def setDefaultEncoding(encoding)
    @fields['default_encoding'] = encoding
    self
end

#setDisableImageLoading(value) ⇒ Object

Do not load images.

  • value - Set to true to disable loading of images.

  • Returns - The converter object.



2644
2645
2646
2647
 
# File 'lib/pdfcrowd.rb', line 2644

def setDisableImageLoading(value)
    @fields['disable_image_loading'] = value
    self
end

#setDisableJavascript(value) ⇒ Object

Do not execute JavaScript.

  • value - Set to true to disable JavaScript in web pages.

  • Returns - The converter object.



2635
2636
2637
2638
 
# File 'lib/pdfcrowd.rb', line 2635

def setDisableJavascript(value)
    @fields['disable_javascript'] = value
    self
end

#setDisableRemoteFonts(value) ⇒ Object

Disable loading fonts from remote sources.

  • value - Set to true disable loading remote fonts.

  • Returns - The converter object.



2653
2654
2655
2656
 
# File 'lib/pdfcrowd.rb', line 2653

def setDisableRemoteFonts(value)
    @fields['disable_remote_fonts'] = value
    self
end

#setElementToConvert(selectors) ⇒ Object

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.

  • selectors - One or more CSS selectors separated by commas. The string must not be empty.

  • Returns - The converter object.



2837
2838
2839
2840
2841
2842
2843
2844
 
# File 'lib/pdfcrowd.rb', line 2837

def setElementToConvert(selectors)
    if (!(!selectors.nil? && !selectors.empty?))
        raise Error.new(Pdfcrowd.create_invalid_value_message(selectors, "setElementToConvert", "html-to-image", "The string must not be empty.", "set_element_to_convert"), 470);
    end
    
    @fields['element_to_convert'] = selectors
    self
end

#setElementToConvertMode(mode) ⇒ Object

Specify the DOM handling when only a part of the document is converted. This can affect the CSS rules used.

  • mode - Allowed values are cut-out, remove-siblings, hide-siblings.

  • Returns - The converter object.



2850
2851
2852
2853
2854
2855
2856
2857
 
# File 'lib/pdfcrowd.rb', line 2850

def setElementToConvertMode(mode)
    unless /(?i)^(cut-out|remove-siblings|hide-siblings)$/.match(mode)
        raise Error.new(Pdfcrowd.create_invalid_value_message(mode, "setElementToConvertMode", "html-to-image", "Allowed values are cut-out, remove-siblings, hide-siblings.", "set_element_to_convert_mode"), 470);
    end
    
    @fields['element_to_convert_mode'] = mode
    self
end

#setFailOnAnyUrlError(fail_on_error) ⇒ Object

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.

  • fail_on_error - Set to true to abort the conversion.

  • Returns - The converter object.



2767
2768
2769
2770
 
# File 'lib/pdfcrowd.rb', line 2767

def setFailOnAnyUrlError(fail_on_error)
    @fields['fail_on_any_url_error'] = fail_on_error
    self
end

#setFailOnMainUrlError(fail_on_error) ⇒ Object

Abort the conversion if the main URL HTTP status code is greater than or equal to 400.

  • fail_on_error - Set to true to abort the conversion.

  • Returns - The converter object.



2758
2759
2760
2761
 
# File 'lib/pdfcrowd.rb', line 2758

def setFailOnMainUrlError(fail_on_error)
    @fields['fail_on_main_url_error'] = fail_on_error
    self
end

#setHttpAuth(user_name, password) ⇒ Object

Set credentials to access HTTP base authentication protected websites.

  • user_name - Set the HTTP authentication user name.

  • password - Set the HTTP authentication password.

  • Returns - The converter object.



2730
2731
2732
2733
2734
 
# File 'lib/pdfcrowd.rb', line 2730

def setHttpAuth(user_name, password)
    setHttpAuthUserName(user_name)
    setHttpAuthPassword(password)
    self
end

#setHttpAuthPassword(password) ⇒ Object

Set the HTTP authentication password.

  • password - The password.

  • Returns - The converter object.



2720
2721
2722
2723
 
# File 'lib/pdfcrowd.rb', line 2720

def setHttpAuthPassword(password)
    @fields['http_auth_password'] = password
    self
end

#setHttpAuthUserName(user_name) ⇒ Object

Set the HTTP authentication user name.

  • user_name - The user name.

  • Returns - The converter object.



2711
2712
2713
2714
 
# File 'lib/pdfcrowd.rb', line 2711

def setHttpAuthUserName(user_name)
    @fields['http_auth_user_name'] = user_name
    self
end

#setHttpProxy(proxy) ⇒ Object

A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.

  • proxy - The value must have format DOMAIN_OR_IP_ADDRESS:PORT.

  • Returns - The converter object.



3083
3084
3085
3086
3087
3088
3089
3090
 
# File 'lib/pdfcrowd.rb', line 3083

def setHttpProxy(proxy)
    unless /(?i)^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z0-9]{1,}:\d+$/.match(proxy)
        raise Error.new(Pdfcrowd.create_invalid_value_message(proxy, "setHttpProxy", "html-to-image", "The value must have format DOMAIN_OR_IP_ADDRESS:PORT.", "set_http_proxy"), 470);
    end
    
    @fields['http_proxy'] = proxy
    self
end

#setHttpsProxy(proxy) ⇒ Object

A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.

  • proxy - The value must have format DOMAIN_OR_IP_ADDRESS:PORT.

  • Returns - The converter object.



3096
3097
3098
3099
3100
3101
3102
3103
 
# File 'lib/pdfcrowd.rb', line 3096

def setHttpsProxy(proxy)
    unless /(?i)^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z0-9]{1,}:\d+$/.match(proxy)
        raise Error.new(Pdfcrowd.create_invalid_value_message(proxy, "setHttpsProxy", "html-to-image", "The value must have format DOMAIN_OR_IP_ADDRESS:PORT.", "set_https_proxy"), 470);
    end
    
    @fields['https_proxy'] = proxy
    self
end

#setJavascriptDelay(delay) ⇒ Object

Wait the specified number of milliseconds to finish all JavaScript after the document is loaded. Your API license defines the maximum wait time by “Max Delay” parameter.

  • delay - The number of milliseconds to wait. Must be a positive integer number or 0.

  • Returns - The converter object.



2824
2825
2826
2827
2828
2829
2830
2831
 
# File 'lib/pdfcrowd.rb', line 2824

def setJavascriptDelay(delay)
    if (!(Integer(delay) >= 0))
        raise Error.new(Pdfcrowd.create_invalid_value_message(delay, "setJavascriptDelay", "html-to-image", "Must be a positive integer number or 0.", "set_javascript_delay"), 470);
    end
    
    @fields['javascript_delay'] = delay
    self
end

#setLoadIframes(iframes) ⇒ Object

Specifies how iframes are handled.

  • iframes - Allowed values are all, same-origin, none.

  • Returns - The converter object.



2671
2672
2673
2674
2675
2676
2677
2678
 
# File 'lib/pdfcrowd.rb', line 2671

def setLoadIframes(iframes)
    unless /(?i)^(all|same-origin|none)$/.match(iframes)
        raise Error.new(Pdfcrowd.create_invalid_value_message(iframes, "setLoadIframes", "html-to-image", "Allowed values are all, same-origin, none.", "set_load_iframes"), 470);
    end
    
    @fields['load_iframes'] = iframes
    self
end

#setLocale(locale) ⇒ Object

Set the locale for the conversion. This may affect the output format of dates, times and numbers.

  • locale - The locale code according to ISO 639.

  • Returns - The converter object.



2702
2703
2704
2705
 
# File 'lib/pdfcrowd.rb', line 2702

def setLocale(locale)
    @fields['locale'] = locale
    self
end

#setNoBackground(value) ⇒ Object

Do not print the background graphics.

  • value - Set to true to disable the background graphics.

  • Returns - The converter object.



2626
2627
2628
2629
 
# File 'lib/pdfcrowd.rb', line 2626

def setNoBackground(value)
    @fields['no_background'] = value
    self
end

#setNoXpdfcrowdHeader(value) ⇒ Object

Do not send the X-Pdfcrowd HTTP header in Pdfcrowd HTTP requests.

  • value - Set to true to disable sending X-Pdfcrowd HTTP header.

  • Returns - The converter object.



2776
2777
2778
2779
 
# File 'lib/pdfcrowd.rb', line 2776

def setNoXpdfcrowdHeader(value)
    @fields['no_xpdfcrowd_header'] = value
    self
end

#setOnLoadJavascript(javascript) ⇒ Object

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.

  • javascript - A string containing a JavaScript code. The string must not be empty.

  • Returns - The converter object.



2798
2799
2800
2801
2802
2803
2804
2805
 
# File 'lib/pdfcrowd.rb', line 2798

def setOnLoadJavascript(javascript)
    if (!(!javascript.nil? && !javascript.empty?))
        raise Error.new(Pdfcrowd.create_invalid_value_message(javascript, "setOnLoadJavascript", "html-to-image", "The string must not be empty.", "set_on_load_javascript"), 470);
    end
    
    @fields['on_load_javascript'] = javascript
    self
end

#setOutputFormat(output_format) ⇒ Object

The format of the output file.

  • output_format - Allowed values are png, jpg, gif, tiff, bmp, ico, ppm, pgm, pbm, pnm, psb, pct, ras, tga, sgi, sun, webp.

  • Returns - The converter object.



2419
2420
2421
2422
2423
2424
2425
2426
 
# File 'lib/pdfcrowd.rb', line 2419

def setOutputFormat(output_format)
    unless /(?i)^(png|jpg|gif|tiff|bmp|ico|ppm|pgm|pbm|pnm|psb|pct|ras|tga|sgi|sun|webp)$/.match(output_format)
        raise Error.new(Pdfcrowd.create_invalid_value_message(output_format, "setOutputFormat", "html-to-image", "Allowed values are png, jpg, gif, tiff, bmp, ico, ppm, pgm, pbm, pnm, psb, pct, ras, tga, sgi, sun, webp.", "set_output_format"), 470);
    end
    
    @fields['output_format'] = output_format
    self
end

#setProxy(host, port, user_name, password) ⇒ Object

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

  • host - The proxy hostname.

  • port - The proxy port.

  • user_name - The username.

  • password - The password.

  • Returns - The converter object.



3166
3167
3168
3169
 
# File 'lib/pdfcrowd.rb', line 3166

def setProxy(host, port, user_name, password)
    @helper.setProxy(host, port, user_name, password)
    self
end

#setReadabilityEnhancements(enhancements) ⇒ Object

The input HTML is automatically enhanced to improve the readability.

  • enhancements - Allowed values are none, readability-v1, readability-v2, readability-v3.

  • Returns - The converter object.



2885
2886
2887
2888
2889
2890
2891
2892
 
# File 'lib/pdfcrowd.rb', line 2885

def setReadabilityEnhancements(enhancements)
    unless /(?i)^(none|readability-v1|readability-v2|readability-v3)$/.match(enhancements)
        raise Error.new(Pdfcrowd.create_invalid_value_message(enhancements, "setReadabilityEnhancements", "html-to-image", "Allowed values are none, readability-v1, readability-v2, readability-v3.", "set_readability_enhancements"), 470);
    end
    
    @fields['readability_enhancements'] = enhancements
    self
end

#setRetryCount(count) ⇒ Object

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

  • count - Number of retries.

  • Returns - The converter object.



3175
3176
3177
3178
 
# File 'lib/pdfcrowd.rb', line 3175

def setRetryCount(count)
    @helper.setRetryCount(count)
    self
end

#setScaleFactor(factor) ⇒ Object

Set the scaling factor (zoom) for the output image.

  • factor - The percentage value. Must be a positive integer number.

  • Returns - The converter object.



2924
2925
2926
2927
2928
2929
2930
2931
 
# File 'lib/pdfcrowd.rb', line 2924

def setScaleFactor(factor)
    if (!(Integer(factor) > 0))
        raise Error.new(Pdfcrowd.create_invalid_value_message(factor, "setScaleFactor", "html-to-image", "Must be a positive integer number.", "set_scale_factor"), 470);
    end
    
    @fields['scale_factor'] = factor
    self
end

#setScreenshotHeight(height) ⇒ Object

Set the output image height in pixels. If it is not specified, actual document height is used.

  • height - Must be a positive integer number.

  • Returns - The converter object.



2911
2912
2913
2914
2915
2916
2917
2918
 
# File 'lib/pdfcrowd.rb', line 2911

def setScreenshotHeight(height)
    if (!(Integer(height) > 0))
        raise Error.new(Pdfcrowd.create_invalid_value_message(height, "setScreenshotHeight", "html-to-image", "Must be a positive integer number.", "set_screenshot_height"), 470);
    end
    
    @fields['screenshot_height'] = height
    self
end

#setScreenshotWidth(width) ⇒ Object

Set the output image width in pixels.

  • width - The value must be in the range 96-65000.

  • Returns - The converter object.



2898
2899
2900
2901
2902
2903
2904
2905
 
# File 'lib/pdfcrowd.rb', line 2898

def setScreenshotWidth(width)
    if (!(Integer(width) >= 96 && Integer(width) <= 65000))
        raise Error.new(Pdfcrowd.create_invalid_value_message(width, "setScreenshotWidth", "html-to-image", "The value must be in the range 96-65000.", "set_screenshot_width"), 470);
    end
    
    @fields['screenshot_width'] = width
    self
end

#setTag(tag) ⇒ Object

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

  • tag - A string with the custom tag.

  • Returns - The converter object.



3074
3075
3076
3077
 
# File 'lib/pdfcrowd.rb', line 3074

def setTag(tag)
    @fields['tag'] = tag
    self
end

#setUseHttp(value) ⇒ Object

Specifies if the client communicates over HTTP or HTTPS with 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.

  • value - Set to true to use HTTP.

  • Returns - The converter object.



3145
3146
3147
3148
 
# File 'lib/pdfcrowd.rb', line 3145

def setUseHttp(value)
    @helper.setUseHttp(value)
    self
end

#setUseMobileUserAgent(value) ⇒ Object

Use a mobile user agent.

  • value - Set to true to use a mobile user agent.

  • Returns - The converter object.



2662
2663
2664
2665
 
# File 'lib/pdfcrowd.rb', line 2662

def setUseMobileUserAgent(value)
    @fields['use_mobile_user_agent'] = value
    self
end

#setUsePrintMedia(value) ⇒ Object

Use the print version of the page if available (@media print).

  • value - Set to true to use the print version of the page.

  • Returns - The converter object.



2617
2618
2619
2620
 
# File 'lib/pdfcrowd.rb', line 2617

def setUsePrintMedia(value)
    @fields['use_print_media'] = value
    self
end

#setUserAgent(agent) ⇒ Object

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

  • agent - The user agent string.

  • Returns - The converter object.



3154
3155
3156
3157
 
# File 'lib/pdfcrowd.rb', line 3154

def setUserAgent(agent)
    @helper.setUserAgent(agent)
    self
end

#setVerifySslCertificates(value) ⇒ Object

Do not allow insecure HTTPS connections.

  • value - Set to true to enable SSL certificate verification.

  • Returns - The converter object.



2749
2750
2751
2752
 
# File 'lib/pdfcrowd.rb', line 2749

def setVerifySslCertificates(value)
    @fields['verify_ssl_certificates'] = value
    self
end

#setWaitForElement(selectors) ⇒ Object

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 API license defines the maximum wait time by “Max Delay” parameter.

  • selectors - One or more CSS selectors separated by commas. The string must not be empty.

  • Returns - The converter object.



2863
2864
2865
2866
2867
2868
2869
2870
 
# File 'lib/pdfcrowd.rb', line 2863

def setWaitForElement(selectors)
    if (!(!selectors.nil? && !selectors.empty?))
        raise Error.new(Pdfcrowd.create_invalid_value_message(selectors, "setWaitForElement", "html-to-image", "The string must not be empty.", "set_wait_for_element"), 470);
    end
    
    @fields['wait_for_element'] = selectors
    self
end

#setZipMainFilename(filename) ⇒ Object

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.

  • filename - The file name.

  • Returns - The converter object.



2608
2609
2610
2611
 
# File 'lib/pdfcrowd.rb', line 2608

def setZipMainFilename(filename)
    @fields['zip_main_filename'] = filename
    self
end