Class: AsposeWordsCloud::CommentUpdate

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

Overview

Comment update.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CommentUpdate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# File 'lib/aspose_words_cloud/models/comment_update.rb', line 75

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

  if attributes.key?(:'DateTime')
    self.date_time = attributes[:'DateTime']
  end

  if attributes.key?(:'Initial')
    self.initial = attributes[:'Initial']
  end

  if attributes.key?(:'RangeEnd')
    self.range_end = attributes[:'RangeEnd']
  end

  if attributes.key?(:'RangeStart')
    self.range_start = attributes[:'RangeStart']
  end

  if attributes.key?(:'Text')
    self.text = attributes[:'Text']
  end
end

Instance Attribute Details

#authorObject

Gets or sets the author name for a comment.



33
34
35
# File 'lib/aspose_words_cloud/models/comment_update.rb', line 33

def author
  @author
end

#date_timeObject

Gets or sets the date and time that the comment was made.



36
37
38
# File 'lib/aspose_words_cloud/models/comment_update.rb', line 36

def date_time
  @date_time
end

#initialObject

Gets or sets the initials of the user associated with a specific comment.



39
40
41
# File 'lib/aspose_words_cloud/models/comment_update.rb', line 39

def initial
  @initial
end

#range_endObject

Gets or sets the link to comment range end node.



42
43
44
# File 'lib/aspose_words_cloud/models/comment_update.rb', line 42

def range_end
  @range_end
end

#range_startObject

Gets or sets the link to comment range start node.



45
46
47
# File 'lib/aspose_words_cloud/models/comment_update.rb', line 45

def range_start
  @range_start
end

#textObject

Gets or sets text of the comment.



48
49
50
# File 'lib/aspose_words_cloud/models/comment_update.rb', line 48

def text
  @text
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    :'author' => :'Author',
    :'date_time' => :'DateTime',
    :'initial' => :'Initial',
    :'range_end' => :'RangeEnd',
    :'range_start' => :'RangeStart',
    :'text' => :'Text'
  }
end

.swagger_typesObject

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
# File 'lib/aspose_words_cloud/models/comment_update.rb', line 62

def self.swagger_types
  {
    :'author' => :'String',
    :'date_time' => :'DateTime',
    :'initial' => :'String',
    :'range_end' => :'DocumentPosition',
    :'range_start' => :'DocumentPosition',
    :'text' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



121
122
123
124
125
126
127
128
129
130
# File 'lib/aspose_words_cloud/models/comment_update.rb', line 121

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      author == other.author &&
      date_time == other.date_time &&
      initial == other.initial &&
      range_end == other.range_end &&
      range_start == other.range_start &&
      text == other.text
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



169
170
171
172
173
174
175
176
177
178
179
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
# File 'lib/aspose_words_cloud/models/comment_update.rb', line 169

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

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



236
237
238
239
240
241
242
243
244
245
246
247
248
# File 'lib/aspose_words_cloud/models/comment_update.rb', line 236

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



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
# File 'lib/aspose_words_cloud/models/comment_update.rb', line 147

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

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


134
135
136
# File 'lib/aspose_words_cloud/models/comment_update.rb', line 134

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



140
141
142
# File 'lib/aspose_words_cloud/models/comment_update.rb', line 140

def hash
  [author, date_time, initial, range_end, range_start, text].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



108
109
110
111
# File 'lib/aspose_words_cloud/models/comment_update.rb', line 108

def list_invalid_properties
  invalid_properties = []
  return invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



216
217
218
# File 'lib/aspose_words_cloud/models/comment_update.rb', line 216

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



222
223
224
225
226
227
228
229
230
# File 'lib/aspose_words_cloud/models/comment_update.rb', line 222

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



210
211
212
# File 'lib/aspose_words_cloud/models/comment_update.rb', line 210

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



115
116
117
# File 'lib/aspose_words_cloud/models/comment_update.rb', line 115

def valid?
  return true
end