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

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

Instance Method Summary collapse

Constructor Details

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

Initialize the UserBindingList

Parameters:



28
29
30
31
32
33
34
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb', line 28

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.



84
85
86
87
88
89
90
91
92
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb', line 84

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of UserBindingInstance



126
127
128
129
130
131
132
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb', line 126

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.

Parameters:

  • binding_type (user_binding.BindingType) (defaults to: :unset) —

    The push technology used by the User Binding resources to read. Can be: ‘apn`, `gcm`, or `fcm`. See [push notification configuration](www.twilio.com/docs/chat/push-notification-configuration) for more information.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    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)

Returns:

  • (Array) —

    Array of up to limit results



52
53
54
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb', line 52

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.

Parameters:

  • binding_type (user_binding.BindingType) (defaults to: :unset) —

    The push technology used by the User Binding resources to read. Can be: ‘apn`, `gcm`, or `fcm`. See [push notification configuration](www.twilio.com/docs/chat/push-notification-configuration) for more information.

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of UserBindingInstance



106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb', line 106

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.

Parameters:

  • binding_type (user_binding.BindingType) (defaults to: :unset) —

    The push technology used by the User Binding resources to read. Can be: ‘apn`, `gcm`, or `fcm`. See [push notification configuration](www.twilio.com/docs/chat/push-notification-configuration) for more information.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil) —

    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)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



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

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



136
137
138
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb', line 136

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