Class: Twilio::REST::Wireless::V1::SimContext::DataSessionList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Wireless::V1::SimContext::DataSessionList
- Defined in:
- lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb
Instance Method Summary collapse
-
#each ⇒ Object
When passed a block, yields DataSessionInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of DataSessionInstance records from the API.
-
#initialize(version, sim_sid: nil) ⇒ DataSessionList
constructor
Initialize the DataSessionList.
-
#list(limit: nil, page_size: nil) ⇒ Array
Lists DataSessionInstance records from the API as a list.
-
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of DataSessionInstance 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, sim_sid: nil) ⇒ DataSessionList
Initialize the DataSessionList
27 28 29 30 31 32 33 |
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 27 def initialize(version, sim_sid: nil) super(version) # Path Solution @solution = { sim_sid: sim_sid } @uri = "/Sims/#{@solution[:sim_sid]}/DataSessions" end |
Instance Method Details
#each ⇒ Object
When passed a block, yields DataSessionInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
77 78 79 80 81 82 83 84 85 |
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 77 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 DataSessionInstance records from the API. Request is executed immediately.
112 113 114 115 116 117 118 |
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 112 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) DataSessionPage.new(@version, response, @solution) end |
#list(limit: nil, page_size: nil) ⇒ Array
Lists DataSessionInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
46 47 48 49 50 51 |
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 46 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 DataSessionInstance records from the API. Request is executed immediately.
94 95 96 97 98 99 100 101 102 103 104 105 |
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 94 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) DataSessionPage.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.
64 65 66 67 68 69 70 71 |
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 64 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
123 124 125 |
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 123 def to_s '#<Twilio.Wireless.V1.DataSessionList>' end |