Class: Twilio::REST::Api::V2010::AccountContext::ConferenceInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Api::V2010::AccountContext::ConferenceInstance
- Defined in:
- lib/twilio-ruby/rest/api/v2010/account/conference.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created this Conference resource.
-
#api_version ⇒ String
The API version used to create this conference.
-
#call_sid_ending_conference ⇒ String
The call SID that caused the conference to end.
-
#context ⇒ ConferenceContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The date and time in UTC that this resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#date_updated ⇒ Time
The date and time in UTC that this resource was last updated, specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#fetch ⇒ ConferenceInstance
Fetch the ConferenceInstance.
-
#friendly_name ⇒ String
A string that you assigned to describe this conference room.
-
#initialize(version, payload, account_sid: nil, sid: nil) ⇒ ConferenceInstance
constructor
Initialize the ConferenceInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#participants ⇒ participants
Access the participants.
- #reason_conference_ended ⇒ ReasonConferenceEnded
-
#recordings ⇒ recordings
Access the recordings.
-
#region ⇒ String
A string that represents the Twilio Region where the conference audio was mixed.
-
#sid ⇒ String
The unique, Twilio-provided string used to identify this Conference resource.
- #status ⇒ Status
-
#subresource_uris ⇒ Hash
A list of related resources identified by their URIs relative to
https://api.twilio.com. -
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(status: :unset, announce_url: :unset, announce_method: :unset) ⇒ ConferenceInstance
Update the ConferenceInstance.
-
#uri ⇒ String
The URI of this resource, relative to
https://api.twilio.com.
Constructor Details
#initialize(version, payload, account_sid: nil, sid: nil) ⇒ ConferenceInstance
Initialize the ConferenceInstance
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' => account_sid ,'sid' => sid || @properties['sid'] , } end |
Instance Method Details
#account_sid ⇒ String
594 595 596 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 594 def account_sid @properties['account_sid'] end |
#api_version ⇒ String
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
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
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
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
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
667 668 669 670 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 667 def fetch context.fetch end |
#friendly_name ⇒ String
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
701 702 703 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 701 def participants context.participants end |
#reason_conference_ended ⇒ 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
694 695 696 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 694 def recordings context.recordings end |
#region ⇒ String
624 625 626 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 624 def region @properties['region'] end |
#sid ⇒ String
630 631 632 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 630 def sid @properties['sid'] end |
#status ⇒ Status
636 637 638 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 636 def status @properties['status'] end |
#subresource_uris ⇒ Hash
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
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
642 643 644 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 642 def uri @properties['uri'] end |