Class: Pdfcrowd::PdfToTextClient
- Inherits:
-
Object
- Object
- Pdfcrowd::PdfToTextClient
- Defined in:
- lib/pdfcrowd.rb
Overview
Conversion from PDF to text.
Instance Method Summary collapse
-
#convertFile(file) ⇒ Object
Convert a local file.
-
#convertFileToFile(file, file_path) ⇒ Object
Convert a local file and write the result to a local file.
-
#convertFileToStream(file, out_stream) ⇒ Object
Convert a local file and write the result to an output stream.
-
#convertRawData(data) ⇒ Object
Convert raw data.
-
#convertRawDataToFile(data, file_path) ⇒ Object
Convert raw data to a file.
-
#convertRawDataToStream(data, out_stream) ⇒ Object
Convert raw data and write the result to an output stream.
-
#convertStream(in_stream) ⇒ Object
Convert the contents of an input stream.
-
#convertStreamToFile(in_stream, file_path) ⇒ Object
Convert the contents of an input stream and write the result to a local file.
-
#convertStreamToStream(in_stream, out_stream) ⇒ Object
Convert the contents of an input stream and write the result to an output stream.
-
#convertUrl(url) ⇒ Object
Convert a PDF.
-
#convertUrlToFile(url, file_path) ⇒ Object
Convert a PDF and write the result to a local file.
-
#convertUrlToStream(url, out_stream) ⇒ Object
Convert a PDF and write the result to an output stream.
-
#getConsumedCreditCount ⇒ Object
Get the number of credits consumed by the last conversion.
-
#getDebugLogUrl ⇒ Object
Get the URL of the debug log for the last conversion.
-
#getJobId ⇒ Object
Get the job id.
-
#getOutputSize ⇒ Object
Get the size of the output in bytes.
-
#getPageCount ⇒ Object
Get the number of pages in the output document.
-
#getRemainingCreditCount ⇒ Object
Get the number of conversion credits available in your account.
-
#getVersion ⇒ Object
Get the version details.
-
#initialize(user_name, api_key) ⇒ PdfToTextClient
constructor
Constructor for the Pdfcrowd API client.
-
#setCropArea(x, y, width, height) ⇒ Object
Set the crop area.
-
#setCropAreaHeight(height) ⇒ Object
Set the height of the crop area in points.
-
#setCropAreaWidth(width) ⇒ Object
Set the width of the crop area in points.
-
#setCropAreaX(x) ⇒ Object
Set the top left X coordinate of the crop area in points.
-
#setCropAreaY(y) ⇒ Object
Set the top left Y coordinate of the crop area in points.
-
#setCustomPageBreak(page_break) ⇒ Object
Specify the custom page break.
-
#setDebugLog(value) ⇒ Object
Turn on the debug logging.
-
#setEol(eol) ⇒ Object
The end-of-line convention for the text output.
-
#setHttpProxy(proxy) ⇒ Object
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTP scheme.
-
#setHttpsProxy(proxy) ⇒ Object
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTPS scheme.
-
#setLineSpacingThreshold(threshold) ⇒ Object
Set the maximum line spacing when the paragraph detection mode is enabled.
-
#setNoLayout(value) ⇒ Object
Ignore the original PDF layout.
-
#setPageBreakMode(mode) ⇒ Object
Specify the page break mode for the text output.
-
#setParagraphMode(mode) ⇒ Object
Specify the paragraph detection mode.
-
#setPdfPassword(password) ⇒ Object
The password to open the encrypted PDF file.
-
#setPrintPageRange(pages) ⇒ Object
Set the page range to print.
-
#setProxy(host, port, user_name, password) ⇒ Object
Specifies an HTTP proxy that the API client library will use to connect to the internet.
-
#setRemoveEmptyLines(value) ⇒ Object
Remove empty lines from the text output.
-
#setRemoveHyphenation(value) ⇒ Object
Remove the hyphen character from the end of lines.
-
#setRetryCount(count) ⇒ Object
Specifies the number of automatic retries when the 502 or 503 HTTP status code is received.
-
#setTag(tag) ⇒ Object
Tag the conversion with a custom value.
-
#setUseHttp(value) ⇒ Object
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
-
#setUserAgent(agent) ⇒ Object
Set a custom user agent HTTP header.
Constructor Details
#initialize(user_name, api_key) ⇒ PdfToTextClient
Constructor for the Pdfcrowd API client.
-
user_name
- Your username at Pdfcrowd. -
api_key
- Your API key.
5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 |
# File 'lib/pdfcrowd.rb', line 5765 def initialize(user_name, api_key) @helper = ConnectionHelper.new(user_name, api_key) @fields = { 'input_format'=>'pdf', 'output_format'=>'txt' } @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 must exist and not be empty. -
Returns - Byte array containing the conversion output.
5826 5827 5828 5829 5830 5831 5832 5833 |
# File 'lib/pdfcrowd.rb', line 5826 def convertFile(file) if (!(File.file?(file) && !File.zero?(file))) raise Error.new(Pdfcrowd.(file, "convertFile", "pdf-to-text", "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 must exist and not be empty. -
file_path
- The output file path. The string must not be empty.
5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 |
# File 'lib/pdfcrowd.rb', line 5852 def convertFileToFile(file, file_path) if (!(!file_path.nil? && !file_path.empty?)) raise Error.new(Pdfcrowd.(file_path, "convertFileToFile::file_path", "pdf-to-text", "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 must exist and not be empty. -
out_stream
- The output stream that will contain the conversion output.
5839 5840 5841 5842 5843 5844 5845 5846 |
# File 'lib/pdfcrowd.rb', line 5839 def convertFileToStream(file, out_stream) if (!(File.file?(file) && !File.zero?(file))) raise Error.new(Pdfcrowd.(file, "convertFileToStream::file", "pdf-to-text", "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 |
#convertRawData(data) ⇒ Object
Convert raw data.
-
data
- The raw content to be converted. -
Returns - Byte array with the output.
5872 5873 5874 5875 |
# File 'lib/pdfcrowd.rb', line 5872 def convertRawData(data) @raw_data['file'] = data @helper.post(@fields, @files, @raw_data) end |
#convertRawDataToFile(data, file_path) ⇒ Object
Convert raw data to a file.
-
data
- The raw content to be converted. -
file_path
- The output file path. The string must not be empty.
5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 |
# File 'lib/pdfcrowd.rb', line 5890 def convertRawDataToFile(data, file_path) if (!(!file_path.nil? && !file_path.empty?)) raise Error.new(Pdfcrowd.(file_path, "convertRawDataToFile::file_path", "pdf-to-text", "The string must not be empty.", "convert_raw_data_to_file"), 470); end output_file = open(file_path, "wb") begin convertRawDataToStream(data, output_file) output_file.close() rescue Error => why output_file.close() FileUtils.rm(file_path) raise end end |
#convertRawDataToStream(data, out_stream) ⇒ Object
Convert raw data and write the result to an output stream.
-
data
- The raw content to be converted. -
out_stream
- The output stream that will contain the conversion output.
5881 5882 5883 5884 |
# File 'lib/pdfcrowd.rb', line 5881 def convertRawDataToStream(data, out_stream) @raw_data['file'] = data @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. -
Returns - Byte array containing the conversion output.
5910 5911 5912 5913 |
# File 'lib/pdfcrowd.rb', line 5910 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. -
file_path
- The output file path. The string must not be empty.
5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 |
# File 'lib/pdfcrowd.rb', line 5928 def convertStreamToFile(in_stream, file_path) if (!(!file_path.nil? && !file_path.empty?)) raise Error.new(Pdfcrowd.(file_path, "convertStreamToFile::file_path", "pdf-to-text", "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. -
out_stream
- The output stream that will contain the conversion output.
5919 5920 5921 5922 |
# File 'lib/pdfcrowd.rb', line 5919 def convertStreamToStream(in_stream, out_stream) @raw_data['stream'] = in_stream.read @helper.post(@fields, @files, @raw_data, out_stream) end |
#convertUrl(url) ⇒ Object
Convert a PDF.
-
url
- The address of the PDF to convert. The supported protocols are http:// and https://. -
Returns - Byte array containing the conversion output.
5780 5781 5782 5783 5784 5785 5786 5787 |
# File 'lib/pdfcrowd.rb', line 5780 def convertUrl(url) unless /(?i)^https?:\/\/.*$/.match(url) raise Error.new(Pdfcrowd.(url, "convertUrl", "pdf-to-text", "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 PDF and write the result to a local file.
-
url
- The address of the PDF to convert. The supported protocols are http:// and https://. -
file_path
- The output file path. The string must not be empty.
5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 |
# File 'lib/pdfcrowd.rb', line 5806 def convertUrlToFile(url, file_path) if (!(!file_path.nil? && !file_path.empty?)) raise Error.new(Pdfcrowd.(file_path, "convertUrlToFile::file_path", "pdf-to-text", "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 PDF and write the result to an output stream.
-
url
- The address of the PDF to convert. The supported protocols are http:// and https://. -
out_stream
- The output stream that will contain the conversion output.
5793 5794 5795 5796 5797 5798 5799 5800 |
# File 'lib/pdfcrowd.rb', line 5793 def convertUrlToStream(url, out_stream) unless /(?i)^https?:\/\/.*$/.match(url) raise Error.new(Pdfcrowd.(url, "convertUrlToStream::url", "pdf-to-text", "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.
6147 6148 6149 |
# File 'lib/pdfcrowd.rb', line 6147 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.
6132 6133 6134 |
# File 'lib/pdfcrowd.rb', line 6132 def getDebugLogUrl() return @helper.getDebugLogUrl() end |
#getJobId ⇒ Object
Get the job id.
-
Returns - The unique job identifier.
6153 6154 6155 |
# File 'lib/pdfcrowd.rb', line 6153 def getJobId() return @helper.getJobId() end |
#getOutputSize ⇒ Object
Get the size of the output in bytes.
-
Returns - The count of bytes.
6165 6166 6167 |
# File 'lib/pdfcrowd.rb', line 6165 def getOutputSize() return @helper.getOutputSize() end |
#getPageCount ⇒ Object
Get the number of pages in the output document.
-
Returns - The page count.
6159 6160 6161 |
# File 'lib/pdfcrowd.rb', line 6159 def getPageCount() return @helper.getPageCount() 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.
6141 6142 6143 |
# File 'lib/pdfcrowd.rb', line 6141 def getRemainingCreditCount() return @helper.getRemainingCreditCount() end |
#getVersion ⇒ Object
Get the version details.
-
Returns - API version, converter version, and client version.
6171 6172 6173 |
# File 'lib/pdfcrowd.rb', line 6171 def getVersion() return "client " + CLIENT_VERSION + ", API v2, converter " + @helper.getConverterVersion() end |
#setCropArea(x, y, width, height) ⇒ Object
Set the crop area. It allows to extract just a part of a PDF page.
-
x
- Set the top left X coordinate of the crop area in points. Must be a positive integer number or 0. -
y
- Set the top left Y coordinate of the crop area in points. Must be a positive integer number or 0. -
width
- Set the width of the crop area in points. Must be a positive integer number or 0. -
height
- Set the height of the crop area in points. Must be a positive integer number or 0. -
Returns - The converter object.
6113 6114 6115 6116 6117 6118 6119 |
# File 'lib/pdfcrowd.rb', line 6113 def setCropArea(x, y, width, height) setCropAreaX(x) setCropAreaY(y) setCropAreaWidth(width) setCropAreaHeight(height) self end |
#setCropAreaHeight(height) ⇒ Object
Set the height of the crop area in points.
-
height
- Must be a positive integer number or 0. -
Returns - The converter object.
6097 6098 6099 6100 6101 6102 6103 6104 |
# File 'lib/pdfcrowd.rb', line 6097 def setCropAreaHeight(height) if (!(Integer(height) >= 0)) raise Error.new(Pdfcrowd.(height, "setCropAreaHeight", "pdf-to-text", "Must be a positive integer number or 0.", "set_crop_area_height"), 470); end @fields['crop_area_height'] = height self end |
#setCropAreaWidth(width) ⇒ Object
Set the width of the crop area in points.
-
width
- Must be a positive integer number or 0. -
Returns - The converter object.
6084 6085 6086 6087 6088 6089 6090 6091 |
# File 'lib/pdfcrowd.rb', line 6084 def setCropAreaWidth(width) if (!(Integer(width) >= 0)) raise Error.new(Pdfcrowd.(width, "setCropAreaWidth", "pdf-to-text", "Must be a positive integer number or 0.", "set_crop_area_width"), 470); end @fields['crop_area_width'] = width self end |
#setCropAreaX(x) ⇒ Object
Set the top left X coordinate of the crop area in points.
-
x
- Must be a positive integer number or 0. -
Returns - The converter object.
6058 6059 6060 6061 6062 6063 6064 6065 |
# File 'lib/pdfcrowd.rb', line 6058 def setCropAreaX(x) if (!(Integer(x) >= 0)) raise Error.new(Pdfcrowd.(x, "setCropAreaX", "pdf-to-text", "Must be a positive integer number or 0.", "set_crop_area_x"), 470); end @fields['crop_area_x'] = x self end |
#setCropAreaY(y) ⇒ Object
Set the top left Y coordinate of the crop area in points.
-
y
- Must be a positive integer number or 0. -
Returns - The converter object.
6071 6072 6073 6074 6075 6076 6077 6078 |
# File 'lib/pdfcrowd.rb', line 6071 def setCropAreaY(y) if (!(Integer(y) >= 0)) raise Error.new(Pdfcrowd.(y, "setCropAreaY", "pdf-to-text", "Must be a positive integer number or 0.", "set_crop_area_y"), 470); end @fields['crop_area_y'] = y self end |
#setCustomPageBreak(page_break) ⇒ Object
Specify the custom page break.
-
page_break
- String to insert between the pages. -
Returns - The converter object.
6005 6006 6007 6008 |
# File 'lib/pdfcrowd.rb', line 6005 def setCustomPageBreak(page_break) @fields['custom_page_break'] = page_break 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.
6125 6126 6127 6128 |
# File 'lib/pdfcrowd.rb', line 6125 def setDebugLog(value) @fields['debug_log'] = value self end |
#setEol(eol) ⇒ Object
The end-of-line convention for the text output.
-
eol
- Allowed values are unix, dos, mac. -
Returns - The converter object.
5979 5980 5981 5982 5983 5984 5985 5986 |
# File 'lib/pdfcrowd.rb', line 5979 def setEol(eol) unless /(?i)^(unix|dos|mac)$/.match(eol) raise Error.new(Pdfcrowd.(eol, "setEol", "pdf-to-text", "Allowed values are unix, dos, mac.", "set_eol"), 470); end @fields['eol'] = eol 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.
6188 6189 6190 6191 6192 6193 6194 6195 |
# File 'lib/pdfcrowd.rb', line 6188 def setHttpProxy(proxy) unless /(?i)^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z0-9]{1,}:\d+$/.match(proxy) raise Error.new(Pdfcrowd.(proxy, "setHttpProxy", "pdf-to-text", "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.
6201 6202 6203 6204 6205 6206 6207 6208 |
# File 'lib/pdfcrowd.rb', line 6201 def setHttpsProxy(proxy) unless /(?i)^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z0-9]{1,}:\d+$/.match(proxy) raise Error.new(Pdfcrowd.(proxy, "setHttpsProxy", "pdf-to-text", "The value must have format DOMAIN_OR_IP_ADDRESS:PORT.", "set_https_proxy"), 470); end @fields['https_proxy'] = proxy self end |
#setLineSpacingThreshold(threshold) ⇒ Object
Set the maximum line spacing when the paragraph detection mode is enabled.
-
threshold
- The value must be a positive integer percentage. -
Returns - The converter object.
6027 6028 6029 6030 6031 6032 6033 6034 |
# File 'lib/pdfcrowd.rb', line 6027 def setLineSpacingThreshold(threshold) unless /(?i)^0$|^[0-9]+%$/.match(threshold) raise Error.new(Pdfcrowd.(threshold, "setLineSpacingThreshold", "pdf-to-text", "The value must be a positive integer percentage.", "set_line_spacing_threshold"), 470); end @fields['line_spacing_threshold'] = threshold self end |
#setNoLayout(value) ⇒ Object
Ignore the original PDF layout.
-
value
- Set to true to ignore the layout. -
Returns - The converter object.
5970 5971 5972 5973 |
# File 'lib/pdfcrowd.rb', line 5970 def setNoLayout(value) @fields['no_layout'] = value self end |
#setPageBreakMode(mode) ⇒ Object
Specify the page break mode for the text output.
-
mode
- Allowed values are none, default, custom. -
Returns - The converter object.
5992 5993 5994 5995 5996 5997 5998 5999 |
# File 'lib/pdfcrowd.rb', line 5992 def setPageBreakMode(mode) unless /(?i)^(none|default|custom)$/.match(mode) raise Error.new(Pdfcrowd.(mode, "setPageBreakMode", "pdf-to-text", "Allowed values are none, default, custom.", "set_page_break_mode"), 470); end @fields['page_break_mode'] = mode self end |
#setParagraphMode(mode) ⇒ Object
Specify the paragraph detection mode.
-
mode
- Allowed values are none, bounding-box, characters. -
Returns - The converter object.
6014 6015 6016 6017 6018 6019 6020 6021 |
# File 'lib/pdfcrowd.rb', line 6014 def setParagraphMode(mode) unless /(?i)^(none|bounding-box|characters)$/.match(mode) raise Error.new(Pdfcrowd.(mode, "setParagraphMode", "pdf-to-text", "Allowed values are none, bounding-box, characters.", "set_paragraph_mode"), 470); end @fields['paragraph_mode'] = mode self end |
#setPdfPassword(password) ⇒ Object
The password to open the encrypted PDF file.
-
password
- The input PDF password. -
Returns - The converter object.
5948 5949 5950 5951 |
# File 'lib/pdfcrowd.rb', line 5948 def setPdfPassword(password) @fields['pdf_password'] = password self end |
#setPrintPageRange(pages) ⇒ Object
Set the page range to print.
-
pages
- A comma separated list of page numbers or ranges. -
Returns - The converter object.
5957 5958 5959 5960 5961 5962 5963 5964 |
# File 'lib/pdfcrowd.rb', line 5957 def setPrintPageRange(pages) unless /^(?:\s*(?:\d+|(?:\d*\s*\-\s*\d+)|(?:\d+\s*\-\s*\d*))\s*,\s*)*\s*(?:\d+|(?:\d*\s*\-\s*\d+)|(?:\d+\s*\-\s*\d*))\s*$/.match(pages) raise Error.new(Pdfcrowd.(pages, "setPrintPageRange", "pdf-to-text", "A comma separated list of page numbers or ranges.", "set_print_page_range"), 470); end @fields['print_page_range'] = pages 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.
6236 6237 6238 6239 |
# File 'lib/pdfcrowd.rb', line 6236 def setProxy(host, port, user_name, password) @helper.setProxy(host, port, user_name, password) self end |
#setRemoveEmptyLines(value) ⇒ Object
Remove empty lines from the text output.
-
value
- Set to true to remove empty lines. -
Returns - The converter object.
6049 6050 6051 6052 |
# File 'lib/pdfcrowd.rb', line 6049 def setRemoveEmptyLines(value) @fields['remove_empty_lines'] = value self end |
#setRemoveHyphenation(value) ⇒ Object
Remove the hyphen character from the end of lines.
-
value
- Set to true to remove hyphens. -
Returns - The converter object.
6040 6041 6042 6043 |
# File 'lib/pdfcrowd.rb', line 6040 def setRemoveHyphenation(value) @fields['remove_hyphenation'] = value self end |
#setRetryCount(count) ⇒ Object
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.
-
count
- Number of retries. -
Returns - The converter object.
6245 6246 6247 6248 |
# File 'lib/pdfcrowd.rb', line 6245 def setRetryCount(count) @helper.setRetryCount(count) 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.
6179 6180 6181 6182 |
# File 'lib/pdfcrowd.rb', line 6179 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.
6215 6216 6217 6218 |
# File 'lib/pdfcrowd.rb', line 6215 def setUseHttp(value) @helper.setUseHttp(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.
6224 6225 6226 6227 |
# File 'lib/pdfcrowd.rb', line 6224 def setUserAgent(agent) @helper.setUserAgent(agent) self end |