Class: Twilio::REST::Conversations::V1::ServiceContext::UserList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Conversations::V1::ServiceContext::UserList
- Defined in:
- lib/twilio-ruby/rest/conversations/v1/service/user.rb
Instance Method Summary collapse
-
#create(identity: nil, friendly_name: :unset, attributes: :unset, role_sid: :unset, x_twilio_webhook_enabled: :unset) ⇒ UserInstance
Create the UserInstance.
-
#each ⇒ Object
When passed a block, yields UserInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of UserInstance records from the API.
-
#initialize(version, chat_service_sid: nil) ⇒ UserList
constructor
Initialize the UserList.
-
#list(limit: nil, page_size: nil) ⇒ Array
Lists UserInstance records from the API as a list.
-
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of UserInstance records from the API.
-
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams UserInstance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version, chat_service_sid: nil) ⇒ UserList
Initialize the UserList
22 23 24 25 26 27 28 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user.rb', line 22 def initialize(version, chat_service_sid: nil) super(version) # Path Solution @solution = {chat_service_sid: chat_service_sid} @uri = "/Services/#{@solution[:chat_service_sid]}/Users" end |
Instance Method Details
#create(identity: nil, friendly_name: :unset, attributes: :unset, role_sid: :unset, x_twilio_webhook_enabled: :unset) ⇒ UserInstance
Create the UserInstance
46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user.rb', line 46 def create(identity: nil, friendly_name: :unset, attributes: :unset, role_sid: :unset, x_twilio_webhook_enabled: :unset) data = Twilio::Values.of({ 'Identity' => identity, 'FriendlyName' => friendly_name, 'Attributes' => attributes, 'RoleSid' => role_sid, }) headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, }) payload = @version.create('POST', @uri, data: data, headers: headers) UserInstance.new(@version, payload, chat_service_sid: @solution[:chat_service_sid], ) end |
#each ⇒ Object
When passed a block, yields UserInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
98 99 100 101 102 103 104 105 106 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user.rb', line 98 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 UserInstance records from the API. Request is executed immediately.
132 133 134 135 136 137 138 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user.rb', line 132 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) UserPage.new(@version, response, @solution) end |
#list(limit: nil, page_size: nil) ⇒ Array
Lists UserInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.
71 72 73 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user.rb', line 71 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 UserInstance records from the API. Request is executed immediately.
115 116 117 118 119 120 121 122 123 124 125 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user.rb', line 115 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) UserPage.new(@version, response, @solution) end |
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams UserInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
86 87 88 89 90 91 92 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user.rb', line 86 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
142 143 144 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user.rb', line 142 def to_s '#<Twilio.Conversations.V1.UserList>' end |