Class: AsposeSlidesCloud::SlideCommentBase

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_slides_cloud/models/slide_comment_base.rb

Overview

Represents slide comment

Direct Known Subclasses

SlideComment, SlideModernComment

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SlideCommentBase

Initializes the object

Parameters:

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

    Model attributes in the form of hash



88
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
# File 'lib/aspose_slides_cloud/models/slide_comment_base.rb', line 88

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

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

  if attributes.has_key?(:'CreatedTime')
    self.created_time = attributes[:'CreatedTime']
  end

  if attributes.has_key?(:'ChildComments')
    if (value = attributes[:'ChildComments']).is_a?(Array)
      self.child_comments = value
    end
  end

  if attributes.has_key?(:'Type')
    self.type = attributes[:'Type']
  end
end

Instance Attribute Details

#authorObject

Author.



29
30
31
# File 'lib/aspose_slides_cloud/models/slide_comment_base.rb', line 29

def author
  @author
end

#child_commentsObject

Child comments.



38
39
40
# File 'lib/aspose_slides_cloud/models/slide_comment_base.rb', line 38

def child_comments
  @child_comments
end

#created_timeObject

Creation time.



35
36
37
# File 'lib/aspose_slides_cloud/models/slide_comment_base.rb', line 35

def created_time
  @created_time
end

#textObject

Text.



32
33
34
# File 'lib/aspose_slides_cloud/models/slide_comment_base.rb', line 32

def text
  @text
end

#typeObject

Returns the value of attribute type.



40
41
42
# File 'lib/aspose_slides_cloud/models/slide_comment_base.rb', line 40

def type
  @type
end

Class Method Details

.attribute_mapObject

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



65
66
67
68
69
70
71
72
73
# File 'lib/aspose_slides_cloud/models/slide_comment_base.rb', line 65

def self.attribute_map
  {
    :'author' => :'Author',
    :'text' => :'Text',
    :'created_time' => :'CreatedTime',
    :'child_comments' => :'ChildComments',
    :'type' => :'Type',
  }
end

.swagger_typesObject

Attribute type mapping.



76
77
78
79
80
81
82
83
84
# File 'lib/aspose_slides_cloud/models/slide_comment_base.rb', line 76

def self.swagger_types
  {
    :'author' => :'String',
    :'text' => :'String',
    :'created_time' => :'String',
    :'child_comments' => :'Array<SlideCommentBase>',
    :'type' => :'String',
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



144
145
146
147
148
149
150
151
152
# File 'lib/aspose_slides_cloud/models/slide_comment_base.rb', line 144

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      author == o.author &&
      text == o.text &&
      created_time == o.created_time &&
      child_comments == o.child_comments &&
      type == o.type
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



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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
# File 'lib/aspose_slides_cloud/models/slide_comment_base.rb', line 202

def _deserialize(type, value)
  if value.nil?
    nil
  else
    case type.to_sym
    when :DateTime
      DateTime.parse(value)
    when :Date
      Date.parse(value)
    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
      registry_type = AsposeSlidesCloud::TypeRegistry.get_type(type.to_s, value)
      if registry_type
        type = registry_type
      end
      temp_model = AsposeSlidesCloud.const_get(type).new
      temp_model.build_from_hash(value)
    end
  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



276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'lib/aspose_slides_cloud/models/slide_comment_base.rb', line 276

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



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
# File 'lib/aspose_slides_cloud/models/slide_comment_base.rb', line 169

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    mapKey = self.class.attribute_map[key]
    if !mapKey.nil?
      val = attributes[mapKey]
      if val.nil?
        mapKeyString = mapKey.to_s
        mapKeyString[0] = mapKeyString[0].downcase
        mapKey = mapKeyString.to_sym
        val = attributes[mapKey]
      end
      if !val.nil?
        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 val.is_a?(Array)
            self.send("#{key}=", val.map { |v| _deserialize($1, v) })
          end
        else
          self.send("#{key}=", _deserialize(type, val))
        end
      end
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


156
157
158
# File 'lib/aspose_slides_cloud/models/slide_comment_base.rb', line 156

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



162
163
164
# File 'lib/aspose_slides_cloud/models/slide_comment_base.rb', line 162

def hash
  [author, text, created_time, child_comments, type].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



119
120
121
122
# File 'lib/aspose_slides_cloud/models/slide_comment_base.rb', line 119

def list_invalid_properties
  invalid_properties = Array.new
  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



256
257
258
# File 'lib/aspose_slides_cloud/models/slide_comment_base.rb', line 256

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



262
263
264
265
266
267
268
269
270
# File 'lib/aspose_slides_cloud/models/slide_comment_base.rb', line 262

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



250
251
252
# File 'lib/aspose_slides_cloud/models/slide_comment_base.rb', line 250

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



126
127
128
129
130
# File 'lib/aspose_slides_cloud/models/slide_comment_base.rb', line 126

def valid?
  type_validator = EnumAttributeValidator.new('String', ['Regular', 'Modern'])
  return false unless type_validator.valid?(@type)
  true
end