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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, room_sid: nil) ⇒ ParticipantList

Initialize the ParticipantList



20
21
22
23
24
25
26
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant.rb', line 20

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.



99
100
101
102
103
104
105
106
107
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant.rb', line 99

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.



147
148
149
150
151
152
153
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant.rb', line 147

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.



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

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.



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant.rb', line 126

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 ParticipantInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant.rb', line 81

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



157
158
159
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant.rb', line 157

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