Class: PureCloud::Scene

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/scene.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Scene

Returns a new instance of Scene.



87
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'lib/purecloud/models/scene.rb', line 87

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'sceneGroup']
    self.scene_group = attributes[:'sceneGroup']
  end
  
  if attributes[:'assets']
    if (value = attributes[:'assets']).is_a?(Array)
      self.assets = value
    end
  end
  
  if attributes[:'thumbnail']
    self.thumbnail = attributes[:'thumbnail']
  end
  
  if attributes[:'description']
    self.description = attributes[:'description']
  end
  
  if attributes[:'waypoints']
    if (value = attributes[:'waypoints']).is_a?(Array)
      self.waypoints = value
    end
  end
  
  if attributes[:'defaultOrientationY']
    self.default_orientation_y = attributes[:'defaultOrientationY']
  end
  
  if attributes[:'type']
    self.type = attributes[:'type']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#assetsObject

Returns the value of attribute assets.



28
29
30
# File 'lib/purecloud/models/scene.rb', line 28

def assets
  @assets
end

#default_orientation_yObject

Returns the value of attribute default_orientation_y.



36
37
38
# File 'lib/purecloud/models/scene.rb', line 36

def default_orientation_y
  @default_orientation_y
end

#descriptionObject

Returns the value of attribute description.



32
33
34
# File 'lib/purecloud/models/scene.rb', line 32

def description
  @description
end

#idObject

The globally unique identifier for the object.



22
23
24
# File 'lib/purecloud/models/scene.rb', line 22

def id
  @id
end

#nameObject

Returns the value of attribute name.



24
25
26
# File 'lib/purecloud/models/scene.rb', line 24

def name
  @name
end

#scene_groupObject

Returns the value of attribute scene_group.



26
27
28
# File 'lib/purecloud/models/scene.rb', line 26

def scene_group
  @scene_group
end

#self_uriObject

The URI for this object



41
42
43
# File 'lib/purecloud/models/scene.rb', line 41

def self_uri
  @self_uri
end

#thumbnailObject

Returns the value of attribute thumbnail.



30
31
32
# File 'lib/purecloud/models/scene.rb', line 30

def thumbnail
  @thumbnail
end

#typeObject

Returns the value of attribute type.



38
39
40
# File 'lib/purecloud/models/scene.rb', line 38

def type
  @type
end

#waypointsObject

Returns the value of attribute waypoints.



34
35
36
# File 'lib/purecloud/models/scene.rb', line 34

def waypoints
  @waypoints
end

Class Method Details

.attribute_mapObject

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



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# File 'lib/purecloud/models/scene.rb', line 44

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'scene_group' => :'sceneGroup',
    
    :'assets' => :'assets',
    
    :'thumbnail' => :'thumbnail',
    
    :'description' => :'description',
    
    :'waypoints' => :'waypoints',
    
    :'default_orientation_y' => :'defaultOrientationY',
    
    :'type' => :'type',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_typesObject

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# File 'lib/purecloud/models/scene.rb', line 71

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'scene_group' => :'SceneGroup',
    :'assets' => :'Array<Asset>',
    :'thumbnail' => :'Thumbnail',
    :'description' => :'String',
    :'waypoints' => :'Array<Waypoint>',
    :'default_orientation_y' => :'Float',
    :'type' => :'String',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



150
151
152
153
154
155
156
157
158
159
160
161
162
163
# File 'lib/purecloud/models/scene.rb', line 150

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      scene_group == o.scene_group &&
      assets == o.assets &&
      thumbnail == o.thumbnail &&
      description == o.description &&
      waypoints == o.waypoints &&
      default_orientation_y == o.default_orientation_y &&
      type == o.type &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object



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/purecloud/models/scene.rb', line 195

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



255
256
257
258
259
260
261
262
263
264
265
266
267
# File 'lib/purecloud/models/scene.rb', line 255

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



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
# File 'lib/purecloud/models/scene.rb', line 176

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

Returns:

  • (Boolean)

See Also:

  • `==` method


166
167
168
# File 'lib/purecloud/models/scene.rb', line 166

def eql?(o)
  self == o
end

#hashObject

Calculate hash code according to all attributes.



171
172
173
# File 'lib/purecloud/models/scene.rb', line 171

def hash
  [id, name, scene_group, assets, thumbnail, description, waypoints, default_orientation_y, type, self_uri].hash
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



238
239
240
# File 'lib/purecloud/models/scene.rb', line 238

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



243
244
245
246
247
248
249
250
251
# File 'lib/purecloud/models/scene.rb', line 243

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_sObject



233
234
235
# File 'lib/purecloud/models/scene.rb', line 233

def to_s
  to_hash.to_s
end