Class: Twilio::REST::Api::V2010::AccountContext::MessageContext::MediaList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil, message_sid: nil) ⇒ MediaList

Initialize the MediaList



25
26
27
28
29
30
31
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 25

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

  # Path Solution
  @solution = {account_sid: , message_sid: message_sid}
  @uri = "/Accounts/#{@solution[:account_sid]}/Messages/#{@solution[:message_sid]}/Media.json"
end

Instance Method Details

#each ⇒ Object

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



88
89
90
91
92
93
94
95
96
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 88

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



128
129
130
131
132
133
134
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 128

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

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

Lists MediaInstance 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
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 47

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

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

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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 108

def page(date_created_before: :unset, date_created: :unset, date_created_after: :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),
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

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

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

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

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



71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 71

def stream(date_created_before: :unset, date_created: :unset, date_created_after: :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,
      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



138
139
140
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message/media.rb', line 138

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