Class: Twilio::REST::Api::V2010::AccountContext::MessageContext::MediaList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Api::V2010::AccountContext::MessageContext::MediaList
- Defined in:
- lib/twilio-ruby/rest/api/v2010/account/message/media.rb
Instance Method Summary collapse
-
#each ⇒ Object
When passed a block, yields MediaInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of MediaInstance records from the API.
-
#initialize(version, account_sid: nil, message_sid: nil) ⇒ MediaList
constructor
Initialize the MediaList.
-
#list(date_created: :unset, date_created_before: :unset, date_created_after: :unset, limit: nil, page_size: nil) ⇒ Array
Lists MediaInstance records from the API as a list.
-
#page(date_created: :unset, date_created_before: :unset, date_created_after: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of MediaInstance records from the API.
-
#stream(date_created: :unset, date_created_before: :unset, date_created_after: :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, account_sid: nil, message_sid: nil) ⇒ MediaList
Initialize the MediaList
28 29 30 31 32 33 34 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 28 def initialize(version, account_sid: nil, message_sid: nil) super(version) # Path Solution @solution = { account_sid: account_sid, message_sid: } @uri = "/Accounts/#{@solution[:account_sid]}/Messages/#{@solution[:message_sid]}/Media.json" end |
Instance Method Details
#each ⇒ Object
When passed a block, yields MediaInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
90 91 92 93 94 95 96 97 98 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 90 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 MediaInstance records from the API. Request is executed immediately.
130 131 132 133 134 135 136 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 130 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) MediaPage.new(@version, response, @solution) end |
#list(date_created: :unset, date_created_before: :unset, date_created_after: :unset, limit: nil, page_size: nil) ⇒ Array
Lists MediaInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
50 51 52 53 54 55 56 57 58 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 50 def list(date_created: :unset, date_created_before: :unset, date_created_after: :unset, limit: nil, page_size: nil) self.stream( date_created: date_created, date_created_before: date_created_before, date_created_after: date_created_after, limit: limit, page_size: page_size ).entries end |
#page(date_created: :unset, date_created_before: :unset, date_created_after: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of MediaInstance records from the API. Request is executed immediately.
110 111 112 113 114 115 116 117 118 119 120 121 122 123 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 110 def page(date_created: :unset, date_created_before: :unset, date_created_after: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'DateCreated' => Twilio.serialize_iso8601_datetime(date_created), 'DateCreated<' => Twilio.serialize_iso8601_datetime(date_created_before), 'DateCreated>' => Twilio.serialize_iso8601_datetime(date_created_after), 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) MediaPage.new(@version, response, @solution) end |
#stream(date_created: :unset, date_created_before: :unset, date_created_after: :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 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 74 def stream(date_created: :unset, date_created_before: :unset, date_created_after: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( date_created: date_created, date_created_before: date_created_before, date_created_after: date_created_after, 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
141 142 143 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 141 def to_s '#<Twilio.Api.V2010.MediaList>' end |