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

Parameters:

  • version (Version) —

    Version that contains the resource



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

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.



125
126
127
128
129
130
131
132
133
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 125

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



170
171
172
173
174
175
176
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 170

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.

Parameters:

  • status (Status) (defaults to: :unset) —

    Read only the participants with this status. Can be: connected or disconnected. For in-progress Rooms the default Status is connected, for completed Rooms only disconnected Participants are returned.

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

    Read only the Participants with this [User](www.twilio.com/docs/chat/rest/user-resource) identity value.

  • date_created_after (Time) (defaults to: :unset) —

    Read only Participants that started after this date in [ISO 8601](en.wikipedia.org/wiki/ISO_8601#UTC) format.

  • date_created_before (Time) (defaults to: :unset) —

    Read only Participants that started before this date in [ISO 8601](en.wikipedia.org/wiki/ISO_8601#UTC) format.

  • 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



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

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

#list_with_metadata(status: :unset, identity: :unset, date_created_after: :unset, date_created_before: :unset, limit: nil, page_size: nil) ⇒ Array

Returns Array of up to limit results.

Parameters:

  • 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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 104

def list_with_metadata(status: :unset, identity: :unset, date_created_after: :unset, date_created_before: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'Status' => status,
        'Identity' => identity,
        'DateCreatedAfter' =>  Twilio.serialize_iso8601_datetime(date_created_after),
        'DateCreatedBefore' =>  Twilio.serialize_iso8601_datetime(date_created_before),
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

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

Parameters:

  • status (Status) (defaults to: :unset) —

    Read only the participants with this status. Can be: connected or disconnected. For in-progress Rooms the default Status is connected, for completed Rooms only disconnected Participants are returned.

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

    Read only the Participants with this [User](www.twilio.com/docs/chat/rest/user-resource) identity value.

  • date_created_after (Time) (defaults to: :unset) —

    Read only Participants that started after this date in [ISO 8601](en.wikipedia.org/wiki/ISO_8601#UTC) format.

  • date_created_before (Time) (defaults to: :unset) —

    Read only Participants that started before this date in [ISO 8601](en.wikipedia.org/wiki/ISO_8601#UTC) format.

  • 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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 146

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

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

    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.

Parameters:

  • status (Status) (defaults to: :unset) —

    Read only the participants with this status. Can be: connected or disconnected. For in-progress Rooms the default Status is connected, for completed Rooms only disconnected Participants are returned.

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

    Read only the Participants with this [User](www.twilio.com/docs/chat/rest/user-resource) identity value.

  • date_created_after (Time) (defaults to: :unset) —

    Read only Participants that started after this date in [ISO 8601](en.wikipedia.org/wiki/ISO_8601#UTC) format.

  • date_created_before (Time) (defaults to: :unset) —

    Read only Participants that started before this date in [ISO 8601](en.wikipedia.org/wiki/ISO_8601#UTC) format.

  • 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



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

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



181
182
183
 
# File 'lib/twilio-ruby/rest/video/v1/room/participant.rb', line 181

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