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

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

Instance Method Summary collapse

Constructor Details

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

Initialize the PublishedTrackInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The SID of the Room resource where the track is published.

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

    The SID of the Participant resource with the published track.

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

    The SID of the RoomParticipantPublishedTrack resource to fetch.


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

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'],
      '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 ⇒ PublishedTrackContext

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

Returns:


243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_published_track.rb', line 243

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

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created


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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated


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

def date_updated
  @properties['date_updated']
end

#enabled ⇒ Boolean

Returns Whether the track is enabled.

Returns:

  • (Boolean) —

    Whether the track is enabled


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

def enabled
  @properties['enabled']
end

#fetch ⇒ PublishedTrackInstance

Fetch the PublishedTrackInstance

Returns:


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

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/room_participant/room_participant_published_track.rb', line 325

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

#kind ⇒ published_track.Kind

Returns The track type.

Returns:

  • (published_track.Kind) —

    The track type


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

def kind
  @properties['kind']
end

#name ⇒ String

Returns The track name.

Returns:

  • (String) —

    The track name


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

def name
  @properties['name']
end

#participant_sid ⇒ String

Returns The SID of the Participant resource with the published track.

Returns:

  • (String) —

    The SID of the Participant resource with the published track


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

def participant_sid
  @properties['participant_sid']
end

#room_sid ⇒ String

Returns The SID of the Room resource where the track is published.

Returns:

  • (String) —

    The SID of the Room resource where the track is published


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

def room_sid
  @properties['room_sid']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource


257
258
259
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_published_track.rb', line 257

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/room_participant/room_participant_published_track.rb', line 318

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

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource


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

def url
  @properties['url']
end