class AsposeWordsCloud::DocumentEntryList
Represents a list of documents which will be appended to the original resource document.
Attributes
Gets or sets a value indicating whether to append all documents to the same section.
Gets or sets the list of documents.
Public Class Methods
Source
# File lib/aspose_words_cloud/models/document_entry_list.rb, line 41 def self.attribute_map { :'append_all_entries_to_one_section' => :'AppendAllEntriesToOneSection', :'apply_base_document_headers_and_footers_to_appending_documents' => :'ApplyBaseDocumentHeadersAndFootersToAppendingDocuments', :'document_entries' => :'DocumentEntries' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/aspose_words_cloud/models/document_entry_list.rb, line 60 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?(:'AppendAllEntriesToOneSection') self.append_all_entries_to_one_section = attributes[:'AppendAllEntriesToOneSection'] end if attributes.key?(:'ApplyBaseDocumentHeadersAndFootersToAppendingDocuments') self.apply_base_document_headers_and_footers_to_appending_documents = attributes[:'ApplyBaseDocumentHeadersAndFootersToAppendingDocuments'] end if attributes.key?(:'DocumentEntries') if (value = attributes[:'DocumentEntries']).is_a?(Array) self.document_entries = value end end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/aspose_words_cloud/models/document_entry_list.rb, line 50 def self.swagger_types { :'append_all_entries_to_one_section' => :'BOOLEAN', :'apply_base_document_headers_and_footers_to_appending_documents' => :'BOOLEAN', :'document_entries' => :'Array<DocumentEntry>' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/aspose_words_cloud/models/document_entry_list.rb, line 89 def ==(other) return true if self.equal?(other) self.class == other.class && append_all_entries_to_one_section == other.append_all_entries_to_one_section && apply_base_document_headers_and_footers_to_appending_documents == other.apply_base_document_headers_and_footers_to_appending_documents && document_entries == other.document_entries end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/aspose_words_cloud/models/document_entry_list.rb, line 134 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 if value[:'$type'] type = value[:'$type'][0..-4] end temp_model = AsposeWordsCloud.const_get(type).new temp_model.build_from_hash(value) end end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# File lib/aspose_words_cloud/models/document_entry_list.rb, line 205 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
Source
# File lib/aspose_words_cloud/models/document_entry_list.rb, line 112 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/aspose_words_cloud/models/document_entry_list.rb, line 219 def collectFilesContent(resultFilesContent) if self.document_entries for element in self.document_entries do element.collectFilesContent(resultFilesContent); end end end
Source
# File lib/aspose_words_cloud/models/document_entry_list.rb, line 99 def eql?(other) self == other end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/aspose_words_cloud/models/document_entry_list.rb, line 105 def hash [append_all_entries_to_one_section, apply_base_document_headers_and_footers_to_appending_documents, document_entries].hash end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
Source
Source
# File lib/aspose_words_cloud/models/document_entry_list.rb, line 191 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/aspose_words_cloud/models/document_entry_list.rb, line 179 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# File lib/aspose_words_cloud/models/document_entry_list.rb, line 83 def valid? return true end
Check to see if the all the properties in the model are valid @return true if the model is valid
Source
# File lib/aspose_words_cloud/models/document_entry_list.rb, line 228 def validate() raise ArgumentError, 'Property document_entries in DocumentEntryList is required.' if self.document_entries.nil? unless self.document_entries.nil? for elementDocumentEntries in self.document_entries unless elementDocumentEntries.nil? elementDocumentEntries.validate end end end end