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



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 326

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 



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

def 
    @properties['account_sid']
end

#anonymize ⇒ anonymize

Access the anonymize



471
472
473
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 471

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



354
355
356
357
358
359
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 354

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

#date_created ⇒ Time 



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
    @properties['date_updated']
end

#duration ⇒ String 



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

def duration
    @properties['duration']
end

#end_time ⇒ Time 



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

def end_time
    @properties['end_time']
end

#fetch ⇒ ParticipantInstance

Fetch the ParticipantInstance



436
437
438
439
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 436

def fetch

    context.fetch
end

#identity ⇒ String 



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

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



491
492
493
494
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 491

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

#links ⇒ Hash 



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

def links
    @properties['links']
end

#published_tracks ⇒ published_tracks

Access the published_tracks



478
479
480
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 478

def published_tracks
    context.published_tracks
end

#room_sid ⇒ String 



369
370
371
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 369

def room_sid
    @properties['room_sid']
end

#sid ⇒ String 



363
364
365
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 363

def sid
    @properties['sid']
end

#start_time ⇒ Time 



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

def start_time
    @properties['start_time']
end

#status ⇒ Status 



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

def status
    @properties['status']
end

#subscribe_rules ⇒ subscribe_rules

Access the subscribe_rules



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

def subscribe_rules
    context.subscribe_rules
end

#subscribed_tracks ⇒ subscribed_tracks

Access the subscribed_tracks



464
465
466
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 464

def subscribed_tracks
    context.subscribed_tracks
end

#to_s ⇒ Object

Provide a user friendly representation



484
485
486
487
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 484

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

#update(status: :unset) ⇒ ParticipantInstance

Update the ParticipantInstance



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

def update(
    status: :unset
)

    context.update(
        status: status, 
    )
end

#url ⇒ String 



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

def url
    @properties['url']
end