Class: Twilio::REST::Media::V1::MediaRecordingList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Media::V1::MediaRecordingList
- Defined in:
- lib/twilio-ruby/rest/media/v1/media_recording.rb
Instance Method Summary collapse
-
#each ⇒ Object
When passed a block, yields MediaRecordingInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of MediaRecordingInstance records from the API.
-
#initialize(version) ⇒ MediaRecordingList
constructor
Initialize the MediaRecordingList.
-
#list(order: :unset, status: :unset, processor_sid: :unset, source_sid: :unset, limit: nil, page_size: nil) ⇒ Array
Lists MediaRecordingInstance records from the API as a list.
-
#page(order: :unset, status: :unset, processor_sid: :unset, source_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of MediaRecordingInstance records from the API.
-
#stream(order: :unset, status: :unset, processor_sid: :unset, source_sid: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version) ⇒ MediaRecordingList
Initialize the MediaRecordingList
25 26 27 28 29 30 31 |
# File 'lib/twilio-ruby/rest/media/v1/media_recording.rb', line 25 def initialize(version) super(version) # Path Solution @solution = { } @uri = "/MediaRecordings" end |
Instance Method Details
#each ⇒ Object
When passed a block, yields MediaRecordingInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
91 92 93 94 95 96 97 98 99 |
# File 'lib/twilio-ruby/rest/media/v1/media_recording.rb', line 91 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 MediaRecordingInstance records from the API. Request is executed immediately.
133 134 135 136 137 138 139 |
# File 'lib/twilio-ruby/rest/media/v1/media_recording.rb', line 133 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) MediaRecordingPage.new(@version, response, @solution) end |
#list(order: :unset, status: :unset, processor_sid: :unset, source_sid: :unset, limit: nil, page_size: nil) ⇒ Array
Lists MediaRecordingInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
48 49 50 51 52 53 54 55 56 57 |
# File 'lib/twilio-ruby/rest/media/v1/media_recording.rb', line 48 def list(order: :unset, status: :unset, processor_sid: :unset, source_sid: :unset, limit: nil, page_size: nil) self.stream( order: order, status: status, processor_sid: processor_sid, source_sid: source_sid, limit: limit, page_size: page_size ).entries end |
#page(order: :unset, status: :unset, processor_sid: :unset, source_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of MediaRecordingInstance records from the API. Request is executed immediately.
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 |
# File 'lib/twilio-ruby/rest/media/v1/media_recording.rb', line 112 def page(order: :unset, status: :unset, processor_sid: :unset, source_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'Order' => order, 'Status' => status, 'ProcessorSid' => processor_sid, 'SourceSid' => source_sid, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) MediaRecordingPage.new(@version, response, @solution) end |
#stream(order: :unset, status: :unset, processor_sid: :unset, source_sid: :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.
74 75 76 77 78 79 80 81 82 83 84 85 |
# File 'lib/twilio-ruby/rest/media/v1/media_recording.rb', line 74 def stream(order: :unset, status: :unset, processor_sid: :unset, source_sid: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( order: order, status: status, processor_sid: processor_sid, source_sid: source_sid, 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
144 145 146 |
# File 'lib/twilio-ruby/rest/media/v1/media_recording.rb', line 144 def to_s '#<Twilio.Media.V1.MediaRecordingList>' end |