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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, conference_sid: nil, call_sid: nil) ⇒ ParticipantInstance

Initialize the ParticipantInstance

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 Participant resource.

  • sid (String) —

    The SID of the Call resource to fetch.



459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 459

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' =>   ,'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.

Returns:



498
499
500
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 498

def 
    @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.

Returns:



504
505
506
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 504

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`.

Returns:

  • (String) —

    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`.



516
517
518
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 516

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.

Returns:

  • (Boolean) —

    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.



522
523
524
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 522

def coaching
    @properties['coaching']
end

#conference_sid ⇒ String

Returns The SID of the conference the participant is in.

Returns:

  • (String) —

    The SID of the conference the participant is in.



528
529
530
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 528

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

Returns:



489
490
491
492
493
494
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 489

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.

Returns:



534
535
536
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 534

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.

Returns:



540
541
542
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 540

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ParticipantInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



583
584
585
586
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 583

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.

Returns:

  • (Boolean) —

    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.



546
547
548
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 546

def end_conference_on_exit
    @properties['end_conference_on_exit']
end

#fetch ⇒ ParticipantInstance

Fetch the ParticipantInstance

Returns:



591
592
593
594
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 591

def fetch

    context.fetch
end

#hold ⇒ Boolean

Returns Whether the participant is on hold. Can be ‘true` or `false`.

Returns:

  • (Boolean) —

    Whether the participant is on hold. Can be ‘true` or `false`.



558
559
560
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 558

def hold
    @properties['hold']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



651
652
653
654
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 651

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.

Returns:

  • (String) —

    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.



510
511
512
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 510

def label
    @properties['label']
end

#muted ⇒ Boolean

Returns Whether the participant is muted. Can be ‘true` or `false`.

Returns:

  • (Boolean) —

    Whether the participant is muted. Can be ‘true` or `false`.



552
553
554
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 552

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.

Returns:

  • (Boolean) —

    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.



564
565
566
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 564

def start_conference_on_enter
    @properties['start_conference_on_enter']
end

#status ⇒ Status

Returns:

  • (Status) 


570
571
572
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 570

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



644
645
646
647
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 644

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

Parameters:

  • muted (Boolean) (defaults to: :unset) —

    Whether the participant should be muted. Can be ‘true` or `false`. `true` will mute the participant, and `false` will un-mute them. Anything value other than `true` or `false` is interpreted as `false`.

  • hold (Boolean) (defaults to: :unset) —

    Whether the participant should be on hold. Can be: ‘true` or `false`. `true` puts the participant on hold, and `false` lets them rejoin the conference.

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

    The URL we call using the ‘hold_method` for music that plays when the participant is on hold. The URL may return an MP3 file, a WAV file, or a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs.

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

    The HTTP method we should use to call ‘hold_url`. Can be: `GET` or `POST` and the default is `GET`.

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

    The URL we call using the ‘announce_method` for an announcement to the participant. 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 we should use to call ‘announce_url`. Can be: `GET` or `POST` and defaults to `POST`.

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

    The URL we call using the ‘wait_method` for the music to play while participants are waiting for the conference to start. The URL may return an MP3 file, a WAV file, or a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs. The default value is the URL of our standard hold music. [Learn more about hold music](www.twilio.com/labs/twimlets/holdmusic).

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

    The HTTP method we should use to call ‘wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file.

  • beep_on_exit (Boolean) (defaults to: :unset) —

    Whether to play a notification beep to the conference when the participant exits. Can be: ‘true` or `false`.

  • end_conference_on_exit (Boolean) (defaults to: :unset) —

    Whether to end the conference when the participant leaves. Can be: ‘true` or `false` and defaults to `false`.

  • coaching (Boolean) (defaults to: :unset) —

    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.

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

    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`.

Returns:



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
638
639
640
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 611

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`.

Returns:

  • (String) —

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



576
577
578
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 576

def uri
    @properties['uri']
end