Class: AsposeWordsCloud::DocumentEntry
- Inherits:
-
Object
- Object
- AsposeWordsCloud::DocumentEntry
- Defined in:
- lib/aspose_words_cloud/models/document_entry.rb
Overview
Represents a document which will be appended to the original resource document.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#encrypted_password ⇒ Object
Gets or sets document password encrypted on API public key.
-
#file_reference ⇒ Object
Gets or sets the file reference.
-
#import_format_mode ⇒ Object
Gets or sets the option that controls formatting will be used: appended or destination document.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #collectFilesContent(resultFilesContent) ⇒ Object
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ DocumentEntry
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ DocumentEntry
Initializes the object
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/aspose_words_cloud/models/document_entry.rb', line 83 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.key?(:'FileReference') self.file_reference = attributes[:'FileReference'] end if attributes.key?(:'EncryptedPassword') self.encrypted_password = attributes[:'EncryptedPassword'] end if attributes.key?(:'ImportFormatMode') self.import_format_mode = attributes[:'ImportFormatMode'] end end |
Instance Attribute Details
#encrypted_password ⇒ Object
Gets or sets document password encrypted on API public key. The default value is null (the document has no password).
36 37 38 |
# File 'lib/aspose_words_cloud/models/document_entry.rb', line 36 def encrypted_password @encrypted_password end |
#file_reference ⇒ Object
Gets or sets the file reference.
33 34 35 |
# File 'lib/aspose_words_cloud/models/document_entry.rb', line 33 def file_reference @file_reference end |
#import_format_mode ⇒ Object
Gets or sets the option that controls formatting will be used: appended or destination document. Can be KeepSourceFormatting or UseDestinationStyles.
39 40 41 |
# File 'lib/aspose_words_cloud/models/document_entry.rb', line 39 def import_format_mode @import_format_mode end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
64 65 66 67 68 69 70 |
# File 'lib/aspose_words_cloud/models/document_entry.rb', line 64 def self.attribute_map { :'file_reference' => :'FileReference', :'encrypted_password' => :'EncryptedPassword', :'import_format_mode' => :'ImportFormatMode' } end |
.swagger_types ⇒ Object
Attribute type mapping.
73 74 75 76 77 78 79 |
# File 'lib/aspose_words_cloud/models/document_entry.rb', line 73 def self.swagger_types { :'file_reference' => :'FileReference', :'encrypted_password' => :'String', :'import_format_mode' => :'String' } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
135 136 137 138 139 140 141 |
# File 'lib/aspose_words_cloud/models/document_entry.rb', line 135 def ==(other) return true if self.equal?(other) self.class == other.class && file_reference == other.file_reference && encrypted_password == other.encrypted_password && import_format_mode == other.import_format_mode end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'lib/aspose_words_cloud/models/document_entry.rb', line 180 def _deserialize(type, value) case type.to_sym when :DateTime Time.at(/\d/.match(value)[0].to_f).to_datetime when :Date Time.at(/\d/.match(value)[0].to_f).to_date when :String value.to_s when :Integer value.to_i when :Float value.to_f when :BOOLEAN if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model temp_model = AsposeWordsCloud.const_get(type).new temp_model.build_from_hash(value) end end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
247 248 249 250 251 252 253 254 255 256 257 258 259 |
# File 'lib/aspose_words_cloud/models/document_entry.rb', line 247 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 |
# File 'lib/aspose_words_cloud/models/document_entry.rb', line 158 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#collectFilesContent(resultFilesContent) ⇒ Object
261 262 263 264 265 266 267 268 |
# File 'lib/aspose_words_cloud/models/document_entry.rb', line 261 def collectFilesContent(resultFilesContent) if self.file_reference self.file_reference.collectFilesContent(resultFilesContent) end end |
#eql?(other) ⇒ Boolean
145 146 147 |
# File 'lib/aspose_words_cloud/models/document_entry.rb', line 145 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
151 152 153 |
# File 'lib/aspose_words_cloud/models/document_entry.rb', line 151 def hash [file_reference, encrypted_password, import_format_mode].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
104 105 106 107 |
# File 'lib/aspose_words_cloud/models/document_entry.rb', line 104 def list_invalid_properties invalid_properties = [] return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
227 228 229 |
# File 'lib/aspose_words_cloud/models/document_entry.rb', line 227 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
233 234 235 236 237 238 239 240 241 |
# File 'lib/aspose_words_cloud/models/document_entry.rb', line 233 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
221 222 223 |
# File 'lib/aspose_words_cloud/models/document_entry.rb', line 221 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
111 112 113 114 115 116 |
# File 'lib/aspose_words_cloud/models/document_entry.rb', line 111 def valid? import_format_mode_validator = EnumAttributeValidator.new('String', ["UseDestinationStyles", "KeepSourceFormatting", "KeepDifferentStyles"]) return false unless import_format_mode_validator.valid?(@import_format_mode) return true end |