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.



295
296
297
298
299
300
301
302
303
304
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 295

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



308
309
310
311
312
313
314
315
316
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 308

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    

    @version.delete('DELETE', @uri, headers: headers)
end

#delete_with_metadata ⇒ Boolean

Delete the CompositionInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 321

def delete_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
      response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
      composition_instance = CompositionInstance.new(
          @version,
          response.body,
          account_sid: @solution[:account_sid],
          sid: @solution[:sid],
      )
      CompositionInstanceMetadata.new(@version, composition_instance, response.headers, response.status_code)
end

#fetch ⇒ CompositionInstance

Fetch the CompositionInstance

Returns:



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 340

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

#fetch_with_metadata ⇒ CompositionInstance

Fetch the CompositionInstanceMetadata

Returns:



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 359

def fetch_with_metadata

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



391
392
393
394
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 391

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

#to_s ⇒ Object

Provide a user friendly representation



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

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