Class: Twilio::REST::Video::V1::RoomContext::RoomRecordingContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/video/v1/room/room_recording.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, room_sid, sid) ⇒ RoomRecordingContext

Initialize the RoomRecordingContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • room_sid (String) —

    The SID of the Room resource with the recording to fetch.

  • sid (String) —

    The SID of the RoomRecording resource to fetch.



160
161
162
163
164
165
166
167
168
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 160

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

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

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the RoomRecordingInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



172
173
174
175
176
177
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 172

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    @version.delete('DELETE', @uri, headers: headers)
end

#fetch ⇒ RoomRecordingInstance

Fetch the RoomRecordingInstance

Returns:



182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 182

def fetch

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



205
206
207
208
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 205

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

#to_s ⇒ Object

Provide a user friendly representation



198
199
200
201
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_recording.rb', line 198

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