class Twilio::REST::Api::V2010::AccountContext::QueueContext::MemberList
Public Class Methods
Initialize the MemberList
@param [Version] version Version
that contains the resource @param [String] account_sid The SID of the
{Account}[https://www.twilio.com/docs/iam/api/account] that created this Queue resource.
@param [String] queue_sid The SID of the Queue the member is in. @return [MemberList] MemberList
Twilio::REST::ListResource::new
# File lib/twilio-ruby/rest/api/v2010/account/queue/member.rb 24 def initialize(version, account_sid: nil, queue_sid: nil) 25 super(version) 26 27 # Path Solution 28 @solution = {account_sid: account_sid, queue_sid: queue_sid} 29 @uri = "/Accounts/#{@solution[:account_sid]}/Queues/#{@solution[:queue_sid]}/Members.json" 30 end
Public Instance Methods
When passed a block, yields MemberInstance
records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
# File lib/twilio-ruby/rest/api/v2010/account/queue/member.rb 70 def each 71 limits = @version.read_limits 72 73 page = self.page(page_size: limits[:page_size], ) 74 75 @version.stream(page, 76 limit: limits[:limit], 77 page_limit: limits[:page_limit]).each {|x| yield x} 78 end
Retrieve a single page of MemberInstance
records from the API. Request
is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page
of MemberInstance
# File lib/twilio-ruby/rest/api/v2010/account/queue/member.rb 104 def get_page(target_url) 105 response = @version.domain.request( 106 'GET', 107 target_url 108 ) 109 MemberPage.new(@version, response, @solution) 110 end
Lists MemberInstance
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/api/v2010/account/queue/member.rb 43 def list(limit: nil, page_size: nil) 44 self.stream(limit: limit, page_size: page_size).entries 45 end
Retrieve a single page of MemberInstance
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 MemberInstance
# File lib/twilio-ruby/rest/api/v2010/account/queue/member.rb 87 def page(page_token: :unset, page_number: :unset, page_size: :unset) 88 params = Twilio::Values.of({ 89 'PageToken' => page_token, 90 'Page' => page_number, 91 'PageSize' => page_size, 92 }) 93 94 response = @version.page('GET', @uri, params: params) 95 96 MemberPage.new(@version, response, @solution) 97 end
Streams MemberInstance
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/api/v2010/account/queue/member.rb 58 def stream(limit: nil, page_size: nil) 59 limits = @version.read_limits(limit, page_size) 60 61 page = self.page(page_size: limits[:page_size], ) 62 63 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) 64 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/api/v2010/account/queue/member.rb 114 def to_s 115 '#<Twilio.Api.V2010.MemberList>' 116 end