Class: Twilio::REST::Preview::Proxy::ServiceContext::SessionContext::ParticipantList

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

Initialize the ParticipantList



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

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]}/Participants"
end

Instance Method Details

#create(identifier: nil, friendly_name: :unset, participant_type: :unset) ⇒ ParticipantInstance

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



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/participant.rb', line 145

def create(identifier: nil, friendly_name: :unset, participant_type: :unset)
  data = Twilio::Values.of({
      'Identifier' => identifier,
      'FriendlyName' => friendly_name,
      'ParticipantType' => participant_type,
  })

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

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

#each ⇒ Object

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



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

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



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

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

#list(identifier: :unset, participant_type: :unset, limit: nil, page_size: nil) ⇒ Array

Lists ParticipantInstance 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
48
49
50
51
52
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/participant.rb', line 45

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

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

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



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

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

#stream(identifier: :unset, participant_type: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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



69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/participant.rb', line 69

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

  page = self.page(
      identifier: identifier,
      participant_type: participant_type,
      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



168
169
170
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/participant.rb', line 168

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