class Twilio::REST::FlexApi::V1::WebChannelList
Public Class Methods
Initialize the WebChannelList
@param [Version] version Version
that contains the resource @return [WebChannelList] WebChannelList
Twilio::REST::ListResource::new
# File lib/twilio-ruby/rest/flex_api/v1/web_channel.rb 18 def initialize(version) 19 super(version) 20 21 # Path Solution 22 @solution = {} 23 @uri = "/WebChannels" 24 end
Public Instance Methods
Create the WebChannelInstance
@param [String] flex_flow_sid The SID of the Flex Flow. @param [String] identity The chat identity. @param [String] customer_friendly_name The chat participant's friendly name. @param [String] chat_friendly_name The chat channel's friendly name. @param [String] chat_unique_name The chat channel's unique name. @param [String] pre_engagement_data The pre-engagement data. @return [WebChannelInstance] Created WebChannelInstance
# File lib/twilio-ruby/rest/flex_api/v1/web_channel.rb 115 def create(flex_flow_sid: nil, identity: nil, customer_friendly_name: nil, chat_friendly_name: nil, chat_unique_name: :unset, pre_engagement_data: :unset) 116 data = Twilio::Values.of({ 117 'FlexFlowSid' => flex_flow_sid, 118 'Identity' => identity, 119 'CustomerFriendlyName' => customer_friendly_name, 120 'ChatFriendlyName' => chat_friendly_name, 121 'ChatUniqueName' => chat_unique_name, 122 'PreEngagementData' => pre_engagement_data, 123 }) 124 125 payload = @version.create('POST', @uri, data: data) 126 127 WebChannelInstance.new(@version, payload, ) 128 end
When passed a block, yields WebChannelInstance
records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
# File lib/twilio-ruby/rest/flex_api/v1/web_channel.rb 64 def each 65 limits = @version.read_limits 66 67 page = self.page(page_size: limits[:page_size], ) 68 69 @version.stream(page, 70 limit: limits[:limit], 71 page_limit: limits[:page_limit]).each {|x| yield x} 72 end
Retrieve a single page of WebChannelInstance
records from the API. Request
is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page
of WebChannelInstance
# File lib/twilio-ruby/rest/flex_api/v1/web_channel.rb 98 def get_page(target_url) 99 response = @version.domain.request( 100 'GET', 101 target_url 102 ) 103 WebChannelPage.new(@version, response, @solution) 104 end
Lists WebChannelInstance
records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [Integer] limit Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit
@param [Integer] page_size Number of records to fetch per request, when
not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
@return [Array] Array of up to limit results
# File lib/twilio-ruby/rest/flex_api/v1/web_channel.rb 37 def list(limit: nil, page_size: nil) 38 self.stream(limit: limit, page_size: page_size).entries 39 end
Retrieve a single page of WebChannelInstance
records from the API. Request
is executed immediately. @param [String] page_token PageToken provided by the API @param [Integer] page_number Page
Number, this value is simply for client state @param [Integer] page_size Number of records to return, defaults to 50 @return [Page] Page
of WebChannelInstance
# File lib/twilio-ruby/rest/flex_api/v1/web_channel.rb 81 def page(page_token: :unset, page_number: :unset, page_size: :unset) 82 params = Twilio::Values.of({ 83 'PageToken' => page_token, 84 'Page' => page_number, 85 'PageSize' => page_size, 86 }) 87 88 response = @version.page('GET', @uri, params: params) 89 90 WebChannelPage.new(@version, response, @solution) 91 end
Streams WebChannelInstance
records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [Integer] limit Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit.
@param [Integer] page_size Number of records to fetch per request, when
not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
@return [Enumerable] Enumerable that will yield up to limit results
# File lib/twilio-ruby/rest/flex_api/v1/web_channel.rb 52 def stream(limit: nil, page_size: nil) 53 limits = @version.read_limits(limit, page_size) 54 55 page = self.page(page_size: limits[:page_size], ) 56 57 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) 58 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/flex_api/v1/web_channel.rb 132 def to_s 133 '#<Twilio.FlexApi.V1.WebChannelList>' 134 end