Class: PureCloud::MessageMediaData

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/message_media_data.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MessageMediaData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
167
168
169
170
171
 
# File 'lib/purecloudplatformclientv2/models/message_media_data.rb', line 92

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

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

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

  
  if attributes.has_key?(:'mediaType')
    
    
    self.media_type = attributes[:'mediaType']
    
  
  end

  
  if attributes.has_key?(:'contentLengthBytes')
    
    
    self.content_length_bytes = attributes[:'contentLengthBytes']
    
  
  end

  
  if attributes.has_key?(:'uploadUrl')
    
    
    self.upload_url = attributes[:'uploadUrl']
    
  
  end

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

  
  if attributes.has_key?(:'selfUri')
    
    
    self.self_uri = attributes[:'selfUri']
    
  
  end

  
end

Instance Attribute Details

#content_length_bytes ⇒ Object

The optional content length of the the media object, in bytes.



33
34
35
 
# File 'lib/purecloudplatformclientv2/models/message_media_data.rb', line 33

def content_length_bytes
  @content_length_bytes
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/message_media_data.rb', line 22

def id
  @id
end

#media_type ⇒ Object

The optional internet media type of the the media object. If null then the media type should be dictated by the url.



30
31
32
 
# File 'lib/purecloudplatformclientv2/models/message_media_data.rb', line 30

def media_type
  @media_type
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloudplatformclientv2/models/message_media_data.rb', line 24

def name
  @name
end

#self_uri ⇒ Object

The URI for this object



42
43
44
 
# File 'lib/purecloudplatformclientv2/models/message_media_data.rb', line 42

def self_uri
  @self_uri
end

#status ⇒ Object

The status of the media, indicates if the media is in the process of uploading. If the upload fails, the media becomes invalid



39
40
41
 
# File 'lib/purecloudplatformclientv2/models/message_media_data.rb', line 39

def status
  @status
end

#upload_url ⇒ Object

The URL returned to upload an attachment



36
37
38
 
# File 'lib/purecloudplatformclientv2/models/message_media_data.rb', line 36

def upload_url
  @upload_url
end

#url ⇒ Object

The location of the media, useful for retrieving it



27
28
29
 
# File 'lib/purecloudplatformclientv2/models/message_media_data.rb', line 27

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/purecloudplatformclientv2/models/message_media_data.rb', line 45

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'url' => :'url',
    
    :'media_type' => :'mediaType',
    
    :'content_length_bytes' => :'contentLengthBytes',
    
    :'upload_url' => :'uploadUrl',
    
    :'status' => :'status',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/purecloudplatformclientv2/models/message_media_data.rb', line 68

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'url' => :'String',
    
    :'media_type' => :'String',
    
    :'content_length_bytes' => :'Integer',
    
    :'upload_url' => :'String',
    
    :'status' => :'String',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/purecloudplatformclientv2/models/message_media_data.rb', line 291

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      url == o.url &&
      media_type == o.media_type &&
      content_length_bytes == o.content_length_bytes &&
      upload_url == o.upload_url &&
      status == o.status &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/purecloudplatformclientv2/models/message_media_data.rb', line 336

def _deserialize(type, value)
  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 =~ /^(true|t|yes|y|1)$/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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

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



396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/purecloudplatformclientv2/models/message_media_data.rb', line 396

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

build the object from hash



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/purecloudplatformclientv2/models/message_media_data.rb', line 317

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


306
307
308
 
# File 'lib/purecloudplatformclientv2/models/message_media_data.rb', line 306

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



312
313
314
 
# File 'lib/purecloudplatformclientv2/models/message_media_data.rb', line 312

def hash
  [id, name, url, media_type, content_length_bytes, upload_url, status, self_uri].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



175
176
177
178
179
180
 
# File 'lib/purecloudplatformclientv2/models/message_media_data.rb', line 175

def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



379
380
381
 
# File 'lib/purecloudplatformclientv2/models/message_media_data.rb', line 379

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



384
385
386
387
388
389
390
391
392
 
# File 'lib/purecloudplatformclientv2/models/message_media_data.rb', line 384

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 ⇒ Object 



374
375
376
 
# File 'lib/purecloudplatformclientv2/models/message_media_data.rb', line 374

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



184
185
186
187
188
189
190
191
192
193
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
 
# File 'lib/purecloudplatformclientv2/models/message_media_data.rb', line 184

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["image/png", "image/jpeg", "image/gif"]
  if @media_type && !allowed_values.include?(@media_type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["uploading", "valid", "invalid"]
  if @status && !allowed_values.include?(@status)
    return false
  end
  
  
  
  
  
  
  
end