Class: Twilio::REST::Api::V2010::AccountContext::ConferenceContext::ParticipantInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Api::V2010::AccountContext::ConferenceContext::ParticipantInstance
- Defined in:
- lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Participant resource.
-
#call_sid ⇒ String
The SID of the [Call](www.twilio.com/docs/voice/api/call-resource) the Participant resource is associated with.
-
#call_sid_to_coach ⇒ String
The SID of the participant who is being ‘coached`.
-
#coaching ⇒ Boolean
Whether the participant is coaching another call.
-
#conference_sid ⇒ String
The SID of the conference the participant is in.
-
#context ⇒ ParticipantContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The date and time in GMT that the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#date_updated ⇒ Time
The date and time in GMT that the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#delete ⇒ Boolean
Delete the ParticipantInstance.
-
#end_conference_on_exit ⇒ Boolean
Whether the conference ends when the participant leaves.
-
#fetch ⇒ ParticipantInstance
Fetch the ParticipantInstance.
-
#hold ⇒ Boolean
Whether the participant is on hold.
-
#initialize(version, payload, account_sid: nil, conference_sid: nil, call_sid: nil) ⇒ ParticipantInstance
constructor
Initialize the ParticipantInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#label ⇒ String
The user-specified label of this participant, if one was given when the participant was created.
-
#muted ⇒ Boolean
Whether the participant is muted.
-
#start_conference_on_enter ⇒ Boolean
Whether the conference starts when the participant joins the conference, if it has not already started.
- #status ⇒ Status
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(muted: :unset, hold: :unset, hold_url: :unset, hold_method: :unset, announce_url: :unset, announce_method: :unset, wait_url: :unset, wait_method: :unset, beep_on_exit: :unset, end_conference_on_exit: :unset, coaching: :unset, call_sid_to_coach: :unset) ⇒ ParticipantInstance
Update the ParticipantInstance.
-
#uri ⇒ String
The URI of the resource, relative to ‘api.twilio.com`.
Constructor Details
#initialize(version, payload, account_sid: nil, conference_sid: nil, call_sid: nil) ⇒ ParticipantInstance
Initialize the ParticipantInstance
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 456 def initialize(version, payload , account_sid: nil, conference_sid: nil, call_sid: nil) super(version) # Marshaled Properties @properties = { 'account_sid' => payload['account_sid'], 'call_sid' => payload['call_sid'], 'label' => payload['label'], 'call_sid_to_coach' => payload['call_sid_to_coach'], 'coaching' => payload['coaching'], 'conference_sid' => payload['conference_sid'], 'date_created' => Twilio.deserialize_rfc2822(payload['date_created']), 'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']), 'end_conference_on_exit' => payload['end_conference_on_exit'], 'muted' => payload['muted'], 'hold' => payload['hold'], 'start_conference_on_enter' => payload['start_conference_on_enter'], 'status' => payload['status'], 'uri' => payload['uri'], } # Context @instance_context = nil @params = { 'account_sid' => account_sid ,'conference_sid' => conference_sid || @properties['conference_sid'] ,'call_sid' => call_sid || @properties['call_sid'] , } end |
Instance Method Details
#account_sid ⇒ String
Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Participant resource.
495 496 497 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 495 def account_sid @properties['account_sid'] end |
#call_sid ⇒ String
Returns The SID of the [Call](www.twilio.com/docs/voice/api/call-resource) the Participant resource is associated with.
501 502 503 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 501 def call_sid @properties['call_sid'] end |
#call_sid_to_coach ⇒ String
Returns The SID of the participant who is being ‘coached`. The participant being coached is the only participant who can hear the participant who is `coaching`.
513 514 515 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 513 def call_sid_to_coach @properties['call_sid_to_coach'] end |
#coaching ⇒ Boolean
Returns Whether the participant is coaching another call. Can be: ‘true` or `false`. If not present, defaults to `false` unless `call_sid_to_coach` is defined. If `true`, `call_sid_to_coach` must be defined.
519 520 521 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 519 def coaching @properties['coaching'] end |
#conference_sid ⇒ String
Returns The SID of the conference the participant is in.
525 526 527 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 525 def conference_sid @properties['conference_sid'] end |
#context ⇒ ParticipantContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
486 487 488 489 490 491 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 486 def context unless @instance_context @instance_context = ParticipantContext.new(@version , @params['account_sid'], @params['conference_sid'], @params['call_sid']) end @instance_context end |
#date_created ⇒ Time
Returns The date and time in GMT that the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
531 532 533 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 531 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The date and time in GMT that the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
537 538 539 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 537 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the ParticipantInstance
580 581 582 583 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 580 def delete context.delete end |
#end_conference_on_exit ⇒ Boolean
Returns Whether the conference ends when the participant leaves. Can be: ‘true` or `false` and the default is `false`. If `true`, the conference ends and all other participants drop out when the participant leaves.
543 544 545 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 543 def end_conference_on_exit @properties['end_conference_on_exit'] end |
#fetch ⇒ ParticipantInstance
Fetch the ParticipantInstance
588 589 590 591 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 588 def fetch context.fetch end |
#hold ⇒ Boolean
Returns Whether the participant is on hold. Can be ‘true` or `false`.
555 556 557 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 555 def hold @properties['hold'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
648 649 650 651 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 648 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Api.V2010.ParticipantInstance #{values}>" end |
#label ⇒ String
Returns The user-specified label of this participant, if one was given when the participant was created. This may be used to fetch, update or delete the participant.
507 508 509 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 507 def label @properties['label'] end |
#muted ⇒ Boolean
Returns Whether the participant is muted. Can be ‘true` or `false`.
549 550 551 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 549 def muted @properties['muted'] end |
#start_conference_on_enter ⇒ Boolean
Returns Whether the conference starts when the participant joins the conference, if it has not already started. Can be: ‘true` or `false` and the default is `true`. If `false` and the conference has not started, the participant is muted and hears background music until another participant starts the conference.
561 562 563 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 561 def start_conference_on_enter @properties['start_conference_on_enter'] end |
#status ⇒ Status
567 568 569 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 567 def status @properties['status'] end |
#to_s ⇒ Object
Provide a user friendly representation
641 642 643 644 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 641 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Api.V2010.ParticipantInstance #{values}>" end |
#update(muted: :unset, hold: :unset, hold_url: :unset, hold_method: :unset, announce_url: :unset, announce_method: :unset, wait_url: :unset, wait_method: :unset, beep_on_exit: :unset, end_conference_on_exit: :unset, coaching: :unset, call_sid_to_coach: :unset) ⇒ ParticipantInstance
Update the ParticipantInstance
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 608 def update( muted: :unset, hold: :unset, hold_url: :unset, hold_method: :unset, announce_url: :unset, announce_method: :unset, wait_url: :unset, wait_method: :unset, beep_on_exit: :unset, end_conference_on_exit: :unset, coaching: :unset, call_sid_to_coach: :unset ) context.update( muted: muted, hold: hold, hold_url: hold_url, hold_method: hold_method, announce_url: announce_url, announce_method: announce_method, wait_url: wait_url, wait_method: wait_method, beep_on_exit: beep_on_exit, end_conference_on_exit: end_conference_on_exit, coaching: coaching, call_sid_to_coach: call_sid_to_coach, ) end |
#uri ⇒ String
Returns The URI of the resource, relative to ‘api.twilio.com`.
573 574 575 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 573 def uri @properties['uri'] end |