Class: Twilio::REST::Video::V1::CompositionHookContext

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

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ CompositionHookContext

Initialize the CompositionHookContext



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

def initialize(version, sid)
  super(version)

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

Instance Method Details

#deleteBoolean

Delete the CompositionHookInstance



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

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

#fetchCompositionHookInstance

Fetch the CompositionHookInstance



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

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

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

#inspectObject

Provide a detailed, user friendly representation



403
404
405
406
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 403

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

#to_sObject

Provide a user friendly representation



396
397
398
399
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 396

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

#update(friendly_name: nil, enabled: :unset, video_layout: :unset, audio_sources: :unset, audio_sources_excluded: :unset, trim: :unset, format: :unset, resolution: :unset, status_callback: :unset, status_callback_method: :unset) ⇒ CompositionHookInstance

Update the CompositionHookInstance



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 375

def update(friendly_name: nil, enabled: :unset, video_layout: :unset, audio_sources: :unset, audio_sources_excluded: :unset, trim: :unset, format: :unset, resolution: :unset, status_callback: :unset, status_callback_method: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'Enabled' => enabled,
      'VideoLayout' => Twilio.serialize_object(video_layout),
      'AudioSources' => Twilio.serialize_list(audio_sources) { |e| e },
      'AudioSourcesExcluded' => Twilio.serialize_list(audio_sources_excluded) { |e| e },
      'Trim' => trim,
      'Format' => format,
      'Resolution' => resolution,
      'StatusCallback' => status_callback,
      'StatusCallbackMethod' => status_callback_method,
  })

  payload = @version.update('POST', @uri, data: data)

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