Class: Twilio::REST::Api::V2010::AccountContext::ConferenceContext::ParticipantList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil, conference_sid: nil) ⇒ ParticipantList

Initialize the ParticipantList

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The unique id of the [Account](www.twilio.com/docs/api/rest/account) that created this conference

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

    A 34 character string that identifies the conference this participant is in



25
26
27
28
29
30
31
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 25

def initialize(version, account_sid: nil, conference_sid: nil)
  super(version)

  # Path Solution
  @solution = {account_sid: , conference_sid: conference_sid}
  @uri = "/Accounts/#{@solution[:account_sid]}/Conferences/#{@solution[:conference_sid]}/Participants.json"
end

Instance Method Details

#create(from: nil, to: nil, status_callback: :unset, status_callback_method: :unset, status_callback_event: :unset, timeout: :unset, record: :unset, muted: :unset, beep: :unset, start_conference_on_enter: :unset, end_conference_on_exit: :unset, wait_url: :unset, wait_method: :unset, early_media: :unset, max_participants: :unset, conference_record: :unset, conference_trim: :unset, conference_status_callback: :unset, conference_status_callback_method: :unset, conference_status_callback_event: :unset, recording_channels: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, sip_auth_username: :unset, sip_auth_password: :unset, region: :unset, conference_recording_status_callback: :unset, conference_recording_status_callback_method: :unset, recording_status_callback_event: :unset, conference_recording_status_callback_event: :unset) ⇒ ParticipantInstance

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

Parameters:

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

    number, client id

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

    number, client id, sip address

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

    absolute url

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

    GET, POST

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

    initiated, ringing, answered, completed

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

    5-600

  • record (Boolean) (defaults to: :unset) —

    true, false

  • muted (Boolean) (defaults to: :unset) —

    true, false

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

    true, false, onEnter, onExit

  • start_conference_on_enter (Boolean) (defaults to: :unset) —

    true, false

  • end_conference_on_exit (Boolean) (defaults to: :unset) —

    true, false

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

    absolute url

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

    GET, POST

  • early_media (Boolean) (defaults to: :unset) —

    true, false

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

    2-10

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

    true, false, record-from-start, do-not-record

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

    trim-silence or do-not-trim

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

    absolute url

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

    GET, POST

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

    start end join leave mute hold speaker

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

    mono, dual

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

    absolute url

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

    GET, POST

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

    sip username

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

    sip password

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

    us1, ie1, de1, sg1, br1, au1, jp1

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

    absolute url

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

    GET, POST

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

    The recording_status_callback_event

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

    The conference_recording_status_callback_event

Returns:



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 70

def create(from: nil, to: nil, status_callback: :unset, status_callback_method: :unset, status_callback_event: :unset, timeout: :unset, record: :unset, muted: :unset, beep: :unset, start_conference_on_enter: :unset, end_conference_on_exit: :unset, wait_url: :unset, wait_method: :unset, early_media: :unset, max_participants: :unset, conference_record: :unset, conference_trim: :unset, conference_status_callback: :unset, conference_status_callback_method: :unset, conference_status_callback_event: :unset, recording_channels: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, sip_auth_username: :unset, sip_auth_password: :unset, region: :unset, conference_recording_status_callback: :unset, conference_recording_status_callback_method: :unset, recording_status_callback_event: :unset, conference_recording_status_callback_event: :unset)
  data = Twilio::Values.of({
      'From' => from,
      'To' => to,
      'StatusCallback' => status_callback,
      'StatusCallbackMethod' => status_callback_method,
      'StatusCallbackEvent' => Twilio.serialize_list(status_callback_event) { |e| e },
      'Timeout' => timeout,
      'Record' => record,
      'Muted' => muted,
      'Beep' => beep,
      'StartConferenceOnEnter' => start_conference_on_enter,
      'EndConferenceOnExit' => end_conference_on_exit,
      'WaitUrl' => wait_url,
      'WaitMethod' => wait_method,
      'EarlyMedia' => early_media,
      'MaxParticipants' => max_participants,
      'ConferenceRecord' => conference_record,
      'ConferenceTrim' => conference_trim,
      'ConferenceStatusCallback' => conference_status_callback,
      'ConferenceStatusCallbackMethod' => conference_status_callback_method,
      'ConferenceStatusCallbackEvent' => Twilio.serialize_list(conference_status_callback_event) { |e| e },
      'RecordingChannels' => recording_channels,
      'RecordingStatusCallback' => recording_status_callback,
      'RecordingStatusCallbackMethod' => recording_status_callback_method,
      'SipAuthUsername' => sip_auth_username,
      'SipAuthPassword' => sip_auth_password,
      'Region' => region,
      'ConferenceRecordingStatusCallback' => conference_recording_status_callback,
      'ConferenceRecordingStatusCallbackMethod' => conference_recording_status_callback_method,
      'RecordingStatusCallbackEvent' => Twilio.serialize_list(recording_status_callback_event) { |e| e },
      'ConferenceRecordingStatusCallbackEvent' => Twilio.serialize_list(conference_recording_status_callback_event) { |e| e },
  })

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

  ParticipantInstance.new(
      @version,
      payload,
      account_sid: @solution[:account_sid],
      conference_sid: @solution[:conference_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.



164
165
166
167
168
169
170
171
172
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 164

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



206
207
208
209
210
211
212
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 206

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

#list(muted: :unset, hold: :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:

  • muted (Boolean) (defaults to: :unset) —

    Only show participants that are muted or unmuted. Either ‘true` or `false`.

  • hold (Boolean) (defaults to: :unset) —

    Only show participants that are held or unheld. Either ‘true` or `false`.

  • 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



133
134
135
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 133

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

#page(muted: :unset, hold: :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:

  • muted (Boolean) (defaults to: :unset) —

    Only show participants that are muted or unmuted. Either ‘true` or `false`.

  • hold (Boolean) (defaults to: :unset) —

    Only show participants that are held or unheld. Either ‘true` or `false`.

  • 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



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 185

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

#stream(muted: :unset, hold: :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:

  • muted (Boolean) (defaults to: :unset) —

    Only show participants that are muted or unmuted. Either ‘true` or `false`.

  • hold (Boolean) (defaults to: :unset) —

    Only show participants that are held or unheld. Either ‘true` or `false`.

  • 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



152
153
154
155
156
157
158
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 152

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

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



216
217
218
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb', line 216

def to_s
  '#<Twilio.Api.V2010.ParticipantList>'
end