class TXTextControl::ReportingCloud::MergeBody
Passes data to the {ReportingCloud.merge_document} method. @attr merge_data
[Array<Hash>] The merge data. Must be an array of hashes. @attr template [String] Base64 encoded template document.
Supported formats are RTF, DOC, DOCX and TX.
@attr merge_settings
[MergeSettings] Merge settings to specify
merge properties and document properties such as title and author.
@author Thorsten Kummerow (@thomerow)
Attributes
merge_settings[RW]
template[RW]
Public Class Methods
new(merge_data, merge_settings = nil, template = nil)
click to toggle source
The constructor. @param merge_data
[Array<Hash>] The merge data. Must be an array of hashes. @param template [String] Base64 encoded template document.
Supported formats are RTF, DOC, DOCX and TX.
@param merge_settings
[MergeSettings] Merge settings to specify
merge properties and document properties such as title and author.
# File lib/txtextcontrol/reportingcloud/merge_body.rb, line 38 def initialize(merge_data, merge_settings = nil, template = nil) self.merge_data = merge_data @template = template @merge_settings = merge_settings end
Public Instance Methods
merge_data()
click to toggle source
# File lib/txtextcontrol/reportingcloud/merge_body.rb, line 51 def merge_data @merge_data end
merge_data=(val)
click to toggle source
# File lib/txtextcontrol/reportingcloud/merge_body.rb, line 44 def merge_data=(val) unless val.kind_of?(Array) && !val.empty? && val[0].kind_of?(Hash) raise ArgumentError, "Merge data must be a non empty array of hashes." end @merge_data = val end
to_camelized_hash()
click to toggle source
Converts a MergeBody
instance to a hash while converting the attribute names from snake case to camel case. @return [Hash] A hash representing the MergeBody
instance.
# File lib/txtextcontrol/reportingcloud/merge_body.rb, line 58 def to_camelized_hash return { "mergeData" => @merge_data, "template" => @template, "mergeSettings" => @merge_settings.nil? ? nil : @merge_settings.to_camelized_hash } end