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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Defined Under Namespace

Classes: ParticipantContext, ParticipantInstance, ParticipantList, ParticipantPage

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.



166
167
168
169
170
171
172
173
174
175
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 166

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:



179
180
181
182
183
184
185
186
187
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 179

def fetch

    payload = @version.fetch('GET', @uri)
    RoomInstance.new(
        @version,
        payload,
        room_sid: @solution[:room_sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



218
219
220
221
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 218

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) 


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

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



211
212
213
214
 
# File 'lib/twilio-ruby/rest/insights/v1/room.rb', line 211

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