Class: Twilio::REST::Content::V1::LegacyContentList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Content::V1::LegacyContentList
- Defined in:
- lib/twilio-ruby/rest/content/v1/legacy_content.rb
Instance Method Summary collapse
-
#each ⇒ Object
When passed a block, yields LegacyContentInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of LegacyContentInstance records from the API.
-
#initialize(version) ⇒ LegacyContentList
constructor
Initialize the LegacyContentList.
-
#list(limit: nil, page_size: nil) ⇒ Array
Lists LegacyContentInstance records from the API as a list.
-
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of LegacyContentInstance records from the API.
-
#stream(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) ⇒ LegacyContentList
Initialize the LegacyContentList
25 26 27 28 29 30 31 |
# File 'lib/twilio-ruby/rest/content/v1/legacy_content.rb', line 25 def initialize(version) super(version) # Path Solution @solution = { } @uri = "/LegacyContent" end |
Instance Method Details
#each ⇒ Object
When passed a block, yields LegacyContentInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
75 76 77 78 79 80 81 82 83 |
# File 'lib/twilio-ruby/rest/content/v1/legacy_content.rb', line 75 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 LegacyContentInstance records from the API. Request is executed immediately.
109 110 111 112 113 114 115 |
# File 'lib/twilio-ruby/rest/content/v1/legacy_content.rb', line 109 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) LegacyContentPage.new(@version, response, @solution) end |
#list(limit: nil, page_size: nil) ⇒ Array
Lists LegacyContentInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
44 45 46 47 48 49 |
# File 'lib/twilio-ruby/rest/content/v1/legacy_content.rb', line 44 def list(limit: nil, page_size: nil) self.stream( limit: limit, page_size: page_size ).entries end |
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of LegacyContentInstance records from the API. Request is executed immediately.
92 93 94 95 96 97 98 99 100 101 102 |
# File 'lib/twilio-ruby/rest/content/v1/legacy_content.rb', line 92 def page(page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) LegacyContentPage.new(@version, response, @solution) end |
#stream(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.
62 63 64 65 66 67 68 69 |
# File 'lib/twilio-ruby/rest/content/v1/legacy_content.rb', line 62 def stream(limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( 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
120 121 122 |
# File 'lib/twilio-ruby/rest/content/v1/legacy_content.rb', line 120 def to_s '#<Twilio.Content.V1.LegacyContentList>' end |