Class: Twilio::REST::Chat::V2::ServiceContext::ChannelList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil) ⇒ ChannelList

Initialize the ChannelList



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

def initialize(version, service_sid: nil)
    super(version)
    # Path Solution
    @solution = { service_sid: service_sid }
    @uri = "/Services/#{@solution[:service_sid]}/Channels"
    
end

Instance Method Details

#create(friendly_name: :unset, unique_name: :unset, attributes: :unset, type: :unset, date_created: :unset, date_updated: :unset, created_by: :unset, x_twilio_webhook_enabled: :unset) ⇒ ChannelInstance

Create the ChannelInstance



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 46

def create(
    friendly_name: :unset, 
    unique_name: :unset, 
    attributes: :unset, 
    type: :unset, 
    date_created: :unset, 
    date_updated: :unset, 
    created_by: :unset, 
    x_twilio_webhook_enabled: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
        'UniqueName' => unique_name,
        'Attributes' => attributes,
        'Type' => type,
        'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
        'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
        'CreatedBy' => created_by,
    })

    
    headers = Twilio::Values.of({ 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
    payload = @version.create('POST', @uri, data: data, headers: headers)
    ChannelInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
    )
end

#each ⇒ Object

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



124
125
126
127
128
129
130
131
132
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 124

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



161
162
163
164
165
166
167
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 161

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

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

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



90
91
92
93
94
95
96
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 90

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

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

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



142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 142

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

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

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

#stream(type: :unset, 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.



110
111
112
113
114
115
116
117
118
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 110

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

    page = self.page(
        type: 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



172
173
174
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 172

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