Class: Twilio::REST::Proxy::V1::ServiceContext::SessionContext::ParticipantList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Proxy::V1::ServiceContext::SessionContext::ParticipantList
- Defined in:
- lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb
Instance Method Summary collapse
-
#create(identifier: nil, friendly_name: :unset, proxy_identifier: :unset, proxy_identifier_sid: :unset) ⇒ ParticipantInstance
Create the ParticipantInstance.
-
#each ⇒ Object
When passed a block, yields ParticipantInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of ParticipantInstance records from the API.
-
#initialize(version, service_sid: nil, session_sid: nil) ⇒ ParticipantList
constructor
Initialize the ParticipantList.
-
#list(limit: nil, page_size: nil) ⇒ Array
Lists ParticipantInstance records from the API as a list.
-
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of ParticipantInstance 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, service_sid: nil, session_sid: nil) ⇒ ParticipantList
Initialize the ParticipantList
28 29 30 31 32 33 34 |
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 28 def initialize(version, service_sid: nil, session_sid: nil) super(version) # Path Solution @solution = { service_sid: service_sid, session_sid: session_sid } @uri = "/Services/#{@solution[:service_sid]}/Sessions/#{@solution[:session_sid]}/Participants" end |
Instance Method Details
#create(identifier: nil, friendly_name: :unset, proxy_identifier: :unset, proxy_identifier_sid: :unset) ⇒ ParticipantInstance
Create the ParticipantInstance
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 42 def create( identifier: nil, friendly_name: :unset, proxy_identifier: :unset, proxy_identifier_sid: :unset ) data = Twilio::Values.of({ 'Identifier' => identifier, 'FriendlyName' => friendly_name, 'ProxyIdentifier' => proxy_identifier, 'ProxyIdentifierSid' => proxy_identifier_sid, }) payload = @version.create('POST', @uri, data: data) ParticipantInstance.new( @version, payload, service_sid: @solution[:service_sid], session_sid: @solution[:session_sid], ) end |
#each ⇒ Object
When passed a block, yields ParticipantInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
108 109 110 111 112 113 114 115 116 |
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 108 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 ParticipantInstance records from the API. Request is executed immediately.
142 143 144 145 146 147 148 |
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 142 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) ParticipantPage.new(@version, response, @solution) end |
#list(limit: nil, page_size: nil) ⇒ Array
Lists ParticipantInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
77 78 79 80 81 82 |
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 77 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 ParticipantInstance records from the API. Request is executed immediately.
125 126 127 128 129 130 131 132 133 134 135 |
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 125 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) ParticipantPage.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.
95 96 97 98 99 100 101 102 |
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 95 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
153 154 155 |
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 153 def to_s '#<Twilio.Proxy.V1.ParticipantList>' end |