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

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

Initialize the ParticipantList

Parameters:



26
27
28
29
30
31
32
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.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]}/Participants"
end

Instance Method Details

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

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

Parameters:

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

    The phone number of this Participant.

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

    A human-readable description of this resource, up to 64 characters. Should not include PII.

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

    The proxy phone number to use for this Participant. If not specified, Proxy will select a number from the pool.

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

    The proxy_identifier_sid

Returns:



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 130

def create(identifier: nil, friendly_name: :unset, proxy_identifier: :unset, proxy_identifier_sid: :unset)
  data = Twilio::Values.of({
      'Identifier' => identifier,
      'FriendlyName' => friendly_name,
      'ProxyIdentifier' => proxy_identifier,
      'ProxyIdentifierSid' => proxy_identifier_sid,
  })

  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.



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

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



112
113
114
115
116
117
118
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 112

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

#list(identifier: :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 identifier

  • 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



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

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

#page(identifier: :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 identifier

  • 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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 92

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

#stream(identifier: :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 identifier

  • 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



62
63
64
65
66
67
68
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 62

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

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



154
155
156
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 154

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