Class: Twilio::REST::Media::V1::PlayerStreamerList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ PlayerStreamerList

Initialize the PlayerStreamerList

Parameters:

  • version (Version) —

    Version that contains the resource



18
19
20
21
22
23
24
 
# File 'lib/twilio-ruby/rest/media/v1/player_streamer.rb', line 18

def initialize(version)
  super(version)

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

Instance Method Details

#create(video: :unset, status_callback: :unset, status_callback_method: :unset) ⇒ PlayerStreamerInstance

Create the PlayerStreamerInstance

Parameters:

  • video (Boolean) (defaults to: :unset) —

    Specifies whether the PlayerStreamer is configured to stream video. Defaults to ‘true`.

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

    The URL to which Twilio will send asynchronous webhook requests for every PlayerStreamer event. See Status Callbacks for more details.

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

    The HTTP method Twilio should use to call the ‘status_callback` URL. Can be `POST` or `GET` and the default is `POST`.

Returns:



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/twilio-ruby/rest/media/v1/player_streamer.rb', line 36

def create(video: :unset, status_callback: :unset, status_callback_method: :unset)
  data = Twilio::Values.of({
      'Video' => video,
      'StatusCallback' => status_callback,
      'StatusCallbackMethod' => status_callback_method,
  })

  payload = @version.create('POST', @uri, data: data)

  PlayerStreamerInstance.new(@version, payload, )
end

#each ⇒ Object

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



96
97
98
99
100
101
102
103
104
 
# File 'lib/twilio-ruby/rest/media/v1/player_streamer.rb', line 96

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of PlayerStreamerInstance



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

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

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

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

Parameters:

  • order (player_streamer.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 (player_streamer.Status) (defaults to: :unset) —

    Status to filter by, with possible values ‘created`, `started`, `ended`, or `failed`.

  • 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



64
65
66
 
# File 'lib/twilio-ruby/rest/media/v1/player_streamer.rb', line 64

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

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

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

Parameters:

  • order (player_streamer.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 (player_streamer.Status) (defaults to: :unset) —

    Status to filter by, with possible values ‘created`, `started`, `ended`, or `failed`.

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



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

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

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

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

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

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

Parameters:

  • order (player_streamer.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 (player_streamer.Status) (defaults to: :unset) —

    Status to filter by, with possible values ‘created`, `started`, `ended`, or `failed`.

  • 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



84
85
86
87
88
89
90
 
# File 'lib/twilio-ruby/rest/media/v1/player_streamer.rb', line 84

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

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



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

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