Class: AsposeWordsCloud::Comment

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

Overview

Comment.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Comment

Initializes the object

Parameters:

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

    Model attributes in the form of hash



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/aspose_words_cloud/models/comment.rb', line 89

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

  if attributes.key?(:'Author')
    self.author = attributes[:'Author']
  end

  if attributes.key?(:'Content')
    self.content = attributes[:'Content']
  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

#author ⇒ Object

Gets or sets returns or sets the author name for a comment.



38
39
40
 
# File 'lib/aspose_words_cloud/models/comment.rb', line 38

def author
  @author
end

#content ⇒ Object

Gets or sets content of comment.



41
42
43
 
# File 'lib/aspose_words_cloud/models/comment.rb', line 41

def content
  @content
end

#date_time ⇒ Object

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



44
45
46
 
# File 'lib/aspose_words_cloud/models/comment.rb', line 44

def date_time
  @date_time
end

#initial ⇒ Object

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



47
48
49
 
# File 'lib/aspose_words_cloud/models/comment.rb', line 47

def initial
  @initial
end

#link ⇒ Object

Gets or sets link to the document.



35
36
37
 
# File 'lib/aspose_words_cloud/models/comment.rb', line 35

def link
  @link
end

#range_end ⇒ Object

Gets or sets link to comment range end node.



50
51
52
 
# File 'lib/aspose_words_cloud/models/comment.rb', line 50

def range_end
  @range_end
end

#range_start ⇒ Object

Gets or sets link to comment range start node.



53
54
55
 
# File 'lib/aspose_words_cloud/models/comment.rb', line 53

def range_start
  @range_start
end

#text ⇒ Object

Gets or sets this is a convenience property that allows to easily get or set text of the comment.



56
57
58
 
# File 'lib/aspose_words_cloud/models/comment.rb', line 56

def text
  @text
end

Class Method Details

.attribute_map ⇒ Object

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



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

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

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/aspose_words_cloud/models/comment.rb', line 74

def self.swagger_types
  {
    :'link' => :'WordsApiLink',
    :'author' => :'String',
    :'content' => :'StoryChildNodes',
    :'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



144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/aspose_words_cloud/models/comment.rb', line 144

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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/aspose_words_cloud/models/comment.rb', line 194

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



261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/aspose_words_cloud/models/comment.rb', line 261

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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/aspose_words_cloud/models/comment.rb', line 172

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


159
160
161
 
# File 'lib/aspose_words_cloud/models/comment.rb', line 159

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



165
166
167
 
# File 'lib/aspose_words_cloud/models/comment.rb', line 165

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

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



131
132
133
134
 
# File 'lib/aspose_words_cloud/models/comment.rb', line 131

def list_invalid_properties
  invalid_properties = []
  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



241
242
243
 
# File 'lib/aspose_words_cloud/models/comment.rb', line 241

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



247
248
249
250
251
252
253
254
255
 
# File 'lib/aspose_words_cloud/models/comment.rb', line 247

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



235
236
237
 
# File 'lib/aspose_words_cloud/models/comment.rb', line 235

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



138
139
140
 
# File 'lib/aspose_words_cloud/models/comment.rb', line 138

def valid?
  return true
end