Class: Twilio::REST::Api::V2010::AccountContext::ConferenceInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, sid: nil) ⇒ ConferenceInstance

Initialize the ConferenceInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) (defaults to: nil) —

    The SID of the Account that created this Conference resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 330

def initialize(version, payload , account_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
        'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
        'api_version' => payload['api_version'],
        'friendly_name' => payload['friendly_name'],
        'region' => payload['region'],
        'sid' => payload['sid'],
        'status' => payload['status'],
        'uri' => payload['uri'],
        'subresource_uris' => payload['subresource_uris'],
        'reason_conference_ended' => payload['reason_conference_ended'],
        'call_sid_ending_conference' => payload['call_sid_ending_conference'],
    }

    # Context
    @instance_context = nil
    @params = { 'account_sid' =>   ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created this Conference resource.

Returns:



367
368
369
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 367

def 
    @properties['account_sid']
end

#api_version ⇒ String

Returns The API version used to create this conference.

Returns:

  • (String) —

    The API version used to create this conference.



385
386
387
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 385

def api_version
    @properties['api_version']
end

#call_sid_ending_conference ⇒ String

Returns The call SID that caused the conference to end.

Returns:

  • (String) —

    The call SID that caused the conference to end.



433
434
435
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 433

def call_sid_ending_conference
    @properties['call_sid_ending_conference']
end

#context ⇒ ConferenceContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



358
359
360
361
362
363
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 358

def context
    unless @instance_context
        @instance_context = ConferenceContext.new(@version , @params['account_sid'], @params['sid'])
    end
    @instance_context
end

#date_created ⇒ Time

Returns The date and time in GMT that this resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



373
374
375
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 373

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT that this resource was last updated, specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



379
380
381
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 379

def date_updated
    @properties['date_updated']
end

#fetch ⇒ ConferenceInstance

Fetch the ConferenceInstance

Returns:



440
441
442
443
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 440

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns A string that you assigned to describe this conference room. Maxiumum length is 128 characters.

Returns:

  • (String) —

    A string that you assigned to describe this conference room. Maxiumum length is 128 characters.



391
392
393
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 391

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



487
488
489
490
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 487

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Api.V2010.ConferenceInstance #{values}>"
end

#participants ⇒ participants

Access the participants

Returns:



474
475
476
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 474

def participants
    context.participants
end

#reason_conference_ended ⇒ ReasonConferenceEnded

Returns:

  • (ReasonConferenceEnded) 


427
428
429
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 427

def reason_conference_ended
    @properties['reason_conference_ended']
end

#recordings ⇒ recordings

Access the recordings

Returns:



467
468
469
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 467

def recordings
    context.recordings
end

#region ⇒ String

Returns A string that represents the Twilio Region where the conference audio was mixed. May be ‘us1`, `ie1`, `de1`, `sg1`, `br1`, `au1`, and `jp1`. Basic conference audio will always be mixed in `us1`. Global Conference audio will be mixed nearest to the majority of participants.

Returns:

  • (String) —

    A string that represents the Twilio Region where the conference audio was mixed. May be ‘us1`, `ie1`, `de1`, `sg1`, `br1`, `au1`, and `jp1`. Basic conference audio will always be mixed in `us1`. Global Conference audio will be mixed nearest to the majority of participants.



397
398
399
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 397

def region
    @properties['region']
end

#sid ⇒ String

Returns The unique string that that we created to identify this Conference resource.

Returns:

  • (String) —

    The unique string that that we created to identify this Conference resource.



403
404
405
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 403

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


409
410
411
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 409

def status
    @properties['status']
end

#subresource_uris ⇒ Hash

Returns A list of related resources identified by their URIs relative to ‘api.twilio.com`.

Returns:

  • (Hash) —

    A list of related resources identified by their URIs relative to ‘api.twilio.com`.



421
422
423
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 421

def subresource_uris
    @properties['subresource_uris']
end

#to_s ⇒ Object

Provide a user friendly representation



480
481
482
483
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 480

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Api.V2010.ConferenceInstance #{values}>"
end

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

Update the ConferenceInstance

Parameters:

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

    The URL we should call to announce something into the conference. The URL may return an MP3 file, a WAV file, or a TwiML document that contains ‘<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs.

  • 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:



451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 451

def update(
    status: :unset, 
    announce_url: :unset, 
    announce_method: :unset
)

    context.update(
        status: status, 
        announce_url: announce_url, 
        announce_method: announce_method, 
    )
end

#uri ⇒ String

Returns The URI of this resource, relative to ‘api.twilio.com`.

Returns:

  • (String) —

    The URI of this resource, relative to ‘api.twilio.com`.



415
416
417
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 415

def uri
    @properties['uri']
end