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

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) (defaults to: nil) —

    The unique SID identifier of the Service.

  • session_sid (String) (defaults to: nil) —

    The unique SID identifier of the Session.



22
23
24
25
26
27
28
29
30
31
 
# 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.

Parameters:

  • identifier (String) (defaults to: nil) —

    The Participant’s contact identifier, normally a phone number.

  • friendly_name (String) (defaults to: :unset) —

    A human readable description of this resource, up to 64 characters.

  • participant_type (participant.ParticipantType) (defaults to: :unset) —

    The Type of this Participant. One of ‘sms`, `voice` or `phone`.

Returns:



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/participant.rb', line 150

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.



88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/participant.rb', line 88

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of ParticipantInstance



132
133
134
135
136
137
138
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/participant.rb', line 132

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.

Parameters:

  • identifier (String) (defaults to: :unset) —

    The Participant’s contact identifier, normally a phone number.

  • participant_type (participant.ParticipantType) (defaults to: :unset) —

    The Type of this Participant. One of ‘sms`, `voice` or `phone`.

  • 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



48
49
50
51
52
53
54
55
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/participant.rb', line 48

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.

Parameters:

  • identifier (String) (defaults to: :unset) —

    The Participant’s contact identifier, normally a phone number.

  • participant_type (participant.ParticipantType) (defaults to: :unset) —

    The Type of this Participant. One of ‘sms`, `voice` or `phone`.

  • 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 ParticipantInstance



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

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.

Parameters:

  • identifier (String) (defaults to: :unset) —

    The Participant’s contact identifier, normally a phone number.

  • participant_type (participant.ParticipantType) (defaults to: :unset) —

    The Type of this Participant. One of ‘sms`, `voice` or `phone`.

  • 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



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

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



173
174
175
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/participant.rb', line 173

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