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

Parameters:

  • version (Version)

    Version that contains the resource

  • service_sid (String) (defaults to: nil)

    The SID of the parent Service resource.

  • session_sid (String) (defaults to: nil)

    The SID of the parent Session resource.

  • participant_sid (String) (defaults to: nil)

    The SID of the Participant resource.


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

Create the MessageInteractionInstance

Parameters:

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

    The message to send to the participant

  • media_url (Array[String]) (defaults to: :unset)

    Reserved. Not currently supported.

Returns:


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

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

#eachObject

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


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

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


128
129
130
131
132
133
134
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 128

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


67
68
69
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 67

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


111
112
113
114
115
116
117
118
119
120
121
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 111

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: 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


82
83
84
85
86
87
88
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 82

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_sObject

Provide a user friendly representation


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

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