Class: Twilio::REST::Proxy::V1::ServiceContext::SessionContext::InteractionList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/proxy/v1/service/session/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) ⇒ InteractionList

Initialize the InteractionList



26
27
28
29
30
31
32
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 26

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

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

Instance Method Details

#each ⇒ Object

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



72
73
74
75
76
77
78
79
80
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 72

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



108
109
110
111
112
113
114
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 108

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

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

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



45
46
47
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 45

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



89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 89

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
  )
  InteractionPage.new(@version, response, @solution)
end

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

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



60
61
62
63
64
65
66
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 60

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



118
119
120
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 118

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