Class: Twilio::REST::Video::V1::CompositionContext

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/video/v1/composition.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ CompositionContext

Initialize the CompositionContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    The SID of the Composition resource to fetch.



209
210
211
212
213
214
215
216
217
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 209

def initialize(version, sid)
    super(version)

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

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the CompositionInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



221
222
223
224
225
226
227
228
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 221

def delete

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

#fetch ⇒ CompositionInstance

Fetch the CompositionInstance

Returns:



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 233

def fetch

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



259
260
261
262
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 259

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

#to_s ⇒ Object

Provide a user friendly representation



252
253
254
255
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 252

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