Class: Twilio::REST::IpMessaging::V1::ServiceContext::ChannelList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil) ⇒ ChannelList

Initialize the ChannelList



18
19
20
21
22
23
24
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 18

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) ⇒ ChannelInstance

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



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 34

def create(friendly_name: :unset, unique_name: :unset, attributes: :unset, type: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'UniqueName' => unique_name,
      'Attributes' => attributes,
      'Type' => type,
  })

  payload = @version.create(
      'POST',
      @uri,
      data: data
  )

  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.



91
92
93
94
95
96
97
98
99
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 91

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.



129
130
131
132
133
134
135
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 129

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.



63
64
65
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 63

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.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 109

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
  )
  ChannelPage.new(@version, response, @solution)
end

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

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



79
80
81
82
83
84
85
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 79

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



139
140
141
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 139

def to_s
  '#<Twilio.IpMessaging.V1.ChannelList>'
end