Class: Twilio::REST::Insights::V1::RoomContext::ParticipantInstance

Inherits:
Twilio::REST::InstanceResource show all
Defined in:
lib/twilio-ruby/rest/insights/v1/room/participant.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, room_sid: nil, participant_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) —

    The SID of the Account that created this Participant resource.

  • sid (String) —

    The SID of the Call resource to fetch.



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 380

def initialize(version, payload , room_sid: nil, participant_sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'participant_sid' => payload['participant_sid'],
        'participant_identity' => payload['participant_identity'],
        'join_time' => Twilio.deserialize_iso8601_datetime(payload['join_time']),
        'leave_time' => Twilio.deserialize_iso8601_datetime(payload['leave_time']),
        'duration_sec' => payload['duration_sec'],
        'account_sid' => payload['account_sid'],
        'room_sid' => payload['room_sid'],
        'status' => payload['status'],
        'codecs' => payload['codecs'],
        'end_reason' => payload['end_reason'],
        'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i,
        'error_code_url' => payload['error_code_url'],
        'media_region' => payload['media_region'],
        'properties' => payload['properties'],
        'edge_location' => payload['edge_location'],
        'publisher_info' => payload['publisher_info'],
        'url' => payload['url'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns Account SID associated with the room.

Returns:

  • (String) —

    Account SID associated with the room.



453
454
455
 
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 453

def 
    @properties['account_sid']
end

#codecs ⇒ Array<Codec>

Returns Codecs detected from the participant. Can be VP8, H264, or VP9.

Returns:

  • (Array<Codec>) —

    Codecs detected from the participant. Can be VP8, H264, or VP9.



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

def codecs
    @properties['codecs']
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:



414
415
416
417
418
419
 
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 414

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

#duration_sec ⇒ String

Returns Amount of time in seconds the participant was in the room.

Returns:

  • (String) —

    Amount of time in seconds the participant was in the room.



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

def duration_sec
    @properties['duration_sec']
end

#edge_location ⇒ EdgeLocation

Returns:

  • (EdgeLocation) 


507
508
509
 
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 507

def edge_location
    @properties['edge_location']
end

#end_reason ⇒ String

Returns Reason the participant left the room. See [the list of possible values here](www.twilio.com/docs/video/troubleshooting/video-log-analyzer-api#end_reason).

Returns:



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

def end_reason
    @properties['end_reason']
end

#error_code ⇒ String

Returns Errors encountered by the participant.

Returns:

  • (String) —

    Errors encountered by the participant.



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

def error_code
    @properties['error_code']
end

#error_code_url ⇒ String

Returns Twilio error code dictionary link.

Returns:

  • (String) —

    Twilio error code dictionary link.



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

def error_code_url
    @properties['error_code_url']
end

#fetch ⇒ ParticipantInstance

Fetch the ParticipantInstance

Returns:



526
527
528
529
 
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 526

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



540
541
542
543
 
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 540

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

#join_time ⇒ Time

Returns When the participant joined the room.

Returns:

  • (Time) —

    When the participant joined the room.



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

def join_time
    @properties['join_time']
end

#leave_time ⇒ Time

Returns When the participant left the room.

Returns:

  • (Time) —

    When the participant left the room.



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

def leave_time
    @properties['leave_time']
end

#media_region ⇒ TwilioRealm

Returns:

  • (TwilioRealm) 


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

def media_region
    @properties['media_region']
end

#participant_identity ⇒ String

Returns The application-defined string that uniquely identifies the participant within a Room.

Returns:

  • (String) —

    The application-defined string that uniquely identifies the participant within a Room.



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

def participant_identity
    @properties['participant_identity']
end

#participant_sid ⇒ String

Returns Unique identifier for the participant.

Returns:

  • (String) —

    Unique identifier for the participant.



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

def participant_sid
    @properties['participant_sid']
end

#properties ⇒ Hash

Returns Object containing information about the participant’s data from the room. See [below](www.twilio.com/docs/video/troubleshooting/video-log-analyzer-api#properties) for more information.

Returns:



501
502
503
 
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 501

def properties
    @properties['properties']
end

#publisher_info ⇒ Hash

Returns Object containing information about the SDK name and version. See [below](www.twilio.com/docs/video/troubleshooting/video-log-analyzer-api#publisher_info) for more information.

Returns:



513
514
515
 
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 513

def publisher_info
    @properties['publisher_info']
end

#room_sid ⇒ String

Returns Unique identifier for the room.

Returns:

  • (String) —

    Unique identifier for the room.



459
460
461
 
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 459

def room_sid
    @properties['room_sid']
end

#status ⇒ RoomStatus

Returns:

  • (RoomStatus) 


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

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



533
534
535
536
 
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 533

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

#url ⇒ String

Returns URL of the participant resource.

Returns:

  • (String) —

    URL of the participant resource.



519
520
521
 
# File 'lib/twilio-ruby/rest/insights/v1/room/participant.rb', line 519

def url
    @properties['url']
end