Class: Twilio::REST::Api::V2010::AccountContext::ConferenceContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/conference.rb,
lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb,
lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb

Defined Under Namespace

Classes: ParticipantContext, ParticipantInstance, ParticipantList, ParticipantPage, RecordingContext, RecordingInstance, RecordingList, RecordingPage

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid, sid) ⇒ ConferenceContext

Initialize the ConferenceContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • account_sid (String) —

    The SID of the [Account](www.twilio.com/docs/api/rest/account) that created the Conference resource(s) to fetch.

  • sid (String) —

    The Twilio-provided string that uniquely identifies the Conference resource to fetch



217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 217

def initialize(version, , sid)
  super(version)

  # Path Solution
  @solution = {account_sid: , sid: sid, }
  @uri = "/Accounts/#{@solution[:account_sid]}/Conferences/#{@solution[:sid]}.json"

  # Dependents
  @participants = nil
  @recordings = nil
end

Instance Method Details

#fetch ⇒ ConferenceInstance

Fetch a ConferenceInstance

Returns:



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 232

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  ConferenceInstance.new(
      @version,
      payload,
      account_sid: @solution[:account_sid],
      sid: @solution[:sid],
  )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



334
335
336
337
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 334

def inspect
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Api.V2010.ConferenceContext #{context}>"
end

#participants(call_sid = :unset) ⇒ ParticipantList, ParticipantContext

Access the participants

Returns:

Raises:

  • (ArgumentError) 


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 285

def participants(call_sid=:unset)
  raise ArgumentError, 'call_sid cannot be nil' if call_sid.nil?

  if call_sid != :unset
    return ParticipantContext.new(@version, @solution[:account_sid], @solution[:sid], call_sid, )
  end

  unless @participants
    @participants = ParticipantList.new(
        @version,
        account_sid: @solution[:account_sid],
        conference_sid: @solution[:sid],
    )
  end

  @participants
end

#recordings(sid = :unset) ⇒ RecordingList, RecordingContext

Access the recordings

Returns:

Raises:

  • (ArgumentError) 


307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 307

def recordings(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return RecordingContext.new(@version, @solution[:account_sid], @solution[:sid], sid, )
  end

  unless @recordings
    @recordings = RecordingList.new(
        @version,
        account_sid: @solution[:account_sid],
        conference_sid: @solution[:sid],
    )
  end

  @recordings
end

#to_s ⇒ Object

Provide a user friendly representation



327
328
329
330
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 327

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Api.V2010.ConferenceContext #{context}>"
end

#update(status: :unset, announce_url: :unset, announce_method: :unset) ⇒ ConferenceInstance

Update the ConferenceInstance

Parameters:

  • status (conference.UpdateStatus) (defaults to: :unset) —

    The new status of the resource. Can be: Can be: ‘init`, `in-progress`, or `completed`. Specifying `completed` will end the conference and hang up all participants

  • announce_url (String) (defaults to: :unset) —

    The URL we should call to announce something into the conference. The URL can return an MP3, a WAV, or a TwiML document with ‘<Play>` or `<Say>`.

  • announce_method (String) (defaults to: :unset) —

    The HTTP method used to call ‘announce_url`. Can be: `GET` or `POST` and the default is `POST`

Returns:



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 260

def update(status: :unset, announce_url: :unset, announce_method: :unset)
  data = Twilio::Values.of({
      'Status' => status,
      'AnnounceUrl' => announce_url,
      'AnnounceMethod' => announce_method,
  })

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

  ConferenceInstance.new(
      @version,
      payload,
      account_sid: @solution[:account_sid],
      sid: @solution[:sid],
  )
end