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



25
26
27
28
29
30
31
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 25

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, max_duration: :unset) ⇒ MediaProcessorInstance

Create the MediaProcessorInstance



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 41

def create(
    extension: nil, 
    extension_context: nil, 
    extension_environment: :unset, 
    status_callback: :unset, 
    status_callback_method: :unset, 
    max_duration: :unset
)

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

    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.



117
118
119
120
121
122
123
124
125
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 117

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.



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

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.



80
81
82
83
84
85
86
87
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 80

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.



136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 136

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 Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



102
103
104
105
106
107
108
109
110
111
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 102

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



166
167
168
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 166

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