Class: Twilio::REST::Video::V1::RoomContext::ParticipantList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/video/v1/room/participant.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, room_sid: nil) ⇒ ParticipantList

Initialize the ParticipantList



27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 27

def initialize(version, room_sid: nil)
    super(version)
    # Path Solution
    @solution = { room_sid: room_sid }
    @uri = "/Rooms/#{@solution[:room_sid]}/Participants"
    
end

Instance Method Details

#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.



93
94
95
96
97
98
99
100
101
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 93

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.



140
141
142
143
144
145
146
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 140

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

#list(status: :unset, identity: :unset, date_created_after: :unset, date_created_before: :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.



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 50

def list(status: :unset, identity: :unset, date_created_after: :unset, date_created_before: :unset, limit: nil, page_size: nil)
    self.stream(
        status: status,
        identity: identity,
        date_created_after: date_created_after,
        date_created_before: date_created_before,
        limit: limit,
        page_size: page_size
    ).entries
end

#page(status: :unset, identity: :unset, date_created_after: :unset, date_created_before: :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.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 114

def page(status: :unset, identity: :unset, date_created_after: :unset, date_created_before: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        
        'Status' => status,
        
        'Identity' => identity,
        
        'DateCreatedAfter' =>  Twilio.serialize_iso8601_datetime(date_created_after),
        
        'DateCreatedBefore' =>  Twilio.serialize_iso8601_datetime(date_created_before),
        
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })

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

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

#stream(status: :unset, identity: :unset, date_created_after: :unset, date_created_before: :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.



76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 76

def stream(status: :unset, identity: :unset, date_created_after: :unset, date_created_before: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        status: status,
        identity: identity,
        date_created_after: date_created_after,
        date_created_before: date_created_before,
        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



151
152
153
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 151

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