class Twilio::REST::Proxy::V1::ServiceContext::SessionContext::ParticipantContext::MessageInteractionList

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Public Class Methods

new(version, service_sid: nil, session_sid: nil, participant_sid: nil) click to toggle source

Initialize the MessageInteractionList @param [Version] version Version that contains the resource @param [String] service_sid The SID of the parent

{Service}[https://www.twilio.com/docs/proxy/api/service] resource.

@param [String] session_sid The SID of the parent

{Session}[https://www.twilio.com/docs/proxy/api/session] resource.

@param [String] participant_sid The SID of the

{Participant}[https://www.twilio.com/docs/proxy/api/participant] resource.

@return [MessageInteractionList] MessageInteractionList

Calls superclass method Twilio::REST::ListResource::new
   # File lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb
29 def initialize(version, service_sid: nil, session_sid: nil, participant_sid: nil)
30   super(version)
31 
32   # Path Solution
33   @solution = {service_sid: service_sid, session_sid: session_sid, participant_sid: participant_sid}
34   @uri = "/Services/#{@solution[:service_sid]}/Sessions/#{@solution[:session_sid]}/Participants/#{@solution[:participant_sid]}/MessageInteractions"
35 end

Public Instance Methods

create(body: :unset, media_url: :unset) click to toggle source

Create the MessageInteractionInstance @param [String] body The message to send to the participant @param [Array] media_url Reserved. Not currently supported. @return [MessageInteractionInstance] Created MessageInteractionInstance

   # File lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb
42 def create(body: :unset, media_url: :unset)
43   data = Twilio::Values.of({'Body' => body, 'MediaUrl' => Twilio.serialize_list(media_url) { |e| e }, })
44 
45   payload = @version.create('POST', @uri, data: data)
46 
47   MessageInteractionInstance.new(
48       @version,
49       payload,
50       service_sid: @solution[:service_sid],
51       session_sid: @solution[:session_sid],
52       participant_sid: @solution[:participant_sid],
53   )
54 end
each() { |x| ... } click to toggle source

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

    # File lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb
 94 def each
 95   limits = @version.read_limits
 96 
 97   page = self.page(page_size: limits[:page_size], )
 98 
 99   @version.stream(page,
100                   limit: limits[:limit],
101                   page_limit: limits[:page_limit]).each {|x| yield x}
102 end
get_page(target_url) click to toggle source

Retrieve a single page of MessageInteractionInstance records from the API. Request is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page of MessageInteractionInstance

    # File lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb
128 def get_page(target_url)
129   response = @version.domain.request(
130       'GET',
131       target_url
132   )
133   MessageInteractionPage.new(@version, response, @solution)
134 end
list(limit: nil, page_size: nil) click to toggle source

Lists MessageInteractionInstance 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/proxy/v1/service/session/participant/message_interaction.rb
67 def list(limit: nil, page_size: nil)
68   self.stream(limit: limit, page_size: page_size).entries
69 end
page(page_token: :unset, page_number: :unset, page_size: :unset) click to toggle source

Retrieve a single page of MessageInteractionInstance 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 MessageInteractionInstance

    # File lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb
111 def page(page_token: :unset, page_number: :unset, page_size: :unset)
112   params = Twilio::Values.of({
113       'PageToken' => page_token,
114       'Page' => page_number,
115       'PageSize' => page_size,
116   })
117 
118   response = @version.page('GET', @uri, params: params)
119 
120   MessageInteractionPage.new(@version, response, @solution)
121 end
stream(limit: nil, page_size: nil) click to toggle source

Streams MessageInteractionInstance 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/proxy/v1/service/session/participant/message_interaction.rb
82 def stream(limit: nil, page_size: nil)
83   limits = @version.read_limits(limit, page_size)
84 
85   page = self.page(page_size: limits[:page_size], )
86 
87   @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
88 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb
138 def to_s
139   '#<Twilio.Proxy.V1.MessageInteractionList>'
140 end