Class: Twilio::REST::Chat::V1::ServiceContext::ChannelList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Chat::V1::ServiceContext::ChannelList
- Defined in:
- lib/twilio-ruby/rest/chat/v1/service/channel.rb
Instance Method Summary collapse
-
#create(friendly_name: :unset, unique_name: :unset, attributes: :unset, type: :unset) ⇒ ChannelInstance
Create the ChannelInstance.
-
#each ⇒ Object
When passed a block, yields ChannelInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of ChannelInstance records from the API.
-
#initialize(version, service_sid: nil) ⇒ ChannelList
constructor
Initialize the ChannelList.
-
#list(type: :unset, limit: nil, page_size: nil) ⇒ Array
Lists ChannelInstance records from the API as a list.
-
#page(type: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of ChannelInstance records from the API.
-
#stream(type: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version, service_sid: nil) ⇒ ChannelList
Initialize the ChannelList
27 28 29 30 31 32 33 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 27 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
Create the ChannelInstance
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 41 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.
110 111 112 113 114 115 116 117 118 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 110 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.
147 148 149 150 151 152 153 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 147 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.
76 77 78 79 80 81 82 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 76 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.
128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 128 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.
96 97 98 99 100 101 102 103 104 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 96 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
158 159 160 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 158 def to_s '#<Twilio.Chat.V1.ChannelList>' end |