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

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/video/v1/room/participant.rb,
lib/twilio-ruby/rest/video/v1/room/participant/anonymize.rb,
lib/twilio-ruby/rest/video/v1/room/participant/published_track.rb,
lib/twilio-ruby/rest/video/v1/room/participant/subscribe_rules.rb,
lib/twilio-ruby/rest/video/v1/room/participant/subscribed_track.rb

Defined Under Namespace

Classes: AnonymizeContext, AnonymizeInstance, AnonymizeInstanceMetadata, AnonymizeList, AnonymizeListResponse, AnonymizePage, AnonymizePageMetadata, PublishedTrackContext, PublishedTrackInstance, PublishedTrackInstanceMetadata, PublishedTrackList, PublishedTrackListResponse, PublishedTrackPage, PublishedTrackPageMetadata, SubscribeRulesInstance, SubscribeRulesList, SubscribeRulesListResponse, SubscribeRulesPage, SubscribeRulesPageMetadata, SubscribedTrackContext, SubscribedTrackInstance, SubscribedTrackInstanceMetadata, SubscribedTrackList, SubscribedTrackListResponse, SubscribedTrackPage, SubscribedTrackPageMetadata

Instance Method Summary collapse

Constructor Details

#initialize(version, room_sid, sid) ⇒ ParticipantContext

Initialize the ParticipantContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • room_sid (String) —

    The SID of the room with the participant to update.

  • sid (String) —

    The SID of the RoomParticipant resource to update.



194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 194

def initialize(version, room_sid, sid)
    super(version)
    

    # Path Solution
    @solution = { room_sid: room_sid, sid: sid,  }
    @uri = "/Rooms/#{@solution[:room_sid]}/Participants/#{@solution[:sid]}"

    # Dependents
    @subscribe_rules = nil
    @subscribed_tracks = nil
    @anonymize = nil
    @published_tracks = nil
end

Instance Method Details

#anonymize ⇒ AnonymizeList, AnonymizeContext

Access the anonymize

Returns:



348
349
350
351
352
353
354
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 348

def anonymize
    AnonymizeContext.new(
            @version,
            @solution[:room_sid],
            @solution[:sid]
            )
end

#fetch ⇒ ParticipantInstance

Fetch the ParticipantInstance

Returns:



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 211

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    ParticipantInstance.new(
        @version,
        payload,
        room_sid: @solution[:room_sid],
        sid: @solution[:sid],
    )
end

#fetch_with_metadata ⇒ ParticipantInstance

Fetch the ParticipantInstanceMetadata

Returns:



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 231

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    participant_instance = ParticipantInstance.new(
        @version,
        response.body,
        room_sid: @solution[:room_sid],
        sid: @solution[:sid],
    )
    ParticipantInstanceMetadata.new(
        @version,
        participant_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



384
385
386
387
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 384

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Video.V1.ParticipantContext #{context}>"
end

#published_tracks(sid = :unset) ⇒ PublishedTrackList, PublishedTrackContext

Access the published_tracks

Returns:

Raises:

  • (ArgumentError) 


359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 359

def published_tracks(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

    if sid != :unset
        return PublishedTrackContext.new(@version, @solution[:room_sid], @solution[:sid],sid )
    end

    unless @published_tracks
        @published_tracks = PublishedTrackList.new(
            @version, room_sid: @solution[:room_sid], participant_sid: @solution[:sid], )
    end

 @published_tracks
end

#subscribe_rules ⇒ SubscribeRulesList, SubscribeRulesContext

Access the subscribe_rules

Returns:



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

def subscribe_rules
  unless @subscribe_rules
    @subscribe_rules = SubscribeRulesList.new(
            @version, room_sid: @solution[:room_sid], participant_sid: @solution[:sid], )
  end
  @subscribe_rules
end

#subscribed_tracks(sid = :unset) ⇒ SubscribedTrackList, SubscribedTrackContext

Access the subscribed_tracks

Returns:

Raises:

  • (ArgumentError) 


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 329

def subscribed_tracks(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

    if sid != :unset
        return SubscribedTrackContext.new(@version, @solution[:room_sid], @solution[:sid],sid )
    end

    unless @subscribed_tracks
        @subscribed_tracks = SubscribedTrackList.new(
            @version, room_sid: @solution[:room_sid], participant_sid: @solution[:sid], )
    end

 @subscribed_tracks
end

#to_s ⇒ Object

Provide a user friendly representation



377
378
379
380
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 377

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Video.V1.ParticipantContext #{context}>"
end

#update(status: :unset) ⇒ ParticipantInstance

Update the ParticipantInstance

Parameters:

  • status (Status) (defaults to: :unset)

Returns:



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 258

def update(
    status: :unset
)

    data = Twilio::Values.of({
        'Status' => status,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    ParticipantInstance.new(
        @version,
        payload,
        room_sid: @solution[:room_sid],
        sid: @solution[:sid],
    )
end

#update_with_metadata(status: :unset) ⇒ ParticipantInstance

Update the ParticipantInstanceMetadata

Parameters:

  • status (Status) (defaults to: :unset)

Returns:



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 285

def update_with_metadata(
  status: :unset
)

    data = Twilio::Values.of({
        'Status' => status,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
    participant_instance = ParticipantInstance.new(
        @version,
        response.body,
        room_sid: @solution[:room_sid],
        sid: @solution[:sid],
    )
    ParticipantInstanceMetadata.new(
        @version,
        participant_instance,
        response.headers,
        response.status_code
    )
end