Class: Twilio::REST::Video::V1::RoomContext::ParticipantContext::SubscribedTrackInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the SubscribedTrackInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    Unique Room identifier where this Track is published.

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

    Unique Participant identifier that subscribes to this Track.

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

    A 34 character string that uniquely identifies this resource.



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribed_track.rb', line 219

def initialize(version, payload, room_sid: nil, participant_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'participant_sid' => payload['participant_sid'],
      'publisher_sid' => payload['publisher_sid'],
      'room_sid' => payload['room_sid'],
      'name' => payload['name'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'enabled' => payload['enabled'],
      'kind' => payload['kind'],
      'url' => payload['url'],
  }

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

Instance Method Details

#context ⇒ SubscribedTrackContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribed_track.rb', line 249

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

#date_created ⇒ Time

Returns The date that this resource was created.

Returns:

  • (Time) —

    The date that this resource was created.



293
294
295
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribed_track.rb', line 293

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated.

Returns:

  • (Time) —

    The date that this resource was last updated.



299
300
301
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribed_track.rb', line 299

def date_updated
  @properties['date_updated']
end

#enabled ⇒ Boolean

Returns Specifies whether the Track is enabled or not.

Returns:

  • (Boolean) —

    Specifies whether the Track is enabled or not.



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

def enabled
  @properties['enabled']
end

#fetch ⇒ SubscribedTrackInstance

Fetch a SubscribedTrackInstance

Returns:



324
325
326
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribed_track.rb', line 324

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#kind ⇒ subscribed_track.Kind

Returns Specifies whether Track represents ‘audio`, `video` or `data`.

Returns:

  • (subscribed_track.Kind) —

    Specifies whether Track represents ‘audio`, `video` or `data`



311
312
313
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribed_track.rb', line 311

def kind
  @properties['kind']
end

#name ⇒ String

Returns Track name. Limited to 128 characters.

Returns:

  • (String) —

    Track name. Limited to 128 characters.



287
288
289
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribed_track.rb', line 287

def name
  @properties['name']
end

#participant_sid ⇒ String

Returns Unique Participant identifier that subscribes to this Track.

Returns:

  • (String) —

    Unique Participant identifier that subscribes to this Track.



269
270
271
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribed_track.rb', line 269

def participant_sid
  @properties['participant_sid']
end

#publisher_sid ⇒ String

Returns Unique Participant identifier that publishes this Track.

Returns:

  • (String) —

    Unique Participant identifier that publishes this Track.



275
276
277
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribed_track.rb', line 275

def publisher_sid
  @properties['publisher_sid']
end

#room_sid ⇒ String

Returns Unique Room identifier where this Track is published.

Returns:

  • (String) —

    Unique Room identifier where this Track is published.



281
282
283
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribed_track.rb', line 281

def room_sid
  @properties['room_sid']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



263
264
265
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribed_track.rb', line 263

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#url ⇒ String

Returns The absolute URL for this resource.

Returns:

  • (String) —

    The absolute URL for this resource.



317
318
319
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribed_track.rb', line 317

def url
  @properties['url']
end