Class: Twilio::REST::Api::V2010::AccountContext::RecordingList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/recording.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil) ⇒ RecordingList

Initialize the RecordingList



22
23
24
25
26
27
28
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 22

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

  # Path Solution
  @solution = {account_sid: }
  @uri = "/Accounts/#{@solution[:account_sid]}/Recordings.json"
end

Instance Method Details

#each ⇒ Object

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



97
98
99
100
101
102
103
104
105
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 97

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



145
146
147
148
149
150
151
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 145

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

#list(date_created_before: :unset, date_created: :unset, date_created_after: :unset, call_sid: :unset, conference_sid: :unset, limit: nil, page_size: nil) ⇒ Array

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



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 48

def list(date_created_before: :unset, date_created: :unset, date_created_after: :unset, call_sid: :unset, conference_sid: :unset, limit: nil, page_size: nil)
  self.stream(
      date_created_before: date_created_before,
      date_created: date_created,
      date_created_after: date_created_after,
      call_sid: call_sid,
      conference_sid: conference_sid,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(date_created_before: :unset, date_created: :unset, date_created_after: :unset, call_sid: :unset, conference_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 121

def page(date_created_before: :unset, date_created: :unset, date_created_after: :unset, call_sid: :unset, conference_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'DateCreated<' => Twilio.serialize_iso8601_datetime(date_created_before),
      'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
      'DateCreated>' => Twilio.serialize_iso8601_datetime(date_created_after),
      'CallSid' => call_sid,
      'ConferenceSid' => conference_sid,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  RecordingPage.new(@version, response, @solution)
end

#stream(date_created_before: :unset, date_created: :unset, date_created_after: :unset, call_sid: :unset, conference_sid: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 78

def stream(date_created_before: :unset, date_created: :unset, date_created_after: :unset, call_sid: :unset, conference_sid: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      date_created_before: date_created_before,
      date_created: date_created,
      date_created_after: date_created_after,
      call_sid: call_sid,
      conference_sid: conference_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



155
156
157
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 155

def to_s
  '#<Twilio.Api.V2010.RecordingList>'
end