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.



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 556

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:



594
595
596
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 594

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.



612
613
614
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 612

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.



660
661
662
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 660

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:



585
586
587
588
589
590
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 585

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 UTC that this resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



600
601
602
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 600

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

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

Returns:



606
607
608
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 606

def date_updated
    @properties['date_updated']
end

#fetch ⇒ ConferenceInstance

Fetch the ConferenceInstance

Returns:



667
668
669
670
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 667

def fetch

    context.fetch
end

#friendly_name ⇒ String

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

Returns:

  • (String) —

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



618
619
620
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 618

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



714
715
716
717
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 714

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

#participants ⇒ participants

Access the participants

Returns:



701
702
703
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 701

def participants
    context.participants
end

#reason_conference_ended ⇒ ReasonConferenceEnded

Returns:

  • (ReasonConferenceEnded) 


654
655
656
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 654

def reason_conference_ended
    @properties['reason_conference_ended']
end

#recordings ⇒ recordings

Access the recordings

Returns:



694
695
696
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 694

def recordings
    context.recordings
end

#region ⇒ String

Returns A string that represents the Twilio Region where the conference audio was mixed. May be us1, us2, 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, us2, 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.



624
625
626
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 624

def region
    @properties['region']
end

#sid ⇒ String

Returns The unique, Twilio-provided string used to identify this Conference resource.

Returns:

  • (String) —

    The unique, Twilio-provided string used to identify this Conference resource.



630
631
632
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 630

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


636
637
638
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 636

def status
    @properties['status']
end

#subresource_uris ⇒ Hash

Returns A list of related resources identified by their URIs relative to https://api.twilio.com.

Returns:

  • (Hash) —

    A list of related resources identified by their URIs relative to https://api.twilio.com.



648
649
650
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 648

def subresource_uris
    @properties['subresource_uris']
end

#to_s ⇒ Object

Provide a user friendly representation



707
708
709
710
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 707

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:



678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 678

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 https://api.twilio.com.

Returns:

  • (String) —

    The URI of this resource, relative to https://api.twilio.com.



642
643
644
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 642

def uri
    @properties['uri']
end