Class: Twilio::REST::Insights::V1::ConferenceList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Insights::V1::ConferenceList
- Defined in:
- lib/twilio-ruby/rest/insights/v1/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) ⇒ ConferenceList
constructor
Initialize the ConferenceList.
-
#list(conference_sid: :unset, friendly_name: :unset, status: :unset, created_after: :unset, created_before: :unset, mixer_region: :unset, tags: :unset, subaccount: :unset, detected_issues: :unset, end_reason: :unset, limit: nil, page_size: nil) ⇒ Array
Lists ConferenceInstance records from the API as a list.
-
#page(conference_sid: :unset, friendly_name: :unset, status: :unset, created_after: :unset, created_before: :unset, mixer_region: :unset, tags: :unset, subaccount: :unset, detected_issues: :unset, end_reason: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of ConferenceInstance records from the API.
-
#stream(conference_sid: :unset, friendly_name: :unset, status: :unset, created_after: :unset, created_before: :unset, mixer_region: :unset, tags: :unset, subaccount: :unset, detected_issues: :unset, end_reason: :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) ⇒ ConferenceList
Initialize the ConferenceList
25 26 27 28 29 30 31 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 25 def initialize(version) super(version) # Path Solution @solution = { } @uri = "/Conferences" 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.
115 116 117 118 119 120 121 122 123 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 115 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.
180 181 182 183 184 185 186 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 180 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) ConferencePage.new(@version, response, @solution) end |
#list(conference_sid: :unset, friendly_name: :unset, status: :unset, created_after: :unset, created_before: :unset, mixer_region: :unset, tags: :unset, subaccount: :unset, detected_issues: :unset, end_reason: :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 68 69 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 54 def list(conference_sid: :unset, friendly_name: :unset, status: :unset, created_after: :unset, created_before: :unset, mixer_region: :unset, tags: :unset, subaccount: :unset, detected_issues: :unset, end_reason: :unset, limit: nil, page_size: nil) self.stream( conference_sid: conference_sid, friendly_name: friendly_name, status: status, created_after: created_after, created_before: created_before, mixer_region: mixer_region, tags: , subaccount: subaccount, detected_issues: detected_issues, end_reason: end_reason, limit: limit, page_size: page_size ).entries end |
#page(conference_sid: :unset, friendly_name: :unset, status: :unset, created_after: :unset, created_before: :unset, mixer_region: :unset, tags: :unset, subaccount: :unset, detected_issues: :unset, end_reason: :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.
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 142 def page(conference_sid: :unset, friendly_name: :unset, status: :unset, created_after: :unset, created_before: :unset, mixer_region: :unset, tags: :unset, subaccount: :unset, detected_issues: :unset, end_reason: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'ConferenceSid' => conference_sid, 'FriendlyName' => friendly_name, 'Status' => status, 'CreatedAfter' => created_after, 'CreatedBefore' => created_before, 'MixerRegion' => mixer_region, 'Tags' => , 'Subaccount' => subaccount, 'DetectedIssues' => detected_issues, 'EndReason' => end_reason, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) ConferencePage.new(@version, response, @solution) end |
#stream(conference_sid: :unset, friendly_name: :unset, status: :unset, created_after: :unset, created_before: :unset, mixer_region: :unset, tags: :unset, subaccount: :unset, detected_issues: :unset, end_reason: :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.
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 92 def stream(conference_sid: :unset, friendly_name: :unset, status: :unset, created_after: :unset, created_before: :unset, mixer_region: :unset, tags: :unset, subaccount: :unset, detected_issues: :unset, end_reason: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( conference_sid: conference_sid, friendly_name: friendly_name, status: status, created_after: created_after, created_before: created_before, mixer_region: mixer_region, tags: , subaccount: subaccount, detected_issues: detected_issues, end_reason: end_reason, 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
191 192 193 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 191 def to_s '#<Twilio.Insights.V1.ConferenceList>' end |