Class: Twilio::REST::Messaging::V1::SessionContext::ParticipantList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/messaging/v1/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, session_sid: nil) ⇒ ParticipantList

Initialize the ParticipantList



24
25
26
27
28
29
30
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/participant.rb', line 24

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

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

Instance Method Details

#create(attributes: :unset, twilio_address: :unset, date_created: :unset, date_updated: :unset, identity: :unset, user_address: :unset) ⇒ ParticipantInstance

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/participant.rb', line 58

def create(attributes: :unset, twilio_address: :unset, date_created: :unset, date_updated: :unset, identity: :unset, user_address: :unset)
  data = Twilio::Values.of({
      'Identity' => identity,
      'UserAddress' => user_address,
      'Attributes' => attributes,
      'TwilioAddress' => twilio_address,
      'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
      'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
  })

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

  ParticipantInstance.new(@version, payload, 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.



115
116
117
118
119
120
121
122
123
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/participant.rb', line 115

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.



151
152
153
154
155
156
157
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/participant.rb', line 151

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

#list(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.



88
89
90
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/participant.rb', line 88

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



132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/participant.rb', line 132

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

#stream(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.



103
104
105
106
107
108
109
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/participant.rb', line 103

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



161
162
163
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/participant.rb', line 161

def to_s
  '#<Twilio.Messaging.V1.ParticipantList>'
end