Class: Twilio::REST::Api::V2010::AccountContext::ConferenceList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Api::V2010::AccountContext::ConferenceList
- Defined in:
- lib/twilio-ruby/rest/api/v2010/account/conference.rb
Instance Method Summary collapse
-
#each ⇒ Object
When passed a block, yields ConferenceInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of ConferenceInstance records from the API.
-
#initialize(version, account_sid: nil) ⇒ ConferenceList
constructor
Initialize the ConferenceList.
-
#list(date_created: :unset, date_created_before: :unset, date_created_after: :unset, date_updated: :unset, date_updated_before: :unset, date_updated_after: :unset, friendly_name: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Array
Lists ConferenceInstance records from the API as a list.
-
#page(date_created: :unset, date_created_before: :unset, date_created_after: :unset, date_updated: :unset, date_updated_before: :unset, date_updated_after: :unset, friendly_name: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of ConferenceInstance records from the API.
-
#stream(date_created: :unset, date_created_before: :unset, date_created_after: :unset, date_updated: :unset, date_updated_before: :unset, date_updated_after: :unset, friendly_name: :unset, status: :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) ⇒ ConferenceList
Initialize the ConferenceList
27 28 29 30 31 32 33 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 27 def initialize(version, account_sid: nil) super(version) # Path Solution @solution = { account_sid: account_sid } @uri = "/Accounts/#{@solution[:account_sid]}/Conferences.json" end |
Instance Method Details
#each ⇒ Object
When passed a block, yields ConferenceInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
109 110 111 112 113 114 115 116 117 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 109 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 ConferenceInstance records from the API. Request is executed immediately.
168 169 170 171 172 173 174 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 168 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) ConferencePage.new(@version, response, @solution) end |
#list(date_created: :unset, date_created_before: :unset, date_created_after: :unset, date_updated: :unset, date_updated_before: :unset, date_updated_after: :unset, friendly_name: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Array
Lists ConferenceInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 54 def list(date_created: :unset, date_created_before: :unset, date_created_after: :unset, date_updated: :unset, date_updated_before: :unset, date_updated_after: :unset, friendly_name: :unset, status: :unset, limit: nil, page_size: nil) self.stream( date_created: date_created, date_created_before: date_created_before, date_created_after: date_created_after, date_updated: date_updated, date_updated_before: date_updated_before, date_updated_after: date_updated_after, friendly_name: friendly_name, status: status, limit: limit, page_size: page_size ).entries end |
#page(date_created: :unset, date_created_before: :unset, date_created_after: :unset, date_updated: :unset, date_updated_before: :unset, date_updated_after: :unset, friendly_name: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of ConferenceInstance records from the API. Request is executed immediately.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 134 def page(date_created: :unset, date_created_before: :unset, date_created_after: :unset, date_updated: :unset, date_updated_before: :unset, date_updated_after: :unset, friendly_name: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'DateCreated' => Twilio.serialize_iso8601_date(date_created), 'DateCreated<' => Twilio.serialize_iso8601_date(date_created_before), 'DateCreated>' => Twilio.serialize_iso8601_date(date_created_after), 'DateUpdated' => Twilio.serialize_iso8601_date(date_updated), 'DateUpdated<' => Twilio.serialize_iso8601_date(date_updated_before), 'DateUpdated>' => Twilio.serialize_iso8601_date(date_updated_after), 'FriendlyName' => friendly_name, 'Status' => status, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) ConferencePage.new(@version, response, @solution) end |
#stream(date_created: :unset, date_created_before: :unset, date_created_after: :unset, date_updated: :unset, date_updated_before: :unset, date_updated_after: :unset, friendly_name: :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.
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 88 def stream(date_created: :unset, date_created_before: :unset, date_created_after: :unset, date_updated: :unset, date_updated_before: :unset, date_updated_after: :unset, friendly_name: :unset, status: :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, date_updated: date_updated, date_updated_before: date_updated_before, date_updated_after: date_updated_after, friendly_name: friendly_name, 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
179 180 181 |
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 179 def to_s '#<Twilio.Api.V2010.ConferenceList>' end |