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



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 360

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'],
      '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,
      'call_sid' => call_sid || @properties['call_sid'],
  }
end

Instance Method Details

#account_sid ⇒ String 



405
406
407
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 405

def 
  @properties['account_sid']
end

#call_sid ⇒ String 



411
412
413
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 411

def call_sid
  @properties['call_sid']
end

#conference_sid ⇒ String 



417
418
419
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 417

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



391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 391

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 



423
424
425
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 423

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



429
430
431
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 429

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the ParticipantInstance



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

def delete
  context.delete
end

#end_conference_on_exit ⇒ Boolean 



435
436
437
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 435

def end_conference_on_exit
  @properties['end_conference_on_exit']
end

#fetch ⇒ ParticipantInstance

Fetch a ParticipantInstance



472
473
474
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 472

def fetch
  context.fetch
end

#hold ⇒ Boolean 



447
448
449
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 447

def hold
  @properties['hold']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#muted ⇒ Boolean 



441
442
443
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 441

def muted
  @properties['muted']
end

#start_conference_on_enter ⇒ Boolean 



453
454
455
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 453

def start_conference_on_enter
  @properties['start_conference_on_enter']
end

#status ⇒ participant.Status 



459
460
461
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 459

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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) ⇒ ParticipantInstance

Update the ParticipantInstance



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

def update(muted: :unset, hold: :unset, hold_url: :unset, hold_method: :unset, announce_url: :unset, announce_method: :unset)
  context.update(
      muted: muted,
      hold: hold,
      hold_url: hold_url,
      hold_method: hold_method,
      announce_url: announce_url,
      announce_method: announce_method,
  )
end

#uri ⇒ String 



465
466
467
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 465

def uri
  @properties['uri']
end