Module: Feedlr::Gateway::Mixes

Included in:
Client
Defined in:
lib/feedlr/gateway/mixes.rb

Overview

Mixes API

See Also:

Instance Method Summary collapse

Instance Method Details

#stream_most_engaging(stream_id, options = {}) ⇒ Feedlr::Base

Get a mix of the most engaging content available in a stream

Parameters:

  • stream_id (String)
  • options (Hash) (defaults to: {})

Options Hash (options):

  • :count (String) —

    number of entry ids to return. default is 3. max is 20

  • :unreadOnly (String) —

    boolean default value is false

  • :hours (String) —

    hour of the day

  • :newerThan (String) —

    timestamp in ms

  • :backfill (String) —

    if "hours" is provided, and there aren't enough articles to match the entry count requested, the server will look back in time to find more articles. Articles from the first n hours will be returned first

  • :locale (String) —

    preferred locale for results

Returns:

See Also:



23
24
25
26
 
# File 'lib/feedlr/gateway/mixes.rb', line 23

def stream_most_engaging(stream_id , options = {})
  build_object(:get, '/mixes/contents',
               { streamId: stream_id }.merge(options))
end