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) —

    Unique Room identifier where this Track is published.

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

    Unique Participant identifier that publishes this Track.

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

    A 34 character string that uniquely identifies this resource.



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

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:



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

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 date that this resource was created.

Returns:

  • (Time) —

    The date that this resource was created.



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

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.



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

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.



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

def enabled
  @properties['enabled']
end

#fetch ⇒ PublishedTrackInstance

Fetch a PublishedTrackInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#kind ⇒ published_track.Kind

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

Returns:

  • (published_track.Kind) —

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



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

def kind
  @properties['kind']
end

#name ⇒ String

Returns Track name. Limited to 128 characters.

Returns:

  • (String) —

    Track name. Limited to 128 characters.



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

def name
  @properties['name']
end

#participant_sid ⇒ String

Returns Unique Participant identifier that publishes this Track.

Returns:

  • (String) —

    Unique Participant identifier that publishes this Track.



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

def participant_sid
  @properties['participant_sid']
end

#room_sid ⇒ String

Returns Unique Room identifier where this Track is published.

Returns:

  • (String) —

    Unique Room identifier where this Track is published.



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

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.



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#url ⇒ String

Returns The absolute URL for this resource.

Returns:

  • (String) —

    The absolute URL for this resource.



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

def url
  @properties['url']
end