Class: Twilio::REST::Insights::V1::RoomContext

Inherits:
Twilio::REST::InstanceContext show all
Defined in:
lib/twilio-ruby/rest/insights/v1/room.rb,
lib/twilio-ruby/rest/insights/v1/room/participant.rb

Defined Under Namespace

Classes: ParticipantContext, ParticipantInstance, ParticipantInstanceMetadata, ParticipantList, ParticipantListResponse, ParticipantPage, ParticipantPageMetadata

Instance Method Summary collapse

Constructor Details

#initialize(version, room_sid) ⇒ RoomContext

Initialize the RoomContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • room_sid (String) —

    The SID of the Room resource.



211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 211

def initialize(version, room_sid)
    super(version)
    

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

    # Dependents
    @participants = nil
end

Instance Method Details

#fetch ⇒ RoomInstance

Fetch the RoomInstance

Returns:



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 225

def fetch

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

#fetch_with_metadata ⇒ RoomInstance

Fetch the RoomInstanceMetadata

Returns:



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 244

def fetch_with_metadata

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



295
296
297
298
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 295

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

#participants(participant_sid = :unset) ⇒ ParticipantList, ParticipantContext

Access the participants

Returns:

Raises:

  • (ArgumentError) 


270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 270

def participants(participant_sid=:unset)

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

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

    unless @participants
        @participants = ParticipantList.new(
            @version, room_sid: @solution[:room_sid], )
    end

 @participants
end

#to_s ⇒ Object

Provide a user friendly representation



288
289
290
291
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 288

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