Class: Twilio::REST::Insights::V1::ConferenceContext::ConferenceParticipantList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, conference_sid: nil) ⇒ ConferenceParticipantList

Initialize the ConferenceParticipantList

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The unique SID identifier of the Conference.


20
21
22
23
24
25
26
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 20

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

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

Instance Method Details

#each ⇒ Object

When passed a block, yields ConferenceParticipantInstance 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/insights/v1/conference/conference_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 ConferenceParticipantInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of ConferenceParticipantInstance


126
127
128
129
130
131
132
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 126

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

#list(participant_sid: :unset, label: :unset, events: :unset, limit: nil, page_size: nil) ⇒ Array

Lists ConferenceParticipantInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.

Parameters:

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

    The unique SID identifier of the Participant.

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

    User-specified label for a participant.

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

    Conference events generated by application or participant activity; e.g. `hold`, `mute`, etc.

  • 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


43
44
45
46
47
48
49
50
51
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 43

def list(participant_sid: :unset, label: :unset, events: :unset, limit: nil, page_size: nil)
  self.stream(
      participant_sid: participant_sid,
      label: label,
      events: events,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(participant_sid: :unset, label: :unset, events: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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

Parameters:

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

    The unique SID identifier of the Participant.

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

    User-specified label for a participant.

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

    Conference events generated by application or participant activity; e.g. `hold`, `mute`, etc.

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


106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 106

def page(participant_sid: :unset, label: :unset, events: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'ParticipantSid' => participant_sid,
      'Label' => label,
      'Events' => events,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

  response = @version.page('GET', @uri, params: params)

  ConferenceParticipantPage.new(@version, response, @solution)
end

#stream(participant_sid: :unset, label: :unset, events: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

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

    The unique SID identifier of the Participant.

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

    User-specified label for a participant.

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

    Conference events generated by application or participant activity; e.g. `hold`, `mute`, etc.

  • 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


68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 68

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

  page = self.page(
      participant_sid: participant_sid,
      label: label,
      events: events,
      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


136
137
138
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 136

def to_s
  '#<Twilio.Insights.V1.ConferenceParticipantList>'
end