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

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

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

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.



275
276
277
278
279
280
281
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 275

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



295
296
297
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 295

def delete
   @version.delete('DELETE', @uri)
end

#fetch ⇒ CompositionInstance

Fetch the CompositionInstance

Returns:



286
287
288
289
290
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 286

def fetch
  payload = @version.fetch('GET', @uri)

  CompositionInstance.new(@version, payload, sid: @solution[:sid], )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#to_s ⇒ Object

Provide a user friendly representation



301
302
303
304
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 301

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