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

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) (defaults to: nil) —

    The SID of the Call resource to fetch.



536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 536

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

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the RoomParticipant resource.

Returns:



586
587
588
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 586

def 
    @properties['account_sid']
end

#anonymize ⇒ anonymize

Access the anonymize

Returns:



682
683
684
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 682

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

Returns:



565
566
567
568
569
570
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 565

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

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



604
605
606
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 604

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



610
611
612
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 610

def date_updated
    @properties['date_updated']
end

#duration ⇒ String

Returns The duration in seconds that the participant was connected. Populated only after the participant is disconnected.

Returns:

  • (String) —

    The duration in seconds that the participant was connected. Populated only after the participant is disconnected.



628
629
630
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 628

def duration
    @properties['duration']
end

#end_time ⇒ Time

Returns The time when the participant disconnected from the room in [ISO 8601](en.wikipedia.org/wiki/ISO_8601#UTC) format.

Returns:



622
623
624
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 622

def end_time
    @properties['end_time']
end

#fetch ⇒ ParticipantInstance

Fetch the ParticipantInstance

Returns:



647
648
649
650
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 647

def fetch

    context.fetch
end

#identity ⇒ String

Returns The application-defined string that uniquely identifies the resource’s User within a Room. If a client joins with an existing Identity, the existing client is disconnected. See [access tokens](www.twilio.com/docs/video/tutorials/user-identity-access-tokens) and [limits](www.twilio.com/docs/video/programmable-video-limits) for more info.

Returns:



598
599
600
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 598

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



702
703
704
705
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 702

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

#links ⇒ Hash

Returns The URLs of related resources.

Returns:

  • (Hash) —

    The URLs of related resources.



640
641
642
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 640

def links
    @properties['links']
end

#published_tracks ⇒ published_tracks

Access the published_tracks

Returns:



689
690
691
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 689

def published_tracks
    context.published_tracks
end

#room_sid ⇒ String

Returns The SID of the participant’s room.

Returns:

  • (String) —

    The SID of the participant’s room.



580
581
582
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 580

def room_sid
    @properties['room_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the RoomParticipant resource.

Returns:

  • (String) —

    The unique string that we created to identify the RoomParticipant resource.



574
575
576
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 574

def sid
    @properties['sid']
end

#start_time ⇒ Time

Returns The time of participant connected to the room in [ISO 8601](en.wikipedia.org/wiki/ISO_8601#UTC) format.

Returns:



616
617
618
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 616

def start_time
    @properties['start_time']
end

#status ⇒ Status

Returns:

  • (Status) 


592
593
594
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 592

def status
    @properties['status']
end

#subscribe_rules ⇒ subscribe_rules

Access the subscribe_rules

Returns:



668
669
670
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 668

def subscribe_rules
    context.subscribe_rules
end

#subscribed_tracks ⇒ subscribed_tracks

Access the subscribed_tracks

Returns:



675
676
677
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 675

def subscribed_tracks
    context.subscribed_tracks
end

#to_s ⇒ Object

Provide a user friendly representation



695
696
697
698
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 695

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

#update(status: :unset) ⇒ ParticipantInstance

Update the ParticipantInstance

Parameters:

  • status (Status) (defaults to: :unset)

Returns:



656
657
658
659
660
661
662
663
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 656

def update(
    status: :unset
)

    context.update(
        status: status, 
    )
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



634
635
636
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 634

def url
    @properties['url']
end