Class: Pdfcrowd::PdfToPdfClient

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

Overview

Conversion from PDF to PDF.

Instance Method Summary collapse

Constructor Details

#initialize(user_name, api_key) ⇒ PdfToPdfClient

Constructor for the Pdfcrowd API client.

  • user_name - Your username at Pdfcrowd.

  • api_key - Your API key.



3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
 
# File 'lib/pdfcrowd.rb', line 3542

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

Instance Method Details

#addPdfFile(file_path) ⇒ Object

Add a PDF file to the list of the input PDFs.

  • file_path - The file path to a local PDF file. The file must exist and not be empty.

  • Returns - The converter object.



3596
3597
3598
3599
3600
3601
3602
3603
3604
 
# File 'lib/pdfcrowd.rb', line 3596

def addPdfFile(file_path)
    if (!(File.file?(file_path) && !File.zero?(file_path)))
        raise Error.new(Pdfcrowd.create_invalid_value_message(file_path, "addPdfFile", "pdf-to-pdf", "The file must exist and not be empty.", "add_pdf_file"), 470);
    end
    
    @files['f_%s' % @file_id] = file_path
    @file_id += 1
    self
end

#addPdfRawData(data) ⇒ Object

Add in-memory raw PDF data to the list of the input PDFs.Typical usage is for adding PDF created by another Pdfcrowd converter. Example in PHP: $clientPdf2Pdf->addPdfRawData($clientHtml2Pdf->convertUrl(‘www.example.com’));

  • data - The raw PDF data. The input data must be PDF content.

  • Returns - The converter object.



3610
3611
3612
3613
3614
3615
3616
3617
3618
 
# File 'lib/pdfcrowd.rb', line 3610

def addPdfRawData(data)
    if (!(!data.nil? && data.length > 300 and data[0...4] == '%PDF'))
        raise Error.new(Pdfcrowd.create_invalid_value_message("raw PDF data", "addPdfRawData", "pdf-to-pdf", "The input data must be PDF content.", "add_pdf_raw_data"), 470);
    end
    
    @raw_data['f_%s' % @file_id] = data
    @file_id += 1
    self
end

#convert ⇒ Object

Perform an action on the input files.

  • Returns - Byte array containing the output PDF.



3568
3569
3570
 
# File 'lib/pdfcrowd.rb', line 3568

def convert()
    @helper.post(@fields, @files, @raw_data)
end

#convertToFile(file_path) ⇒ Object

Perform an action on the input files and write the output PDF to a file.

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



3582
3583
3584
3585
3586
3587
3588
3589
3590
 
# File 'lib/pdfcrowd.rb', line 3582

def convertToFile(file_path)
    if (!(!file_path.nil? && !file_path.empty?))
        raise Error.new(Pdfcrowd.create_invalid_value_message(file_path, "convertToFile", "pdf-to-pdf", "The string must not be empty.", "convert_to_file"), 470);
    end
    
    output_file = open(file_path, "wb")
    convertToStream(output_file)
    output_file.close()
end

#convertToStream(out_stream) ⇒ Object

Perform an action on the input files and write the output PDF to an output stream.

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



3575
3576
3577
 
# File 'lib/pdfcrowd.rb', line 3575

def convertToStream(out_stream)
    @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.



3999
4000
4001
 
# File 'lib/pdfcrowd.rb', line 3999

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.



3984
3985
3986
 
# File 'lib/pdfcrowd.rb', line 3984

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

#getJobId ⇒ Object

Get the job id.

  • Returns - The unique job identifier.



4005
4006
4007
 
# File 'lib/pdfcrowd.rb', line 4005

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

#getOutputSize ⇒ Object

Get the size of the output in bytes.

  • Returns - The count of bytes.



4017
4018
4019
 
# File 'lib/pdfcrowd.rb', line 4017

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

#getPageCount ⇒ Object

Get the total number of pages in the output document.

  • Returns - The page count.



4011
4012
4013
 
# File 'lib/pdfcrowd.rb', line 4011

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.



3993
3994
3995
 
# File 'lib/pdfcrowd.rb', line 3993

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

#getVersion ⇒ Object

Get the version details.

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



4023
4024
4025
 
# File 'lib/pdfcrowd.rb', line 4023

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

#setAction(action) ⇒ Object

Specifies the action to be performed on the input PDFs.

  • action - Allowed values are join, shuffle.

  • Returns - The converter object.



3557
3558
3559
3560
3561
3562
3563
3564
 
# File 'lib/pdfcrowd.rb', line 3557

def setAction(action)
    unless /(?i)^(join|shuffle)$/.match(action)
        raise Error.new(Pdfcrowd.create_invalid_value_message(action, "setAction", "pdf-to-pdf", "Allowed values are join, shuffle.", "set_action"), 470);
    end
    
    @fields['action'] = action
    self
end

#setAuthor(author) ⇒ Object

Set the author of the PDF.

  • author - The author.

  • Returns - The converter object.



3818
3819
3820
3821
 
# File 'lib/pdfcrowd.rb', line 3818

def setAuthor(author)
    @fields['author'] = author
    self
end

#setCenterWindow(value) ⇒ Object

Specify whether to position the document’s window in the center of the screen.

  • value - Set to true to center the window.

  • Returns - The converter object.



3950
3951
3952
3953
 
# File 'lib/pdfcrowd.rb', line 3950

def setCenterWindow(value)
    @fields['center_window'] = value
    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.



4040
4041
4042
4043
4044
4045
4046
4047
 
# File 'lib/pdfcrowd.rb', line 4040

def setConverterVersion(version)
    unless /(?i)^(latest|20.10|18.10)$/.match(version)
        raise Error.new(Pdfcrowd.create_invalid_value_message(version, "setConverterVersion", "pdf-to-pdf", "Allowed values are latest, 20.10, 18.10.", "set_converter_version"), 470);
    end
    
    @helper.setConverterVersion(version)
    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.



3977
3978
3979
3980
 
# File 'lib/pdfcrowd.rb', line 3977

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

#setDisplayTitle(value) ⇒ Object

Specify whether the window’s title bar should display the document title. If false , the title bar should instead display the name of the PDF file containing the document.

  • value - Set to true to display the title.

  • Returns - The converter object.



3959
3960
3961
3962
 
# File 'lib/pdfcrowd.rb', line 3959

def setDisplayTitle(value)
    @fields['display_title'] = value
    self
end

#setEncrypt(value) ⇒ Object

Encrypt the PDF. This prevents search engines from indexing the contents.

  • value - Set to true to enable PDF encryption.

  • Returns - The converter object.



3746
3747
3748
3749
 
# File 'lib/pdfcrowd.rb', line 3746

def setEncrypt(value)
    @fields['encrypt'] = value
    self
end

#setFitWindow(value) ⇒ Object

Specify whether to resize the document’s window to fit the size of the first displayed page.

  • value - Set to true to resize the window.

  • Returns - The converter object.



3941
3942
3943
3944
 
# File 'lib/pdfcrowd.rb', line 3941

def setFitWindow(value)
    @fields['fit_window'] = value
    self
end

#setHideMenubar(value) ⇒ Object

Specify whether to hide the viewer application’s menu bar when the document is active.

  • value - Set to true to hide the menu bar.

  • Returns - The converter object.



3923
3924
3925
3926
 
# File 'lib/pdfcrowd.rb', line 3923

def setHideMenubar(value)
    @fields['hide_menubar'] = value
    self
end

#setHideToolbar(value) ⇒ Object

Specify whether to hide the viewer application’s tool bars when the document is active.

  • value - Set to true to hide tool bars.

  • Returns - The converter object.



3914
3915
3916
3917
 
# File 'lib/pdfcrowd.rb', line 3914

def setHideToolbar(value)
    @fields['hide_toolbar'] = value
    self
end

#setHideWindowUi(value) ⇒ Object

Specify whether to hide user interface elements in the document’s window (such as scroll bars and navigation controls), leaving only the document’s contents displayed.

  • value - Set to true to hide ui elements.

  • Returns - The converter object.



3932
3933
3934
3935
 
# File 'lib/pdfcrowd.rb', line 3932

def setHideWindowUi(value)
    @fields['hide_window_ui'] = value
    self
end

#setInitialPage(page) ⇒ Object

Display the specified page when the document is opened.

  • page - Must be a positive integer number.

  • Returns - The converter object.



3888
3889
3890
3891
3892
3893
3894
3895
 
# File 'lib/pdfcrowd.rb', line 3888

def setInitialPage(page)
    if (!(Integer(page) > 0))
        raise Error.new(Pdfcrowd.create_invalid_value_message(page, "setInitialPage", "pdf-to-pdf", "Must be a positive integer number.", "set_initial_page"), 470);
    end
    
    @fields['initial_page'] = page
    self
end

#setInitialZoom(zoom) ⇒ Object

Specify the initial page zoom in percents when the document is opened.

  • zoom - Must be a positive integer number.

  • Returns - The converter object.



3901
3902
3903
3904
3905
3906
3907
3908
 
# File 'lib/pdfcrowd.rb', line 3901

def setInitialZoom(zoom)
    if (!(Integer(zoom) > 0))
        raise Error.new(Pdfcrowd.create_invalid_value_message(zoom, "setInitialZoom", "pdf-to-pdf", "Must be a positive integer number.", "set_initial_zoom"), 470);
    end
    
    @fields['initial_zoom'] = zoom
    self
end

#setInitialZoomType(zoom_type) ⇒ Object

Specify how the page should be displayed when opened.

  • zoom_type - Allowed values are fit-width, fit-height, fit-page.

  • Returns - The converter object.



3875
3876
3877
3878
3879
3880
3881
3882
 
# File 'lib/pdfcrowd.rb', line 3875

def setInitialZoomType(zoom_type)
    unless /(?i)^(fit-width|fit-height|fit-page)$/.match(zoom_type)
        raise Error.new(Pdfcrowd.create_invalid_value_message(zoom_type, "setInitialZoomType", "pdf-to-pdf", "Allowed values are fit-width, fit-height, fit-page.", "set_initial_zoom_type"), 470);
    end
    
    @fields['initial_zoom_type'] = zoom_type
    self
end

#setInputPdfPassword(password) ⇒ Object

Password to open the encrypted PDF file.

  • password - The input PDF password.

  • Returns - The converter object.



3624
3625
3626
3627
 
# File 'lib/pdfcrowd.rb', line 3624

def setInputPdfPassword(password)
    @fields['input_pdf_password'] = password
    self
end

#setKeywords(keywords) ⇒ Object

Associate keywords with the document.

  • keywords - The string with the keywords.

  • Returns - The converter object.



3827
3828
3829
3830
 
# File 'lib/pdfcrowd.rb', line 3827

def setKeywords(keywords)
    @fields['keywords'] = keywords
    self
end

#setLinearize(value) ⇒ Object

Create linearized PDF. This is also known as Fast Web View.

  • value - Set to true to create linearized PDF.

  • Returns - The converter object.



3737
3738
3739
3740
 
# File 'lib/pdfcrowd.rb', line 3737

def setLinearize(value)
    @fields['linearize'] = value
    self
end

#setMultipageBackground(background) ⇒ Object

Apply each page of the specified PDF to the background of the corresponding page of the output PDF.

  • background - The file path to a local background PDF file. The file must exist and not be empty.

  • Returns - The converter object.



3711
3712
3713
3714
3715
3716
3717
3718
 
# File 'lib/pdfcrowd.rb', line 3711

def setMultipageBackground(background)
    if (!(File.file?(background) && !File.zero?(background)))
        raise Error.new(Pdfcrowd.create_invalid_value_message(background, "setMultipageBackground", "pdf-to-pdf", "The file must exist and not be empty.", "set_multipage_background"), 470);
    end
    
    @files['multipage_background'] = background
    self
end

#setMultipageBackgroundUrl(url) ⇒ Object

Load a background PDF from the specified URL and apply each page of the specified background PDF to the corresponding page of the output PDF.

  • url - The supported protocols are http:// and https://.

  • Returns - The converter object.



3724
3725
3726
3727
3728
3729
3730
3731
 
# File 'lib/pdfcrowd.rb', line 3724

def setMultipageBackgroundUrl(url)
    unless /(?i)^https?:\/\/.*$/.match(url)
        raise Error.new(Pdfcrowd.create_invalid_value_message(url, "setMultipageBackgroundUrl", "pdf-to-pdf", "The supported protocols are http:// and https://.", "set_multipage_background_url"), 470);
    end
    
    @fields['multipage_background_url'] = url
    self
end

#setMultipageWatermark(watermark) ⇒ Object

Apply each page of the specified watermark PDF to the corresponding page of the output PDF.

  • watermark - The file path to a local watermark PDF file. The file must exist and not be empty.

  • Returns - The converter object.



3659
3660
3661
3662
3663
3664
3665
3666
 
# File 'lib/pdfcrowd.rb', line 3659

def setMultipageWatermark(watermark)
    if (!(File.file?(watermark) && !File.zero?(watermark)))
        raise Error.new(Pdfcrowd.create_invalid_value_message(watermark, "setMultipageWatermark", "pdf-to-pdf", "The file must exist and not be empty.", "set_multipage_watermark"), 470);
    end
    
    @files['multipage_watermark'] = watermark
    self
end

#setMultipageWatermarkUrl(url) ⇒ Object

Load a watermark PDF from the specified URL and apply each page of the specified watermark PDF to the corresponding page of the output PDF.

  • url - The supported protocols are http:// and https://.

  • Returns - The converter object.



3672
3673
3674
3675
3676
3677
3678
3679
 
# File 'lib/pdfcrowd.rb', line 3672

def setMultipageWatermarkUrl(url)
    unless /(?i)^https?:\/\/.*$/.match(url)
        raise Error.new(Pdfcrowd.create_invalid_value_message(url, "setMultipageWatermarkUrl", "pdf-to-pdf", "The supported protocols are http:// and https://.", "set_multipage_watermark_url"), 470);
    end
    
    @fields['multipage_watermark_url'] = url
    self
end

#setNoCopy(value) ⇒ Object

Disallow text and graphics extraction from the output PDF.

  • value - Set to true to set the no-copy flag in the output PDF.

  • Returns - The converter object.



3791
3792
3793
3794
 
# File 'lib/pdfcrowd.rb', line 3791

def setNoCopy(value)
    @fields['no_copy'] = value
    self
end

#setNoModify(value) ⇒ Object

Disallow modification of the output PDF.

  • value - Set to true to set the read-only only flag in the output PDF.

  • Returns - The converter object.



3782
3783
3784
3785
 
# File 'lib/pdfcrowd.rb', line 3782

def setNoModify(value)
    @fields['no_modify'] = value
    self
end

#setNoPrint(value) ⇒ Object

Disallow printing of the output PDF.

  • value - Set to true to set the no-print flag in the output PDF.

  • Returns - The converter object.



3773
3774
3775
3776
 
# File 'lib/pdfcrowd.rb', line 3773

def setNoPrint(value)
    @fields['no_print'] = value
    self
end

#setOwnerPassword(password) ⇒ Object

Protect the PDF with an owner password. Supplying an owner password grants unlimited access to the PDF including changing the passwords and access permissions.

  • password - The owner password.

  • Returns - The converter object.



3764
3765
3766
3767
 
# File 'lib/pdfcrowd.rb', line 3764

def setOwnerPassword(password)
    @fields['owner_password'] = password
    self
end

#setPageBackground(background) ⇒ Object

Apply the first page of the specified PDF to the background of every page of the output PDF.

  • background - The file path to a local background PDF file. The file must exist and not be empty.

  • Returns - The converter object.



3685
3686
3687
3688
3689
3690
3691
3692
 
# File 'lib/pdfcrowd.rb', line 3685

def setPageBackground(background)
    if (!(File.file?(background) && !File.zero?(background)))
        raise Error.new(Pdfcrowd.create_invalid_value_message(background, "setPageBackground", "pdf-to-pdf", "The file must exist and not be empty.", "set_page_background"), 470);
    end
    
    @files['page_background'] = background
    self
end

#setPageBackgroundUrl(url) ⇒ Object

Load a background PDF from the specified URL and apply the first page of the background PDF to every page of the output PDF.

  • url - The supported protocols are http:// and https://.

  • Returns - The converter object.



3698
3699
3700
3701
3702
3703
3704
3705
 
# File 'lib/pdfcrowd.rb', line 3698

def setPageBackgroundUrl(url)
    unless /(?i)^https?:\/\/.*$/.match(url)
        raise Error.new(Pdfcrowd.create_invalid_value_message(url, "setPageBackgroundUrl", "pdf-to-pdf", "The supported protocols are http:// and https://.", "set_page_background_url"), 470);
    end
    
    @fields['page_background_url'] = url
    self
end

#setPageLayout(layout) ⇒ Object

Specify the page layout to be used when the document is opened.

  • layout - Allowed values are single-page, one-column, two-column-left, two-column-right.

  • Returns - The converter object.



3849
3850
3851
3852
3853
3854
3855
3856
 
# File 'lib/pdfcrowd.rb', line 3849

def setPageLayout(layout)
    unless /(?i)^(single-page|one-column|two-column-left|two-column-right)$/.match(layout)
        raise Error.new(Pdfcrowd.create_invalid_value_message(layout, "setPageLayout", "pdf-to-pdf", "Allowed values are single-page, one-column, two-column-left, two-column-right.", "set_page_layout"), 470);
    end
    
    @fields['page_layout'] = layout
    self
end

#setPageMode(mode) ⇒ Object

Specify how the document should be displayed when opened.

  • mode - Allowed values are full-screen, thumbnails, outlines.

  • Returns - The converter object.



3862
3863
3864
3865
3866
3867
3868
3869
 
# File 'lib/pdfcrowd.rb', line 3862

def setPageMode(mode)
    unless /(?i)^(full-screen|thumbnails|outlines)$/.match(mode)
        raise Error.new(Pdfcrowd.create_invalid_value_message(mode, "setPageMode", "pdf-to-pdf", "Allowed values are full-screen, thumbnails, outlines.", "set_page_mode"), 470);
    end
    
    @fields['page_mode'] = mode
    self
end

#setPageWatermark(watermark) ⇒ Object

Apply the first page of the watermark PDF to every page of the output PDF.

  • watermark - The file path to a local watermark PDF file. The file must exist and not be empty.

  • Returns - The converter object.



3633
3634
3635
3636
3637
3638
3639
3640
 
# File 'lib/pdfcrowd.rb', line 3633

def setPageWatermark(watermark)
    if (!(File.file?(watermark) && !File.zero?(watermark)))
        raise Error.new(Pdfcrowd.create_invalid_value_message(watermark, "setPageWatermark", "pdf-to-pdf", "The file must exist and not be empty.", "set_page_watermark"), 470);
    end
    
    @files['page_watermark'] = watermark
    self
end

#setPageWatermarkUrl(url) ⇒ Object

Load a watermark PDF from the specified URL and apply the first page of the watermark PDF to every page of the output PDF.

  • url - The supported protocols are http:// and https://.

  • Returns - The converter object.



3646
3647
3648
3649
3650
3651
3652
3653
 
# File 'lib/pdfcrowd.rb', line 3646

def setPageWatermarkUrl(url)
    unless /(?i)^https?:\/\/.*$/.match(url)
        raise Error.new(Pdfcrowd.create_invalid_value_message(url, "setPageWatermarkUrl", "pdf-to-pdf", "The supported protocols are http:// and https://.", "set_page_watermark_url"), 470);
    end
    
    @fields['page_watermark_url'] = url
    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.



4075
4076
4077
4078
 
# File 'lib/pdfcrowd.rb', line 4075

def setProxy(host, port, user_name, password)
    @helper.setProxy(host, port, user_name, password)
    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.



4084
4085
4086
4087
 
# File 'lib/pdfcrowd.rb', line 4084

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

#setRightToLeft(value) ⇒ Object

Set the predominant reading order for text to right-to-left. This option has no direct effect on the document’s contents or page numbering but can be used to determine the relative positioning of pages when displayed side by side or printed n-up

  • value - Set to true to set right-to-left reading order.

  • Returns - The converter object.



3968
3969
3970
3971
 
# File 'lib/pdfcrowd.rb', line 3968

def setRightToLeft(value)
    @fields['right_to_left'] = value
    self
end

#setSubject(subject) ⇒ Object

Set the subject of the PDF.

  • subject - The subject.

  • Returns - The converter object.



3809
3810
3811
3812
 
# File 'lib/pdfcrowd.rb', line 3809

def setSubject(subject)
    @fields['subject'] = subject
    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.



4031
4032
4033
4034
 
# File 'lib/pdfcrowd.rb', line 4031

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

#setTitle(title) ⇒ Object

Set the title of the PDF.

  • title - The title.

  • Returns - The converter object.



3800
3801
3802
3803
 
# File 'lib/pdfcrowd.rb', line 3800

def setTitle(title)
    @fields['title'] = title
    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.



4054
4055
4056
4057
 
# File 'lib/pdfcrowd.rb', line 4054

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

#setUseMetadataFrom(index) ⇒ Object

Use metadata (title, subject, author and keywords) from the n-th input PDF.

  • index - Set the index of the input PDF file from which to use the metadata. 0 means no metadata. Must be a positive integer number or 0.

  • Returns - The converter object.



3836
3837
3838
3839
3840
3841
3842
3843
 
# File 'lib/pdfcrowd.rb', line 3836

def setUseMetadataFrom(index)
    if (!(Integer(index) >= 0))
        raise Error.new(Pdfcrowd.create_invalid_value_message(index, "setUseMetadataFrom", "pdf-to-pdf", "Must be a positive integer number or 0.", "set_use_metadata_from"), 470);
    end
    
    @fields['use_metadata_from'] = index
    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.



4063
4064
4065
4066
 
# File 'lib/pdfcrowd.rb', line 4063

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

#setUserPassword(password) ⇒ Object

Protect the PDF with a user password. When a PDF has a user password, it must be supplied in order to view the document and to perform operations allowed by the access permissions.

  • password - The user password.

  • Returns - The converter object.



3755
3756
3757
3758
 
# File 'lib/pdfcrowd.rb', line 3755

def setUserPassword(password)
    @fields['user_password'] = password
    self
end