class Twilio::REST::Studio::V1::FlowContext::EngagementList
Public Class Methods
Initialize the EngagementList
@param [Version] version Version
that contains the resource @param [String] flow_sid The SID of the Flow. @return [EngagementList] EngagementList
Twilio::REST::ListResource::new
# File lib/twilio-ruby/rest/studio/v1/flow/engagement.rb 20 def initialize(version, flow_sid: nil) 21 super(version) 22 23 # Path Solution 24 @solution = {flow_sid: flow_sid} 25 @uri = "/Flows/#{@solution[:flow_sid]}/Engagements" 26 end
Public Instance Methods
Create the EngagementInstance
@param [String] to The Contact phone number to start a Studio
Flow Engagement,
available as variable `{{contact.channel.address}}`.
@param [String] from The Twilio
phone number to send messages or initiate calls
from during the Flow Engagement. Available as variable `{{flow.channel.address}}`
@param [Hash] parameters A JSON string we will add to your flow's context and
that you can access as variables inside your flow. For example, if you pass in `Parameters={'name':'Zeke'}` then inside a widget you can reference the variable `{{flow.data.name}}` which will return the string 'Zeke'. Note: the JSON value must explicitly be passed as a string, not as a hash object. Depending on your particular HTTP library, you may need to add quotes or URL encode your JSON string.
@return [EngagementInstance] Created EngagementInstance
# File lib/twilio-ruby/rest/studio/v1/flow/engagement.rb 123 def create(to: nil, from: nil, parameters: :unset) 124 data = Twilio::Values.of({ 125 'To' => to, 126 'From' => from, 127 'Parameters' => Twilio.serialize_object(parameters), 128 }) 129 130 payload = @version.create('POST', @uri, data: data) 131 132 EngagementInstance.new(@version, payload, flow_sid: @solution[:flow_sid], ) 133 end
When passed a block, yields EngagementInstance
records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
# File lib/twilio-ruby/rest/studio/v1/flow/engagement.rb 66 def each 67 limits = @version.read_limits 68 69 page = self.page(page_size: limits[:page_size], ) 70 71 @version.stream(page, 72 limit: limits[:limit], 73 page_limit: limits[:page_limit]).each {|x| yield x} 74 end
Retrieve a single page of EngagementInstance
records from the API. Request
is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page
of EngagementInstance
# File lib/twilio-ruby/rest/studio/v1/flow/engagement.rb 100 def get_page(target_url) 101 response = @version.domain.request( 102 'GET', 103 target_url 104 ) 105 EngagementPage.new(@version, response, @solution) 106 end
Lists EngagementInstance
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/studio/v1/flow/engagement.rb 39 def list(limit: nil, page_size: nil) 40 self.stream(limit: limit, page_size: page_size).entries 41 end
Retrieve a single page of EngagementInstance
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 EngagementInstance
# File lib/twilio-ruby/rest/studio/v1/flow/engagement.rb 83 def page(page_token: :unset, page_number: :unset, page_size: :unset) 84 params = Twilio::Values.of({ 85 'PageToken' => page_token, 86 'Page' => page_number, 87 'PageSize' => page_size, 88 }) 89 90 response = @version.page('GET', @uri, params: params) 91 92 EngagementPage.new(@version, response, @solution) 93 end
Streams EngagementInstance
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/studio/v1/flow/engagement.rb 54 def stream(limit: nil, page_size: nil) 55 limits = @version.read_limits(limit, page_size) 56 57 page = self.page(page_size: limits[:page_size], ) 58 59 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) 60 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/studio/v1/flow/engagement.rb 137 def to_s 138 '#<Twilio.Studio.V1.EngagementList>' 139 end