Class: Twilio::REST::Media::V1::MediaProcessorList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/media/v1/media_processor.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ MediaProcessorList

Initialize the MediaProcessorList

Parameters:

  • version (Version) —

    Version that contains the resource



18
19
20
21
22
23
24
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 18

def initialize(version)
  super(version)

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

Instance Method Details

#create(extension: nil, extension_context: nil, extension_environment: :unset, status_callback: :unset, status_callback_method: :unset) ⇒ MediaProcessorInstance

Create the MediaProcessorInstance

Parameters:

  • extension (String) (defaults to: nil) —

    The Media Extension name or URL. Ex: ‘video-composer-v1`

  • extension_context (String) (defaults to: nil) —

    The context of the Media Extension, represented as a JSON dictionary. See the documentation for the specific Media Extension you are using for more information about the context to send.

  • extension_environment (Hash) (defaults to: :unset) —

    User-defined environment variables for the Media Extension, represented as a JSON dictionary of key/value strings. See the documentation for the specific Media Extension you are using for more information about whether you need to provide this.

  • status_callback (String) (defaults to: :unset) —

    The URL to which Twilio will send asynchronous webhook requests for every MediaProcessor event. See Status Callbacks for details.

  • status_callback_method (String) (defaults to: :unset) —

    The HTTP method Twilio should use to call the ‘status_callback` URL. Can be `POST` or `GET` and the default is `POST`.

Returns:



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 46

def create(extension: nil, extension_context: nil, extension_environment: :unset, status_callback: :unset, status_callback_method: :unset)
  data = Twilio::Values.of({
      'Extension' => extension,
      'ExtensionContext' => extension_context,
      'ExtensionEnvironment' => Twilio.serialize_object(extension_environment),
      'StatusCallback' => status_callback,
      'StatusCallbackMethod' => status_callback_method,
  })

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

  MediaProcessorInstance.new(@version, payload, )
end

#each ⇒ Object

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



108
109
110
111
112
113
114
115
116
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 108

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 MediaProcessorInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of MediaProcessorInstance



149
150
151
152
153
154
155
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 149

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

#list(order: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Array

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

Parameters:

  • order (media_processor.Order) (defaults to: :unset) —

    The sort order of the list by ‘date_created`. Can be: `asc` (ascending) or `desc` (descending) with `desc` as the default.

  • status (media_processor.Status) (defaults to: :unset) —

    Status to filter by, with possible values ‘started`, `ended` or `failed`.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



76
77
78
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 76

def list(order: :unset, status: :unset, limit: nil, page_size: nil)
  self.stream(order: order, status: status, limit: limit, page_size: page_size).entries
end

#page(order: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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

Parameters:

  • order (media_processor.Order) (defaults to: :unset) —

    The sort order of the list by ‘date_created`. Can be: `asc` (ascending) or `desc` (descending) with `desc` as the default.

  • status (media_processor.Status) (defaults to: :unset) —

    Status to filter by, with possible values ‘started`, `ended` or `failed`.

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of MediaProcessorInstance



130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 130

def page(order: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'Order' => order,
      'Status' => status,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

  response = @version.page('GET', @uri, params: params)

  MediaProcessorPage.new(@version, response, @solution)
end

#stream(order: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

  • order (media_processor.Order) (defaults to: :unset) —

    The sort order of the list by ‘date_created`. Can be: `asc` (ascending) or `desc` (descending) with `desc` as the default.

  • status (media_processor.Status) (defaults to: :unset) —

    Status to filter by, with possible values ‘started`, `ended` or `failed`.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



96
97
98
99
100
101
102
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 96

def stream(order: :unset, status: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(order: order, status: status, 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



159
160
161
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 159

def to_s
  '#<Twilio.Media.V1.MediaProcessorList>'
end