Class: AsposeWordsCloud::ImageEntryList

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_words_cloud/models/image_entry_list.rb

Overview

Represents a list of images which will be appended to the original resource document or image.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ImageEntryList

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/aspose_words_cloud/models/image_entry_list.rb', line 56

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?(:'AppendEachImageOnNewPage')
    self.append_each_image_on_new_page = attributes[:'AppendEachImageOnNewPage']
  end

  if attributes.key?(:'ImageEntries')
    if (value = attributes[:'ImageEntries']).is_a?(Array)
      self.image_entries = value
    end
  end
end

Instance Attribute Details

#append_each_image_on_new_page ⇒ Object

Gets or sets a value indicating whether each image should be added to a new page in the document. This value only has an effect when adding images to a document that supports pagination.



34
35
36
 
# File 'lib/aspose_words_cloud/models/image_entry_list.rb', line 34

def append_each_image_on_new_page
  @append_each_image_on_new_page
end

#image_entries ⇒ Object

Gets or sets the list of images.



37
38
39
 
# File 'lib/aspose_words_cloud/models/image_entry_list.rb', line 37

def image_entries
  @image_entries
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



39
40
41
42
43
44
 
# File 'lib/aspose_words_cloud/models/image_entry_list.rb', line 39

def self.attribute_map
  {
    :'append_each_image_on_new_page' => :'AppendEachImageOnNewPage',
    :'image_entries' => :'ImageEntries'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
 
# File 'lib/aspose_words_cloud/models/image_entry_list.rb', line 47

def self.swagger_types
  {
    :'append_each_image_on_new_page' => :'BOOLEAN',
    :'image_entries' => :'Array<ImageEntry>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



81
82
83
84
85
86
 
# File 'lib/aspose_words_cloud/models/image_entry_list.rb', line 81

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      append_each_image_on_new_page == other.append_each_image_on_new_page &&
      image_entries == other.image_entries
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/aspose_words_cloud/models/image_entry_list.rb', line 125

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

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/aspose_words_cloud/models/image_entry_list.rb', line 196

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/aspose_words_cloud/models/image_entry_list.rb', line 103

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 



210
211
212
213
214
215
216
217
 
# File 'lib/aspose_words_cloud/models/image_entry_list.rb', line 210

def collectFilesContent(resultFilesContent)
  if self.image_entries
      for element in self.image_entries do
          element.collectFilesContent(resultFilesContent);
      end
  end

end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


90
91
92
 
# File 'lib/aspose_words_cloud/models/image_entry_list.rb', line 90

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



96
97
98
 
# File 'lib/aspose_words_cloud/models/image_entry_list.rb', line 96

def hash
  [append_each_image_on_new_page, image_entries].hash
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



176
177
178
 
# File 'lib/aspose_words_cloud/models/image_entry_list.rb', line 176

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



182
183
184
185
186
187
188
189
190
 
# File 'lib/aspose_words_cloud/models/image_entry_list.rb', line 182

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

Returns:

  • (String) —

    String presentation of the object



170
171
172
 
# File 'lib/aspose_words_cloud/models/image_entry_list.rb', line 170

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



75
76
77
 
# File 'lib/aspose_words_cloud/models/image_entry_list.rb', line 75

def valid?
  return true
end

#validate ⇒ Object

Raises:

  • (ArgumentError) 


219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/aspose_words_cloud/models/image_entry_list.rb', line 219

def validate()
  raise ArgumentError, 'Property image_entries in ImageEntryList is required.' if self.image_entries.nil?
  unless self.image_entries.nil?
      for elementImageEntries in self.image_entries
          unless elementImageEntries.nil?
              elementImageEntries.validate
          end
      end
  end

end