Class: PureCloud::MediaParticipantRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MediaParticipantRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



70
71
72
73
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
 
# File 'lib/purecloudplatformclientv2/models/media_participant_request.rb', line 70

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

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

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

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

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

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

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

end

Instance Attribute Details

#confined ⇒ Object

True to confine this conversation participant. Should only be used for ad-hoc conferences



34
35
36
 
# File 'lib/purecloudplatformclientv2/models/media_participant_request.rb', line 34

def confined
  @confined
end

#held ⇒ Object

True to hold this conversation participant.



37
38
39
 
# File 'lib/purecloudplatformclientv2/models/media_participant_request.rb', line 37

def held
  @held
end

#muted ⇒ Object

True to mute this conversation participant.



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/media_participant_request.rb', line 31

def muted
  @muted
end

#recording ⇒ Object

True to enable recording of this participant, otherwise false to disable recording.



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/media_participant_request.rb', line 28

def recording
  @recording
end

#state ⇒ Object

The state to update to set for this participant’s communications. Possible values are: ‘connected’ and ‘disconnected’.



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/media_participant_request.rb', line 25

def state
  @state
end

#wrapup ⇒ Object

Wrap-up to assign to this participant.



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

def wrapup
  @wrapup
end

#wrapup_skipped ⇒ Object

True to skip wrap-up for this participant.



40
41
42
 
# File 'lib/purecloudplatformclientv2/models/media_participant_request.rb', line 40

def wrapup_skipped
  @wrapup_skipped
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/purecloudplatformclientv2/models/media_participant_request.rb', line 43

def self.attribute_map
  {
    :'wrapup' => :'wrapup',
    :'state' => :'state',
    :'recording' => :'recording',
    :'muted' => :'muted',
    :'confined' => :'confined',
    :'held' => :'held',
    :'wrapup_skipped' => :'wrapupSkipped'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/purecloudplatformclientv2/models/media_participant_request.rb', line 56

def self.swagger_types
  {
    :'wrapup' => :'Wrapup',
    :'state' => :'String',
    :'recording' => :'BOOLEAN',
    :'muted' => :'BOOLEAN',
    :'confined' => :'BOOLEAN',
    :'held' => :'BOOLEAN',
    :'wrapup_skipped' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/purecloudplatformclientv2/models/media_participant_request.rb', line 134

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      wrapup == o.wrapup &&
      state == o.state &&
      recording == o.recording &&
      muted == o.muted &&
      confined == o.confined &&
      held == o.held &&
      wrapup_skipped == o.wrapup_skipped
end

#_deserialize(type, value) ⇒ Object 



178
179
180
181
182
183
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
 
# File 'lib/purecloudplatformclientv2/models/media_participant_request.rb', line 178

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



238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/purecloudplatformclientv2/models/media_participant_request.rb', line 238

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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/purecloudplatformclientv2/models/media_participant_request.rb', line 159

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


148
149
150
 
# File 'lib/purecloudplatformclientv2/models/media_participant_request.rb', line 148

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



154
155
156
 
# File 'lib/purecloudplatformclientv2/models/media_participant_request.rb', line 154

def hash
  [wrapup, state, recording, muted, confined, held, wrapup_skipped].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



108
109
110
111
 
# File 'lib/purecloudplatformclientv2/models/media_participant_request.rb', line 108

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))



221
222
223
 
# File 'lib/purecloudplatformclientv2/models/media_participant_request.rb', line 221

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



226
227
228
229
230
231
232
233
234
 
# File 'lib/purecloudplatformclientv2/models/media_participant_request.rb', line 226

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 



216
217
218
 
# File 'lib/purecloudplatformclientv2/models/media_participant_request.rb', line 216

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



115
116
117
118
119
120
 
# File 'lib/purecloudplatformclientv2/models/media_participant_request.rb', line 115

def valid?
  allowed_values = ["alerting", "dialing", "contacting", "offering", "connected", "disconnected", "terminated", "converting", "uploading", "transmitting", "none"]
  if @state && !allowed_values.include?(@state)
    return false
  end
end