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 room_sid

  • participant_sid (String) (defaults to: nil)

    The participant_sid

  • sid (String) (defaults to: nil)

    The sid



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_published_track.rb', line 205

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

#contextPublishedTrackContext

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

Returns:



234
235
236
237
238
239
240
241
242
243
244
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_published_track.rb', line 234

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

#date_createdTime

Returns The date_created.

Returns:

  • (Time)

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The date_updated.

Returns:

  • (Time)

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#enabledBoolean

Returns The enabled.

Returns:

  • (Boolean)

    The enabled



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

def enabled
  @properties['enabled']
end

#fetchPublishedTrackInstance

Fetch a PublishedTrackInstance

Returns:



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

def fetch
  context.fetch
end

#inspectObject

Provide a detailed, 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 inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Video.V1.PublishedTrackInstance #{values}>"
end

#kindpublished_track.Kind

Returns The kind.

Returns:

  • (published_track.Kind)

    The kind



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

def kind
  @properties['kind']
end

#nameString

Returns The name.

Returns:

  • (String)

    The name



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

def name
  @properties['name']
end

#participant_sidString

Returns The participant_sid.

Returns:

  • (String)

    The participant_sid



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

def participant_sid
  @properties['participant_sid']
end

#room_sidString

Returns The room_sid.

Returns:

  • (String)

    The room_sid



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

def room_sid
  @properties['room_sid']
end

#sidString

Returns The sid.

Returns:

  • (String)

    The sid



248
249
250
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_published_track.rb', line 248

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation



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

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

#urlString

Returns The url.

Returns:

  • (String)

    The url



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

def url
  @properties['url']
end