class Twilio::REST::IpMessaging::V1::ServiceContext::UserList
Public Class Methods
Initialize the UserList
@param [Version] version Version
that contains the resource @param [String] service_sid The service_sid @return [UserList] UserList
Twilio::REST::ListResource::new
# File lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb 20 def initialize(version, service_sid: nil) 21 super(version) 22 23 # Path Solution 24 @solution = {service_sid: service_sid} 25 @uri = "/Services/#{@solution[:service_sid]}/Users" 26 end
Public Instance Methods
Create the UserInstance
@param [String] identity The identity @param [String] role_sid The role_sid @param [String] attributes The attributes @param [String] friendly_name The friendly_name @return [UserInstance] Created UserInstance
# File lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb 35 def create(identity: nil, role_sid: :unset, attributes: :unset, friendly_name: :unset) 36 data = Twilio::Values.of({ 37 'Identity' => identity, 38 'RoleSid' => role_sid, 39 'Attributes' => attributes, 40 'FriendlyName' => friendly_name, 41 }) 42 43 payload = @version.create('POST', @uri, data: data) 44 45 UserInstance.new(@version, payload, service_sid: @solution[:service_sid], ) 46 end
When passed a block, yields UserInstance
records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
# File lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb 86 def each 87 limits = @version.read_limits 88 89 page = self.page(page_size: limits[:page_size], ) 90 91 @version.stream(page, 92 limit: limits[:limit], 93 page_limit: limits[:page_limit]).each {|x| yield x} 94 end
Retrieve a single page of UserInstance
records from the API. Request
is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page
of UserInstance
# File lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb 120 def get_page(target_url) 121 response = @version.domain.request( 122 'GET', 123 target_url 124 ) 125 UserPage.new(@version, response, @solution) 126 end
Lists UserInstance
records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [Integer] limit Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit
@param [Integer] page_size Number of records to fetch per request, when
not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
@return [Array] Array of up to limit results
# File lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb 59 def list(limit: nil, page_size: nil) 60 self.stream(limit: limit, page_size: page_size).entries 61 end
Retrieve a single page of UserInstance
records from the API. Request
is executed immediately. @param [String] page_token PageToken provided by the API @param [Integer] page_number Page
Number, this value is simply for client state @param [Integer] page_size Number of records to return, defaults to 50 @return [Page] Page
of UserInstance
# File lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb 103 def page(page_token: :unset, page_number: :unset, page_size: :unset) 104 params = Twilio::Values.of({ 105 'PageToken' => page_token, 106 'Page' => page_number, 107 'PageSize' => page_size, 108 }) 109 110 response = @version.page('GET', @uri, params: params) 111 112 UserPage.new(@version, response, @solution) 113 end
Streams UserInstance
records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [Integer] limit Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit.
@param [Integer] page_size Number of records to fetch per request, when
not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
@return [Enumerable] Enumerable that will yield up to limit results
# File lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb 74 def stream(limit: nil, page_size: nil) 75 limits = @version.read_limits(limit, page_size) 76 77 page = self.page(page_size: limits[:page_size], ) 78 79 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) 80 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb 130 def to_s 131 '#<Twilio.IpMessaging.V1.UserList>' 132 end