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

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

Instance Method Summary collapse

Constructor Details

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

Initialize the UserChannelList



26
27
28
29
30
31
32
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 26

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]}/Channels"
end

Instance Method Details

#each ⇒ Object

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



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

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



106
107
108
109
110
111
112
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 106

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

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

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



45
46
47
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 45

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



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

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: params)

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

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

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



60
61
62
63
64
65
66
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 60

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



116
117
118
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 116

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