Class: AsposeWordsCloud::ListUpdate

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

Overview

Update document properties if document list.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ListUpdate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



51
52
53
54
55
56
57
58
59
60
 
# File 'lib/aspose_words_cloud/models/list_update.rb', line 51

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

Instance Attribute Details

#is_restart_at_each_section ⇒ Object

Gets or sets a value indicating whether list should be restarted at each section. The default value is false. This option is supported only in RTF, DOC and DOCX document formats. This option will be written to DOCX only if Aspose.Words.Saving.OoxmlCompliance is higher than Aspose.Words.Saving.OoxmlCompliance.Ecma376_2006.



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

def is_restart_at_each_section
  @is_restart_at_each_section
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
 
# File 'lib/aspose_words_cloud/models/list_update.rb', line 36

def self.attribute_map
  {
    :'is_restart_at_each_section' => :'IsRestartAtEachSection'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
 
# File 'lib/aspose_words_cloud/models/list_update.rb', line 43

def self.swagger_types
  {
    :'is_restart_at_each_section' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



70
71
72
73
74
 
# File 'lib/aspose_words_cloud/models/list_update.rb', line 70

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      is_restart_at_each_section == other.is_restart_at_each_section
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



113
114
115
116
117
118
119
120
121
122
123
124
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
 
# File 'lib/aspose_words_cloud/models/list_update.rb', line 113

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



184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/aspose_words_cloud/models/list_update.rb', line 184

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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/aspose_words_cloud/models/list_update.rb', line 91

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 



198
199
 
# File 'lib/aspose_words_cloud/models/list_update.rb', line 198

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


78
79
80
 
# File 'lib/aspose_words_cloud/models/list_update.rb', line 78

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



84
85
86
 
# File 'lib/aspose_words_cloud/models/list_update.rb', line 84

def hash
  [is_restart_at_each_section].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



164
165
166
 
# File 'lib/aspose_words_cloud/models/list_update.rb', line 164

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



170
171
172
173
174
175
176
177
178
 
# File 'lib/aspose_words_cloud/models/list_update.rb', line 170

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



158
159
160
 
# File 'lib/aspose_words_cloud/models/list_update.rb', line 158

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



64
65
66
 
# File 'lib/aspose_words_cloud/models/list_update.rb', line 64

def valid?
  return true
end

#validate ⇒ Object 



201
202
 
# File 'lib/aspose_words_cloud/models/list_update.rb', line 201

def validate()
end