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

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

Instance Method Summary collapse

Constructor Details

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

Initialize the UserChannelList



29
30
31
32
33
34
35
36
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb', line 29

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.



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

def each
    limits = @version.read_limits

    page = self.page(page_size: limits[:page_size], )

    return [].each if page.nil?

    result = @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit])
    return [].each if result.nil?
    result.each {|x| yield x}
end

#get_page(target_url) ⇒ Page

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



147
148
149
150
151
152
153
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb', line 147

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.



49
50
51
52
53
54
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb', line 49

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

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

Lists UserChannelPageMetadata records from the API as a list.



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

def list_with_metadata(limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

    UserChannelPageMetadata.new(@version, response, @solution, limits[:limit])
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.



127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb', line 127

def page(page_token: :unset, page_number: :unset,page_size: :unset)
    params = Twilio::Values.of({
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

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

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

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

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



67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb', line 67

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

    page = self.page(
        page_size: limits[:page_size], )

    return [].each if page.nil?

    result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
    return [].each if result.nil?
    result
end

#to_s ⇒ Object

Provide a user friendly representation



158
159
160
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb', line 158

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