Class: Twilio::REST::Preview::Proxy::ServiceContext::SessionList

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

Initialize the SessionList



20
21
22
23
24
25
26
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session.rb', line 20

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

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

Instance Method Details

#create(unique_name: :unset, ttl: :unset, status: :unset, participants: :unset) ⇒ SessionInstance

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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session.rb', line 139

def create(unique_name: :unset, ttl: :unset, status: :unset, participants: :unset)
  data = Twilio::Values.of({
      'UniqueName' => unique_name,
      'Ttl' => ttl,
      'Status' => status,
      'Participants' => Twilio.serialize_list(participants) { |e| e },
  })

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

  SessionInstance.new(@version, payload, service_sid: @solution[:service_sid], )
end

#each ⇒ Object

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



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

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



119
120
121
122
123
124
125
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session.rb', line 119

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

#list(unique_name: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Array

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



44
45
46
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session.rb', line 44

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

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

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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session.rb', line 98

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

#stream(unique_name: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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



64
65
66
67
68
69
70
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session.rb', line 64

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

  page = self.page(unique_name: unique_name, status: status, 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



158
159
160
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session.rb', line 158

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