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.



102
103
104
105
106
107
108
109
110
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb', line 102

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.



139
140
141
142
143
144
145
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb', line 139

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.



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb', line 85

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.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb', line 119

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
 
# 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], )

    @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



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

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