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



28
29
30
31
32
33
34
35
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 28

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.



119
120
121
122
123
124
125
126
127
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 119

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.



162
163
164
165
166
167
168
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 162

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.



51
52
53
54
55
56
57
58
59
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 51

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

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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 99

def list_with_metadata(participant_sid: :unset, label: :unset, events: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'ParticipantSid' => participant_sid,
        'Label' => label,
        'Events' => events,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

    ConferenceParticipantPageMetadata.new(@version, response, @solution, limits[:limit])
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.



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 139

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,
    })
    headers = Twilio::Values.of({})
    
    

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

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

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

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



75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 75

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



173
174
175
 
# File 'lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb', line 173

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