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



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

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 



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

def 
    @properties['account_sid']
end

#call_sid ⇒ String 



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

def call_sid
    @properties['call_sid']
end

#call_sid_to_coach ⇒ String 



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

def call_sid_to_coach
    @properties['call_sid_to_coach']
end

#coaching ⇒ Boolean 



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

def coaching
    @properties['coaching']
end

#conference_sid ⇒ String 



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

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



493
494
495
496
497
498
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 493

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 



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ParticipantInstance



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

def delete

    context.delete
end

#end_conference_on_exit ⇒ Boolean 



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

def end_conference_on_exit
    @properties['end_conference_on_exit']
end

#fetch ⇒ ParticipantInstance

Fetch the ParticipantInstance



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

def fetch

    context.fetch
end

#hold ⇒ Boolean 



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

def hold
    @properties['hold']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#label ⇒ String 



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

def label
    @properties['label']
end

#muted ⇒ Boolean 



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

def muted
    @properties['muted']
end

#start_conference_on_enter ⇒ Boolean 



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

def start_conference_on_enter
    @properties['start_conference_on_enter']
end

#status ⇒ Status 



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

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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
641
642
643
644
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 615

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 



580
581
582
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 580

def uri
    @properties['uri']
end