Class: Twilio::REST::Video::V1::RoomContext::RoomRecordingList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, room_sid: nil) ⇒ RoomRecordingList

Initialize the RoomRecordingList



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

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

  # Path Solution
  @solution = {room_sid: room_sid}
  @uri = "/Rooms/#{@solution[:room_sid]}/Recordings"
end

Instance Method Details

#each ⇒ Object

When passed a block, yields RoomRecordingInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



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

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 RoomRecordingInstance records from the API. Request is executed immediately.



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

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

#list(status: :unset, source_sid: :unset, date_created_after: :unset, date_created_before: :unset, limit: nil, page_size: nil) ⇒ Array

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



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

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

#page(status: :unset, source_sid: :unset, date_created_after: :unset, date_created_before: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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



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

def page(status: :unset, source_sid: :unset, date_created_after: :unset, date_created_before: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'Status' => status,
      'SourceSid' => source_sid,
      '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)

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

#stream(status: :unset, source_sid: :unset, date_created_after: :unset, date_created_before: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams RoomRecordingInstance 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
88
 
# File 'lib/twilio-ruby/rest/video/v1/room/recording.rb', line 76

def stream(status: :unset, source_sid: :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,
      source_sid: source_sid,
      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



149
150
151
 
# File 'lib/twilio-ruby/rest/video/v1/room/recording.rb', line 149

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