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

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

Overview

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

Instance Method Summary collapse

Constructor Details

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

Initialize the MessageInteractionList



29
30
31
32
33
34
35
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 29

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.



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

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

  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.



99
100
101
102
103
104
105
106
107
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 99

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.



135
136
137
138
139
140
141
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 135

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.



72
73
74
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 72

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.



116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 116

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.



87
88
89
90
91
92
93
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 87

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



145
146
147
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 145

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