Class: Twilio::REST::Chat::V2::ServiceContext::BindingList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil) ⇒ BindingList

Initialize the BindingList



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

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

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

Instance Method Details

#each ⇒ Object

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



91
92
93
94
95
96
97
98
99
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 91

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



136
137
138
139
140
141
142
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 136

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

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

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



50
51
52
53
54
55
56
57
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 50

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

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

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



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 117

def page(binding_type: :unset, identity: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'BindingType' => Twilio.serialize_list(binding_type) { |e| e },
      'Identity' => Twilio.serialize_list(identity) { |e| e },
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

  response = @version.page('GET', @uri, params: params)

  BindingPage.new(@version, response, @solution)
end

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

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



79
80
81
82
83
84
85
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 79

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

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



146
147
148
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 146

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