Class: PureCloud::ScreenRecordingSession

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScreenRecordingSession

Returns a new instance of ScreenRecordingSession.



74
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
105
106
107
108
109
 
# File 'lib/purecloud/models/screen_recording_session.rb', line 74

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[:'user']
    self.user = attributes[:'user']
  end
  
  if attributes[:'participantId']
    self.participant_id = attributes[:'participantId']
  end
  
  if attributes[:'conversation']
    self.conversation = attributes[:'conversation']
  end
  
  if attributes[:'startTime']
    self.start_time = attributes[:'startTime']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#conversation ⇒ Object

Returns the value of attribute conversation.



31
32
33
 
# File 'lib/purecloud/models/screen_recording_session.rb', line 31

def conversation
  @conversation
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#participant_id ⇒ Object

The id of the participant whose screen is being recorded on the conversation



29
30
31
 
# File 'lib/purecloud/models/screen_recording_session.rb', line 29

def participant_id
  @participant_id
end

#self_uri ⇒ Object

The URI for this object



37
38
39
 
# File 'lib/purecloud/models/screen_recording_session.rb', line 37

def self_uri
  @self_uri
end

#start_time ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def start_time
  @start_time
end

#user ⇒ Object

Returns the value of attribute user.



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

def user
  @user
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/purecloud/models/screen_recording_session.rb', line 40

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'user' => :'user',
    
    :'participant_id' => :'participantId',
    
    :'conversation' => :'conversation',
    
    :'start_time' => :'startTime',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/purecloud/models/screen_recording_session.rb', line 61

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'user' => :'User',
    :'participant_id' => :'String',
    :'conversation' => :'Conversation',
    :'start_time' => :'DateTime',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/purecloud/models/screen_recording_session.rb', line 112

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      user == o.user &&
      participant_id == o.participant_id &&
      conversation == o.conversation &&
      start_time == o.start_time &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/purecloud/models/screen_recording_session.rb', line 154

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



214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/purecloud/models/screen_recording_session.rb', line 214

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



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/purecloud/models/screen_recording_session.rb', line 135

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


125
126
127
 
# File 'lib/purecloud/models/screen_recording_session.rb', line 125

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



130
131
132
 
# File 'lib/purecloud/models/screen_recording_session.rb', line 130

def hash
  [id, name, user, participant_id, conversation, start_time, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



197
198
199
 
# File 'lib/purecloud/models/screen_recording_session.rb', line 197

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



202
203
204
205
206
207
208
209
210
 
# File 'lib/purecloud/models/screen_recording_session.rb', line 202

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 



192
193
194
 
# File 'lib/purecloud/models/screen_recording_session.rb', line 192

def to_s
  to_hash.to_s
end