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

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

  • account_sid (String) —

    The SID of the Account that created this SubscribedTrack resource.

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

    The SID of the Call resource to fetch.



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant/subscribed_track.rb', line 215

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  || @properties['room_sid']  ,'participant_sid' => participant_sid  || @properties['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:



241
242
243
244
245
246
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant/subscribed_track.rb', line 241

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 and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



280
281
282
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant/subscribed_track.rb', line 280

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:



286
287
288
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant/subscribed_track.rb', line 286

def date_updated
    @properties['date_updated']
end

#enabled ⇒ Boolean

Returns Whether the track is enabled.

Returns:

  • (Boolean) —

    Whether the track is enabled.



292
293
294
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant/subscribed_track.rb', line 292

def enabled
    @properties['enabled']
end

#fetch ⇒ SubscribedTrackInstance

Fetch the SubscribedTrackInstance

Returns:



311
312
313
314
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant/subscribed_track.rb', line 311

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#kind ⇒ Kind

Returns:

  • (Kind) 


298
299
300
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant/subscribed_track.rb', line 298

def kind
    @properties['kind']
end

#name ⇒ String

Returns The track name. Must have no more than 128 characters and be unique among the participant’s published tracks.

Returns:

  • (String) —

    The track name. Must have no more than 128 characters and be unique among the participant’s published tracks.



274
275
276
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant/subscribed_track.rb', line 274

def name
    @properties['name']
end

#participant_sid ⇒ String

Returns The SID of the participant that subscribes to the track.

Returns:

  • (String) —

    The SID of the participant that subscribes to the track.



256
257
258
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant/subscribed_track.rb', line 256

def participant_sid
    @properties['participant_sid']
end

#publisher_sid ⇒ String

Returns The SID of the participant that publishes the track.

Returns:

  • (String) —

    The SID of the participant that publishes the track.



262
263
264
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant/subscribed_track.rb', line 262

def publisher_sid
    @properties['publisher_sid']
end

#room_sid ⇒ String

Returns The SID of the room where the track is published.

Returns:

  • (String) —

    The SID of the room where the track is published.



268
269
270
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant/subscribed_track.rb', line 268

def room_sid
    @properties['room_sid']
end

#sid ⇒ String

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

Returns:

  • (String) —

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



250
251
252
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant/subscribed_track.rb', line 250

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



318
319
320
321
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant/subscribed_track.rb', line 318

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

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



304
305
306
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant/subscribed_track.rb', line 304

def url
    @properties['url']
end