Class: Bandwidth::ConferenceMemberJoinCallback

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/bandwidth-sdk/models/conference_member_join_callback.rb

Overview

The Conference Member Join event is fired whenever a caller joins a conference that specified a callbackUrl. The response may be either empty or a BXML document. Only the following verbs are valid for conferences: PlayAudio, SpeakSentence, StartRecording, StopRecording, PauseRecording, ResumeRecording. Audio verbs will be heard by all members of the conference. Recordings capture audio from all members who are not muted or on hold, as well as any audio verbs that are played into the conference.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ ConferenceMemberJoinCallback

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/bandwidth-sdk/models/conference_member_join_callback.rb', line 90

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::ConferenceMemberJoinCallback` initialize method'
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::ConferenceMemberJoinCallback`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'event_type')
    self.event_type = attributes[:'event_type']
  end

  if attributes.key?(:'event_time')
    self.event_time = attributes[:'event_time']
  end

  if attributes.key?(:'conference_id')
    self.conference_id = attributes[:'conference_id']
  end

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

  if attributes.key?(:'from')
    self.from = attributes[:'from']
  end

  if attributes.key?(:'to')
    self.to = attributes[:'to']
  end

  if attributes.key?(:'call_id')
    self.call_id = attributes[:'call_id']
  end

  if attributes.key?(:'tag')
    self.tag = attributes[:'tag']
  end
end

Instance Attribute Details

#call_id ⇒ Object

The call id associated with the event.



38
39
40
 
# File 'lib/bandwidth-sdk/models/conference_member_join_callback.rb', line 38

def call_id
  @call_id
end

#conference_id ⇒ Object

The unique, Bandwidth-generated ID of the conference that was recorded



26
27
28
 
# File 'lib/bandwidth-sdk/models/conference_member_join_callback.rb', line 26

def conference_id
  @conference_id
end

#event_time ⇒ Object

The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution.



23
24
25
 
# File 'lib/bandwidth-sdk/models/conference_member_join_callback.rb', line 23

def event_time
  @event_time
end

#event_type ⇒ Object

The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect.



20
21
22
 
# File 'lib/bandwidth-sdk/models/conference_member_join_callback.rb', line 20

def event_type
  @event_type
end

#from ⇒ Object

The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555).



32
33
34
 
# File 'lib/bandwidth-sdk/models/conference_member_join_callback.rb', line 32

def from
  @from
end

#name ⇒ Object

The user-specified name of the conference that was recorded



29
30
31
 
# File 'lib/bandwidth-sdk/models/conference_member_join_callback.rb', line 29

def name
  @name
end

#tag ⇒ Object

(optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.



41
42
43
 
# File 'lib/bandwidth-sdk/models/conference_member_join_callback.rb', line 41

def tag
  @tag
end

#to ⇒ Object

The phone number that received the call, in E.164 format (e.g. +15555555555).



35
36
37
 
# File 'lib/bandwidth-sdk/models/conference_member_join_callback.rb', line 35

def to
  @to
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



58
59
60
 
# File 'lib/bandwidth-sdk/models/conference_member_join_callback.rb', line 58

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



63
64
65
 
# File 'lib/bandwidth-sdk/models/conference_member_join_callback.rb', line 63

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/bandwidth-sdk/models/conference_member_join_callback.rb', line 44

def self.attribute_map
  {
    :'event_type' => :'eventType',
    :'event_time' => :'eventTime',
    :'conference_id' => :'conferenceId',
    :'name' => :'name',
    :'from' => :'from',
    :'to' => :'to',
    :'call_id' => :'callId',
    :'tag' => :'tag'
  }
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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/bandwidth-sdk/models/conference_member_join_callback.rb', line 182

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



82
83
84
85
86
 
# File 'lib/bandwidth-sdk/models/conference_member_join_callback.rb', line 82

def self.openapi_nullable
  Set.new([
    :'tag'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/bandwidth-sdk/models/conference_member_join_callback.rb', line 68

def self.openapi_types
  {
    :'event_type' => :'String',
    :'event_time' => :'Time',
    :'conference_id' => :'String',
    :'name' => :'String',
    :'from' => :'String',
    :'to' => :'String',
    :'call_id' => :'String',
    :'tag' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/bandwidth-sdk/models/conference_member_join_callback.rb', line 154

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      event_type == o.event_type &&
      event_time == o.event_time &&
      conference_id == o.conference_id &&
      name == o.name &&
      from == o.from &&
      to == o.to &&
      call_id == o.call_id &&
      tag == o.tag
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


169
170
171
 
# File 'lib/bandwidth-sdk/models/conference_member_join_callback.rb', line 169

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



175
176
177
 
# File 'lib/bandwidth-sdk/models/conference_member_join_callback.rb', line 175

def hash
  [event_type, event_time, conference_id, name, from, to, call_id, tag].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



139
140
141
142
143
 
# File 'lib/bandwidth-sdk/models/conference_member_join_callback.rb', line 139

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/bandwidth-sdk/models/conference_member_join_callback.rb', line 204

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



147
148
149
150
 
# File 'lib/bandwidth-sdk/models/conference_member_join_callback.rb', line 147

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end