Class: Plivo::Resources::Conference
- Inherits:
-
Base::Resource
- Object
- Base::Resource
- Plivo::Resources::Conference
- Defined in:
- lib/plivo/resources/conferences.rb
Constant Summary
Constants included from Utils
Instance Attribute Summary
Attributes inherited from Base::Resource
Instance Method Summary collapse
- #deaf_member(member_id) ⇒ Object
- #delete ⇒ Object
- #delete_member(member_id) ⇒ Object
-
#initialize(client, options = nil) ⇒ Conference
constructor
A new instance of Conference.
- #kick_member(member_id) ⇒ Object
- #mute_member(member_id) ⇒ Object
- #play_member(member_id, url) ⇒ Object
- #record(options = nil) ⇒ Object
- #speak_member(member_id, text, options = nil) ⇒ Object
- #stop_play_member(member_id) ⇒ Object
- #stop_record ⇒ Object
- #stop_speak_member(member_id) ⇒ Object
- #to_json_member(member) ⇒ Object
- #to_s ⇒ Object
- #undeaf_member(member_id) ⇒ Object
- #unmute_member(member_id) ⇒ Object
Methods included from Utils
expected_type?, expected_value?, raise_invalid_request, valid_account?, valid_mainaccount?, valid_param?, valid_signature?, valid_subaccount?
Constructor Details
#initialize(client, options = nil) ⇒ Conference
Returns a new instance of Conference.
5 6 7 8 9 |
# File 'lib/plivo/resources/conferences.rb', line 5 def initialize(client, = nil) @_name = 'Conference' @_identifier_string = 'conference_name' super end |
Instance Method Details
#deaf_member(member_id) ⇒ Object
114 115 116 117 118 119 120 121 |
# File 'lib/plivo/resources/conferences.rb', line 114 def deaf_member(member_id) valid_param?(:member_id, member_id, Array, true) member_id.each do |member| valid_param?(:member, member, [String, Symbol, Integer, Integer], true) end perform_action('Member/' + member_id.join(',') + '/Deaf', 'POST', nil, true) end |
#delete ⇒ Object
11 12 13 |
# File 'lib/plivo/resources/conferences.rb', line 11 def delete perform_delete end |
#delete_member(member_id) ⇒ Object
16 17 18 19 |
# File 'lib/plivo/resources/conferences.rb', line 16 def delete_member(member_id) valid_param?(:member_id, member_id, [String, Symbol, Integer, Integer], true) perform_action('Member/' + member_id.to_s, 'DELETE', nil, true) end |
#kick_member(member_id) ⇒ Object
22 23 24 25 |
# File 'lib/plivo/resources/conferences.rb', line 22 def kick_member(member_id) valid_param?(:member_id, member_id, [String, Symbol, Integer, Integer], true) perform_action('Member/' + member_id.to_s + '/Kick', 'POST', nil, true) end |
#mute_member(member_id) ⇒ Object
28 29 30 31 32 33 34 35 |
# File 'lib/plivo/resources/conferences.rb', line 28 def mute_member(member_id) valid_param?(:member_id, member_id, Array, true) member_id.each do |member| valid_param?(:member, member, [String, Symbol, Integer, Integer], true) end perform_action('Member/' + member_id.join(',') + '/Mute', 'POST', nil, true) end |
#play_member(member_id, url) ⇒ Object
48 49 50 51 52 53 54 55 56 |
# File 'lib/plivo/resources/conferences.rb', line 48 def play_member(member_id, url) valid_param?(:member_id, member_id, Array, true) valid_param?(:url, url, String, true) member_id.each do |member| valid_param?(:member, member, [String, Symbol, Integer, Integer], true) end perform_action('Member/' + member_id.join(',') + '/Play', 'POST', { url: url }, true) end |
#record(options = nil) ⇒ Object
150 151 152 153 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 |
# File 'lib/plivo/resources/conferences.rb', line 150 def record( = nil) return perform_action('Record', 'POST', nil, true) if .nil? valid_param?(:options, , Hash, true) params = {} %i[transcription_url callback_url].each do |param| if .key?(param) && valid_param?(param, [param], [String, Symbol], true) params[param] = [param] end end %i[transcription_method callback_method].each do |param| if .key?(param) && valid_param?(param, [param], [String, Symbol], true, %w[GET POST]) params[param] = [param] end end if .key?(:file_format) && valid_param?(:file_format, [:file_format], [String, Symbol], true, %w[wav mp3]) params[:file_format] = [:file_format] end if .key?(:transcription_type) && valid_param?(:transcription_type, [:transcription_type], [String, Symbol], true, %w[auto hybrid]) params[:transcription_type] = [:transcription_type] end perform_action('Record', 'POST', params, true) end |
#speak_member(member_id, text, options = nil) ⇒ Object
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 |
# File 'lib/plivo/resources/conferences.rb', line 73 def speak_member(member_id, text, = nil) valid_param?(:member_id, member_id, Array, true) valid_param?(:text, text, String, true) member_id.each do |member| valid_param?(:member, member, [String, Symbol, Integer, Integer], true) end params = { text: text } if .nil? return perform_action('Member/' + member_id.join(',') + '/Speak', 'POST', params, true) end if .key?(:voice) && valid_param?(:voice, [:voice], [String, Symbol], true, %w[MAN WOMAN]) params[:voice] = [:voice] end if .key?(:language) && valid_param?(:language, [:language], String, true) params[:language] = [:language] end perform_action('Member/' + member_id.join(',') + '/Speak', 'POST', params, true) end |
#stop_play_member(member_id) ⇒ Object
59 60 61 62 63 64 65 66 |
# File 'lib/plivo/resources/conferences.rb', line 59 def stop_play_member(member_id) valid_param?(:member_id, member_id, Array, true) member_id.each do |member| valid_param?(:member, member, [String, Symbol, Integer, Integer], true) end perform_action('Member/' + member_id.join(',') + '/Play', 'DELETE', nil, true) end |
#stop_record ⇒ Object
184 185 186 |
# File 'lib/plivo/resources/conferences.rb', line 184 def stop_record perform_action('Record', 'DELETE') end |
#stop_speak_member(member_id) ⇒ Object
104 105 106 107 108 109 110 111 |
# File 'lib/plivo/resources/conferences.rb', line 104 def stop_speak_member(member_id) valid_param?(:member_id, member_id, Array, true) member_id.each do |member| valid_param?(:member, member, [String, Symbol, Integer, Integer], true) end perform_action('Member/' + member_id.join(',') + '/Speak', 'DELETE', nil, true) end |
#to_json_member(member) ⇒ Object
203 204 205 206 207 208 209 210 211 212 213 214 215 |
# File 'lib/plivo/resources/conferences.rb', line 203 def to_json_member(member) { muted: member['muted'], member_id: member['member_id'], deaf: member['deaf'], from: member['from'], to: member['to'], caller_name: member['caller_name'], direction: member['direction'], call_uuid: member['call_uuid'], join_time: member['join_time'] }.to_json end |
#to_s ⇒ Object
188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'lib/plivo/resources/conferences.rb', line 188 def to_s unless @members.nil? members_json = @members.map do |member| JSON.parse(to_json_member(member)) end end { conference_name: @conference_name, conference_run_time: @conference_run_time, conference_member_count: @conference_member_count, members: members_json, api_id: @api_id }.to_s end |
#undeaf_member(member_id) ⇒ Object
124 125 126 127 128 129 130 131 |
# File 'lib/plivo/resources/conferences.rb', line 124 def undeaf_member(member_id) valid_param?(:member_id, member_id, Array, true) member_id.each do |member| valid_param?(:member, member, [String, Symbol, Integer, Integer], true) end perform_action('Member/' + member_id.join(',') + '/Deaf', 'DELETE', nil, true) end |
#unmute_member(member_id) ⇒ Object
38 39 40 41 42 43 44 |
# File 'lib/plivo/resources/conferences.rb', line 38 def unmute_member(member_id) valid_param?(:member_id, member_id, Array, true) member_id.each do |member| valid_param?(:member, member, [String, Symbol, Integer, Integer], true) end perform_action('Member/' + member_id.join(',') + '/Mute', 'DELETE') end |