Class: Twilio::REST::Video::V1::RoomContext::ParticipantInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/video/v1/room/participant.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, room_sid: nil, sid: nil) ⇒ ParticipantInstance

Initialize the ParticipantInstance



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 337

def initialize(version, payload , room_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'room_sid' => payload['room_sid'],
        'account_sid' => payload['account_sid'],
        'status' => payload['status'],
        'identity' => payload['identity'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'start_time' => Twilio.deserialize_iso8601_datetime(payload['start_time']),
        'end_time' => Twilio.deserialize_iso8601_datetime(payload['end_time']),
        'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
        'url' => payload['url'],
        'links' => payload['links'],
    }

    # Context
    @instance_context = nil
    @params = { 'room_sid' => room_sid  || @properties['room_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String 



386
387
388
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 386

def 
    @properties['account_sid']
end

#anonymize ⇒ anonymize

Access the anonymize



482
483
484
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 482

def anonymize
    context.anonymize
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



365
366
367
368
369
370
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 365

def context
    unless @instance_context
        @instance_context = ParticipantContext.new(@version , @params['room_sid'], @params['sid'])
    end
    @instance_context
end

#date_created ⇒ Time 



404
405
406
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 404

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



410
411
412
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 410

def date_updated
    @properties['date_updated']
end

#duration ⇒ String 



428
429
430
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 428

def duration
    @properties['duration']
end

#end_time ⇒ Time 



422
423
424
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 422

def end_time
    @properties['end_time']
end

#fetch ⇒ ParticipantInstance

Fetch the ParticipantInstance



447
448
449
450
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 447

def fetch

    context.fetch
end

#identity ⇒ String 



398
399
400
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 398

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



502
503
504
505
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 502

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

#links ⇒ Hash 



440
441
442
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 440

def links
    @properties['links']
end

#published_tracks ⇒ published_tracks

Access the published_tracks



489
490
491
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 489

def published_tracks
    context.published_tracks
end

#room_sid ⇒ String 



380
381
382
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 380

def room_sid
    @properties['room_sid']
end

#sid ⇒ String 



374
375
376
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 374

def sid
    @properties['sid']
end

#start_time ⇒ Time 



416
417
418
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 416

def start_time
    @properties['start_time']
end

#status ⇒ Status 



392
393
394
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 392

def status
    @properties['status']
end

#subscribe_rules ⇒ subscribe_rules

Access the subscribe_rules



468
469
470
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 468

def subscribe_rules
    context.subscribe_rules
end

#subscribed_tracks ⇒ subscribed_tracks

Access the subscribed_tracks



475
476
477
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 475

def subscribed_tracks
    context.subscribed_tracks
end

#to_s ⇒ Object

Provide a user friendly representation



495
496
497
498
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 495

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Video.V1.ParticipantInstance #{values}>"
end

#update(status: :unset) ⇒ ParticipantInstance

Update the ParticipantInstance



456
457
458
459
460
461
462
463
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 456

def update(
    status: :unset
)

    context.update(
        status: status, 
    )
end

#url ⇒ String 



434
435
436
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 434

def url
    @properties['url']
end