Class: Twilio::REST::Chat::V2::ServiceContext::UserContext::UserBindingList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil, user_sid: nil) ⇒ UserBindingList

Initialize the UserBindingList



22
23
24
25
26
27
28
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 22

def initialize(version, service_sid: nil, user_sid: nil)
  super(version)

  # Path Solution
  @solution = {service_sid: service_sid, user_sid: user_sid}
  @uri = "/Services/#{@solution[:service_sid]}/Users/#{@solution[:user_sid]}/Bindings"
end

Instance Method Details

#each ⇒ Object

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



70
71
72
73
74
75
76
77
78
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 70

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



108
109
110
111
112
113
114
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 108

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

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

Lists UserBindingInstance 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/chat/v2/service/user/user_binding.rb', line 42

def list(binding_type: :unset, limit: nil, page_size: nil)
  self.stream(binding_type: binding_type, limit: limit, page_size: page_size).entries
end

#page(binding_type: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of UserBindingInstance records from the API. Request is executed immediately.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 88

def page(binding_type: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'BindingType' => Twilio.serialize_list(binding_type) { |e| e },
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  UserBindingPage.new(@version, response, @solution)
end

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

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



58
59
60
61
62
63
64
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 58

def stream(binding_type: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(binding_type: binding_type, 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



118
119
120
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 118

def to_s
  '#<Twilio.Chat.V2.UserBindingList>'
end