Class: Twilio::REST::Api::V2010::AccountContext::QueueContext::MemberList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/queue/member.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil, queue_sid: nil) ⇒ MemberList

Initialize the MemberList



23
24
25
26
27
28
29
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue/member.rb', line 23

def initialize(version, account_sid: nil, queue_sid: nil)
  super(version)

  # Path Solution
  @solution = {account_sid: , queue_sid: queue_sid}
  @uri = "/Accounts/#{@solution[:account_sid]}/Queues/#{@solution[:queue_sid]}/Members.json"
end

Instance Method Details

#each ⇒ Object

When passed a block, yields MemberInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



69
70
71
72
73
74
75
76
77
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue/member.rb', line 69

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 MemberInstance records from the API. Request is executed immediately.



105
106
107
108
109
110
111
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue/member.rb', line 105

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  MemberPage.new(@version, response, @solution)
end

#list(limit: nil, page_size: nil) ⇒ Array

Lists MemberInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.



42
43
44
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue/member.rb', line 42

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 MemberInstance records from the API. Request is executed immediately.



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue/member.rb', line 86

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
  )
  MemberPage.new(@version, response, @solution)
end

#stream(limit: nil, page_size: nil) ⇒ Enumerable

Streams MemberInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



57
58
59
60
61
62
63
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue/member.rb', line 57

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



115
116
117
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue/member.rb', line 115

def to_s
  '#<Twilio.Api.V2010.MemberList>'
end