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

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/video/v1/room/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

  • room_sid (String) (defaults to: nil) —

    The room_sid

  • sid (String) (defaults to: nil) —

    The sid



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant.rb', line 277

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

Instance Method Details

#account_sid ⇒ String

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



326
327
328
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant.rb', line 326

def 
  @properties['account_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

Returns:



305
306
307
308
309
310
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant.rb', line 305

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_created.

Returns:

  • (Time) —

    The date_created



344
345
346
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant.rb', line 344

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



350
351
352
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant.rb', line 350

def date_updated
  @properties['date_updated']
end

#duration ⇒ String

Returns The duration.

Returns:

  • (String) —

    The duration



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

def duration
  @properties['duration']
end

#end_time ⇒ Time

Returns The end_time.

Returns:

  • (Time) —

    The end_time



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

def end_time
  @properties['end_time']
end

#fetch ⇒ ParticipantInstance

Fetch a ParticipantInstance

Returns:



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

def fetch
  context.fetch
end

#identity ⇒ String

Returns The identity.

Returns:

  • (String) —

    The identity



338
339
340
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant.rb', line 338

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



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

def links
  @properties['links']
end

#published_tracks ⇒ published_tracks

Access the published_tracks

Returns:



402
403
404
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant.rb', line 402

def published_tracks
  context.published_tracks
end

#room_sid ⇒ String

Returns The room_sid.

Returns:

  • (String) —

    The room_sid



320
321
322
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant.rb', line 320

def room_sid
  @properties['room_sid']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



314
315
316
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant.rb', line 314

def sid
  @properties['sid']
end

#start_time ⇒ Time

Returns The start_time.

Returns:

  • (Time) —

    The start_time



356
357
358
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant.rb', line 356

def start_time
  @properties['start_time']
end

#status ⇒ participant.Status

Returns The status.

Returns:

  • (participant.Status) —

    The status



332
333
334
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant.rb', line 332

def status
  @properties['status']
end

#subscribed_tracks ⇒ subscribed_tracks

Access the subscribed_tracks

Returns:



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

def subscribed_tracks
  context.subscribed_tracks
end

#to_s ⇒ Object

Provide a user friendly representation



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

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 (participant.Status) (defaults to: :unset) —

    The status

Returns:



395
396
397
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant.rb', line 395

def update(status: :unset)
  context.update(status: status, )
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end