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 Composition Sid that uniquely identifies the Composition to fetch.



272
273
274
275
276
277
278
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 272

def initialize(version, sid)
  super(version)

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

Instance Method Details

#delete ⇒ Boolean

Deletes the CompositionInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



298
299
300
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 298

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

#fetch ⇒ CompositionInstance

Fetch a CompositionInstance

Returns:



283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 283

def fetch
  params = Twilio::Values.of({})

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

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

#to_s ⇒ Object

Provide a user friendly representation



304
305
306
307
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 304

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