Class: Plivo::Resources::ConferenceInterface
Constant Summary
Constants included
from Utils
Utils::TYPE_WHITELIST
Instance Method Summary
collapse
-
#deaf_member(conference_name, member_id) ⇒ Object
-
#delete(conference_name) ⇒ Object
-
#delete_all ⇒ Object
-
#delete_member(conference_name, member_id) ⇒ Object
-
#each ⇒ Object
-
#get(conference_name) ⇒ Object
-
#initialize(client, resource_list_json = nil) ⇒ ConferenceInterface
constructor
A new instance of ConferenceInterface.
-
#kick_member(conference_name, member_id) ⇒ Object
-
#list ⇒ Object
-
#mute_member(conference_name, member_id) ⇒ Object
-
#play_member(conference_name, member_id, url) ⇒ Object
-
#record(conference_name, options = nil) ⇒ Object
-
#speak_member(conference_name, member_id, text, options = nil) ⇒ Object
-
#stop_play_member(conference_name, member_id) ⇒ Object
-
#stop_record(conference_name) ⇒ Object
-
#stop_speak_member(conference_name, member_id) ⇒ Object
-
#undeaf_member(conference_name, member_id) ⇒ Object
-
#unmute_member(conference_name, 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, resource_list_json = nil) ⇒ ConferenceInterface
Returns a new instance of ConferenceInterface.
219
220
221
222
223
224
|
# File 'lib/plivo/resources/conferences.rb', line 219
def initialize(client, resource_list_json = nil)
@_name = 'Conference'
@_resource_type = Conference
@_identifier_string = 'conference_name'
super
end
|
Instance Method Details
#deaf_member(conference_name, member_id) ⇒ Object
325
326
327
328
329
|
# File 'lib/plivo/resources/conferences.rb', line 325
def deaf_member(conference_name, member_id)
valid_param?(:conference_name, conference_name, [String, Symbol], true)
Conference.new(@_client, resource_id: conference_name)
.deaf_member(member_id)
end
|
#delete(conference_name) ⇒ Object
247
248
249
250
251
252
253
|
# File 'lib/plivo/resources/conferences.rb', line 247
def delete(conference_name)
valid_param?(:conference_name, conference_name, [String, Symbol], true)
if conference_name.empty?
raise_invalid_request('Invalid conference_name passed')
end
Conference.new(@_client, resource_id: conference_name).delete
end
|
#delete_all ⇒ Object
243
244
245
|
# File 'lib/plivo/resources/conferences.rb', line 243
def delete_all
Conference.new(@_client, resource_id: '').delete
end
|
#delete_member(conference_name, member_id) ⇒ Object
257
258
259
260
261
|
# File 'lib/plivo/resources/conferences.rb', line 257
def delete_member(conference_name, member_id)
valid_param?(:conference_name, conference_name, [String, Symbol], true)
Conference.new(@_client, resource_id: conference_name)
.delete_member(member_id)
end
|
#each ⇒ Object
238
239
240
241
|
# File 'lib/plivo/resources/conferences.rb', line 238
def each
conference_list = list
conference_list[:conferences].each { |conference| yield conference }
end
|
#get(conference_name) ⇒ Object
226
227
228
|
# File 'lib/plivo/resources/conferences.rb', line 226
def get(conference_name)
perform_get(conference_name)
end
|
#kick_member(conference_name, member_id) ⇒ Object
265
266
267
268
269
|
# File 'lib/plivo/resources/conferences.rb', line 265
def kick_member(conference_name, member_id)
valid_param?(:conference_name, conference_name, [String, Symbol], true)
Conference.new(@_client, resource_id: conference_name)
.kick_member(member_id)
end
|
#list ⇒ Object
230
231
232
233
234
235
236
|
# File 'lib/plivo/resources/conferences.rb', line 230
def list
perform_list_without_object
{
api_id: @api_id,
conferences: @conferences
}
end
|
#mute_member(conference_name, member_id) ⇒ Object
273
274
275
276
277
|
# File 'lib/plivo/resources/conferences.rb', line 273
def mute_member(conference_name, member_id)
valid_param?(:conference_name, conference_name, [String, Symbol], true)
Conference.new(@_client, resource_id: conference_name)
.mute_member(member_id)
end
|
#play_member(conference_name, member_id, url) ⇒ Object
289
290
291
292
293
|
# File 'lib/plivo/resources/conferences.rb', line 289
def play_member(conference_name, member_id, url)
valid_param?(:conference_name, conference_name, [String, Symbol], true)
Conference.new(@_client, resource_id: conference_name)
.play_member(member_id, url)
end
|
#record(conference_name, options = nil) ⇒ Object
357
358
359
360
361
|
# File 'lib/plivo/resources/conferences.rb', line 357
def record(conference_name, options = nil)
valid_param?(:conference_name, conference_name, [String, Symbol], true)
Conference.new(@_client, resource_id: conference_name)
.record(options)
end
|
#speak_member(conference_name, member_id, text, options = nil) ⇒ Object
309
310
311
312
313
|
# File 'lib/plivo/resources/conferences.rb', line 309
def speak_member(conference_name, member_id, text, options = nil)
valid_param?(:conference_name, conference_name, [String, Symbol], true)
Conference.new(@_client, resource_id: conference_name)
.speak_member(member_id, text, options)
end
|
#stop_play_member(conference_name, member_id) ⇒ Object
297
298
299
300
301
|
# File 'lib/plivo/resources/conferences.rb', line 297
def stop_play_member(conference_name, member_id)
valid_param?(:conference_name, conference_name, [String, Symbol], true)
Conference.new(@_client, resource_id: conference_name)
.stop_play_member(member_id)
end
|
#stop_record(conference_name) ⇒ Object
364
365
366
367
368
|
# File 'lib/plivo/resources/conferences.rb', line 364
def stop_record(conference_name)
valid_param?(:conference_name, conference_name, [String, Symbol], true)
Conference.new(@_client, resource_id: conference_name)
.stop_record
end
|
#stop_speak_member(conference_name, member_id) ⇒ Object
317
318
319
320
321
|
# File 'lib/plivo/resources/conferences.rb', line 317
def stop_speak_member(conference_name, member_id)
valid_param?(:conference_name, conference_name, [String, Symbol], true)
Conference.new(@_client, resource_id: conference_name)
.stop_speak_member(member_id)
end
|
#undeaf_member(conference_name, member_id) ⇒ Object
333
334
335
336
337
|
# File 'lib/plivo/resources/conferences.rb', line 333
def undeaf_member(conference_name, member_id)
valid_param?(:conference_name, conference_name, [String, Symbol], true)
Conference.new(@_client, resource_id: conference_name)
.undeaf_member(member_id)
end
|
#unmute_member(conference_name, member_id) ⇒ Object
281
282
283
284
285
|
# File 'lib/plivo/resources/conferences.rb', line 281
def unmute_member(conference_name, member_id)
valid_param?(:conference_name, conference_name, [String, Symbol], true)
Conference.new(@_client, resource_id: conference_name)
.unmute_member(member_id)
end
|