Class: Twilio::REST::Media::V1::MediaRecordingList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/media/v1/media_recording.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected]

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ MediaRecordingList

Initialize the MediaRecordingList

Parameters:

  • version (Version) —

    Version that contains the resource


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

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/MediaRecordings"
end

Instance Method Details

#each ⇒ Object

When passed a block, yields MediaRecordingInstance 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/media/v1/media_recording.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 MediaRecordingInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of MediaRecordingInstance


138
139
140
141
142
143
144
 
# File 'lib/twilio-ruby/rest/media/v1/media_recording.rb', line 138

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

#list(order: :unset, status: :unset, processor_sid: :unset, source_sid: :unset, limit: nil, page_size: nil) ⇒ Array

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

Parameters:

  • order (media_recording.Order) (defaults to: :unset) —

    The sort order of the list by `date_created`. Can be: `asc` (ascending) or `desc` (descending) with `desc` as the default.

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

    Status to filter by, with possible values `processing`, `completed`, `deleted`, or `failed`.

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

    SID of a MediaProcessor to filter by.

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

    SID of a MediaRecording source to filter by.

  • 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


46
47
48
49
50
51
52
53
54
55
 
# File 'lib/twilio-ruby/rest/media/v1/media_recording.rb', line 46

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

#page(order: :unset, status: :unset, processor_sid: :unset, source_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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

Parameters:

  • order (media_recording.Order) (defaults to: :unset) —

    The sort order of the list by `date_created`. Can be: `asc` (ascending) or `desc` (descending) with `desc` as the default.

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

    Status to filter by, with possible values `processing`, `completed`, `deleted`, or `failed`.

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

    SID of a MediaProcessor to filter by.

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

    SID of a MediaRecording source to filter by.

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


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

def page(order: :unset, status: :unset, processor_sid: :unset, source_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'Order' => order,
      'Status' => status,
      'ProcessorSid' => processor_sid,
      'SourceSid' => source_sid,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

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

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

#stream(order: :unset, status: :unset, processor_sid: :unset, source_sid: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

  • order (media_recording.Order) (defaults to: :unset) —

    The sort order of the list by `date_created`. Can be: `asc` (ascending) or `desc` (descending) with `desc` as the default.

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

    Status to filter by, with possible values `processing`, `completed`, `deleted`, or `failed`.

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

    SID of a MediaProcessor to filter by.

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

    SID of a MediaRecording source to filter by.

  • 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


75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/twilio-ruby/rest/media/v1/media_recording.rb', line 75

def stream(order: :unset, status: :unset, processor_sid: :unset, source_sid: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      order: order,
      status: status,
      processor_sid: processor_sid,
      source_sid: source_sid,
      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


148
149
150
 
# File 'lib/twilio-ruby/rest/media/v1/media_recording.rb', line 148

def to_s
  '#<Twilio.Media.V1.MediaRecordingList>'
end