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

Parameters:

  • version (Version) —

    Version that contains the resource

  • room_sid (String) (defaults to: nil) —

    The room_sid



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

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.



87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/twilio-ruby/rest/video/v1/room/recording.rb', line 87

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of RoomRecordingInstance



133
134
135
136
137
138
139
 
# File 'lib/twilio-ruby/rest/video/v1/room/recording.rb', line 133

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.

Parameters:

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

    The status

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

    The source_sid

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

    The date_created_after

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

    The date_created_before

  • 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



43
44
45
46
47
48
49
50
51
52
 
# File 'lib/twilio-ruby/rest/video/v1/room/recording.rb', line 43

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.

Parameters:

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

    The status

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

    The source_sid

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

    The date_created_after

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

    The date_created_before

  • 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 RoomRecordingInstance



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/twilio-ruby/rest/video/v1/room/recording.rb', line 110

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

Parameters:

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

    The status

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

    The source_sid

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

    The date_created_after

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

    The date_created_before

  • 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



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/twilio-ruby/rest/video/v1/room/recording.rb', line 69

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



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

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