Class: Twilio::REST::Video::V1::RoomContext::ParticipantContext::SubscribedTrackList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, room_sid: nil, subscriber_sid: nil) ⇒ SubscribedTrackList

Initialize the SubscribedTrackList



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

def initialize(version, room_sid: nil, subscriber_sid: nil)
  super(version)

  # Path Solution
  @solution = {room_sid: room_sid, subscriber_sid: subscriber_sid}
  @uri = "/Rooms/#{@solution[:room_sid]}/Participants/#{@solution[:subscriber_sid]}/SubscribedTracks"
end

Instance Method Details

#each ⇒ Object

When passed a block, yields SubscribedTrackInstance 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/room_participant/room_participant_subscribed_track.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 SubscribedTrackInstance records from the API. Request is executed immediately.



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

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

#list(date_created_after: :unset, date_created_before: :unset, track: :unset, publisher: :unset, kind: :unset, limit: nil, page_size: nil) ⇒ Array

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



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

def list(date_created_after: :unset, date_created_before: :unset, track: :unset, publisher: :unset, kind: :unset, limit: nil, page_size: nil)
  self.stream(
      date_created_after: date_created_after,
      date_created_before: date_created_before,
      track: track,
      publisher: publisher,
      kind: kind,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(date_created_after: :unset, date_created_before: :unset, track: :unset, publisher: :unset, kind: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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



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

def page(date_created_after: :unset, date_created_before: :unset, track: :unset, publisher: :unset, kind: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'DateCreatedAfter' => Twilio.serialize_iso8601_datetime(date_created_after),
      'DateCreatedBefore' => Twilio.serialize_iso8601_datetime(date_created_before),
      'Track' => track,
      'Publisher' => publisher,
      'Kind' => kind,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  SubscribedTrackPage.new(@version, response, @solution)
end

#stream(date_created_after: :unset, date_created_before: :unset, track: :unset, publisher: :unset, kind: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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



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

def stream(date_created_after: :unset, date_created_before: :unset, track: :unset, publisher: :unset, kind: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      date_created_after: date_created_after,
      date_created_before: date_created_before,
      track: track,
      publisher: publisher,
      kind: kind,
      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



178
179
180
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribed_track.rb', line 178

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

#update(track: :unset, publisher: :unset, kind: :unset, status: :unset) ⇒ SubscribedTrackInstance

Update the SubscribedTrackInstance



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribed_track.rb', line 154

def update(track: :unset, publisher: :unset, kind: :unset, status: :unset)
  data = Twilio::Values.of({
      'Track' => track,
      'Publisher' => publisher,
      'Kind' => kind,
      'Status' => status,
  })

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

  SubscribedTrackInstance.new(
      @version,
      payload,
      room_sid: @solution[:room_sid],
      subscriber_sid: @solution[:subscriber_sid],
  )
end