Class: Twilio::REST::Preview::Proxy::ServiceContext::SessionContext::ParticipantContext::MessageInteractionList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/proxy/service/session/participant/message_interaction.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil, session_sid: nil, participant_sid: nil) ⇒ MessageInteractionList

Initialize the MessageInteractionList

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) (defaults to: nil) —

    The unique SID identifier of the Service.

  • session_sid (String) (defaults to: nil) —

    The unique SID identifier of the Session.

  • participant_sid (String) (defaults to: nil) —

    The participant_sid



24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/participant/message_interaction.rb', line 24

def initialize(version, service_sid: nil, session_sid: nil, participant_sid: nil)
  super(version)

  # Path Solution
  @solution = {
      service_sid: service_sid,
      session_sid: session_sid,
      participant_sid: participant_sid
  }
  @uri = "/Services/#{@solution[:service_sid]}/Sessions/#{@solution[:session_sid]}/Participants/#{@solution[:participant_sid]}/MessageInteractions"
end

Instance Method Details

#create(body: :unset, media_url: :unset) ⇒ MessageInteractionInstance

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

Parameters:

  • body (String) (defaults to: :unset) —

    The text body of the message to send to the Participant. Up to 1600 characters long.

  • media_url (String) (defaults to: :unset) —

    The public url of an image or video to send to the Participant.

Returns:



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/participant/message_interaction.rb', line 44

def create(body: :unset, media_url: :unset)
  data = Twilio::Values.of({
      'Body' => body,
      'MediaUrl' => media_url,
  })

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

  MessageInteractionInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      session_sid: @solution[:session_sid],
      participant_sid: @solution[:participant_sid],
  )
end

#each ⇒ Object

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



108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/participant/message_interaction.rb', line 108

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 MessageInteractionInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of MessageInteractionInstance



146
147
148
149
150
151
152
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/participant/message_interaction.rb', line 146

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  MessageInteractionPage.new(@version, response, @solution)
end

#list(limit: nil, page_size: nil) ⇒ Array

Lists MessageInteractionInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    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)

Returns:

  • (Array) —

    Array of up to limit results



76
77
78
79
80
81
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/participant/message_interaction.rb', line 76

def list(limit: nil, page_size: nil)
  self.stream(
      limit: limit,
      page_size: page_size
  ).entries
end

#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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

Parameters:

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of MessageInteractionInstance



127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/participant/message_interaction.rb', line 127

def page(page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  MessageInteractionPage.new(@version, response, @solution)
end

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

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

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil) —

    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)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



94
95
96
97
98
99
100
101
102
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/participant/message_interaction.rb', line 94

def stream(limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      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



156
157
158
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/participant/message_interaction.rb', line 156

def to_s
  '#<Twilio.Preview.Proxy.MessageInteractionList>'
end