class TXTextControl::ReportingCloud::DocumentSettings
Holds the merge settings needed by the {ReportingCloud.append_documents} method. @attr author [String] The document's author. @attr creation_date
[DateTime] The document's creation date. @attr creator_application
[String] The application which created the document. @attr document_subject
[String] The document's subject. @attr document_title
[String] The document's title. @attr last_modification_date
[DateTime] The document's last modification date. @attr user_password
[String] The password needed to open the document. @author Thorsten Kummerow (@thomerow)
Attributes
creator_application[RW]
document_subject[RW]
document_title[RW]
user_password[RW]
Public Class Methods
new()
click to toggle source
# File lib/txtextcontrol/reportingcloud/document_settings.rb, line 34 def initialize @author = nil @creation_date = nil @creator_application = nil @document_subject = nil @document_title = nil @last_modification_date = nil @user_password = nil end
Public Instance Methods
creation_date()
click to toggle source
# File lib/txtextcontrol/reportingcloud/document_settings.rb, line 44 def creation_date @creation_date end
creation_date=(val)
click to toggle source
# File lib/txtextcontrol/reportingcloud/document_settings.rb, line 48 def creation_date=(val) case val when nil @creation_date = nil when String @creation_date = DateTime.iso8601(val) when DateTime @creation_date = val else raise ArgumentError, "Value must be a string or an instance of type DateTime." end end
last_modification_date()
click to toggle source
# File lib/txtextcontrol/reportingcloud/document_settings.rb, line 60 def last_modification_date @last_modification_date end
last_modification_date=(val)
click to toggle source
# File lib/txtextcontrol/reportingcloud/document_settings.rb, line 64 def last_modification_date=(val) case val when nil @last_modification_date = nil when String @last_modification_date = DateTime.iso8601(val) when DateTime @last_modification_date = val else raise ArgumentError, "Value must be a string or an instance of type DateTime." end end
to_camelized_hash()
click to toggle source
Converts a DocumentSettings
instance to a hash while converting the attribute names from snake case to camel case. @return [Hash] A hash representing the DocumentSettings
instance.
# File lib/txtextcontrol/reportingcloud/document_settings.rb, line 79 def to_camelized_hash return { "author" => @author, "creationDate" => @creation_date.nil? ? nil : @creation_date.iso8601, "creatorApplication" => @creator_application, "documentSubject" => @document_subject, "documentTitle" => @document_title, "lastModificationDate" => @last_modification_date.nil? ? nil : @last_modification_date.iso8601, "userPassword" => @user_password } end