Class: Twilio::REST::Video::V1::CompositionHookList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/video/v1/composition_hook.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) ⇒ CompositionHookList

Initialize the CompositionHookList



20
21
22
23
24
25
26
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 20

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/CompositionHooks"
end

Instance Method Details

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

Retrieve a single page of CompositionHookInstance records from the API. Request is executed immediately.



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 199

def create(friendly_name: nil, enabled: :unset, video_layout: :unset, audio_sources: :unset, audio_sources_excluded: :unset, resolution: :unset, format: :unset, status_callback: :unset, status_callback_method: :unset, trim: :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 },
      'Resolution' => resolution,
      'Format' => format,
      'StatusCallback' => status_callback,
      'StatusCallbackMethod' => status_callback_method,
      'Trim' => trim,
  })

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

  CompositionHookInstance.new(@version, payload, )
end

#each ⇒ Object

When passed a block, yields CompositionHookInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



89
90
91
92
93
94
95
96
97
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 89

def each
  limits = @version.read_limits

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page,
                  limit: limits[:limit],
                  page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of CompositionHookInstance records from the API. Request is executed immediately.



134
135
136
137
138
139
140
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 134

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  CompositionHookPage.new(@version, response, @solution)
end

#list(enabled: :unset, date_created_after: :unset, date_created_before: :unset, limit: nil, page_size: nil) ⇒ Array

Lists CompositionHookInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.



45
46
47
48
49
50
51
52
53
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 45

def list(enabled: :unset, date_created_after: :unset, date_created_before: :unset, limit: nil, page_size: nil)
  self.stream(
      enabled: enabled,
      date_created_after: date_created_after,
      date_created_before: date_created_before,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(enabled: :unset, date_created_after: :unset, date_created_before: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of CompositionHookInstance records from the API. Request is executed immediately.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 112

def page(enabled: :unset, date_created_after: :unset, date_created_before: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'Enabled' => enabled,
      'DateCreatedAfter' => Twilio.serialize_iso8601_datetime(date_created_after),
      'DateCreatedBefore' => Twilio.serialize_iso8601_datetime(date_created_before),
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  CompositionHookPage.new(@version, response, @solution)
end

#stream(enabled: :unset, date_created_after: :unset, date_created_before: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams CompositionHookInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 72

def stream(enabled: :unset, date_created_after: :unset, date_created_before: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      enabled: enabled,
      date_created_after: date_created_after,
      date_created_before: date_created_before,
      page_size: limits[:page_size],
  )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



224
225
226
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 224

def to_s
  '#<Twilio.Video.V1.CompositionHookList>'
end