Module: Feedlr::Gateway::Streams

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

Overview

Streams API

Instance Method Summary collapse

Instance Method Details

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

Get the content of a stream

Parameters:

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

Options Hash (options):

  • :count (String)

    mber of entry ids to return. default is 20. max is 10 , 000

  • :ranked (String)

    newest or oldest. default is newest

  • :unreadOnly (String)

    boolean default value is false

  • :newerThan (String)

    timestamp in ms

  • :continuation (String)

    a continuation id is used to page through the entry ids

Returns:

See Also:



36
37
38
39
# File 'lib/feedlr/gateway/streams.rb', line 36

def stream_entries_contents(stream_id , options = {})
  build_object(:get, "/streams/#{CGI.escape(stream_id)}/contents",
               options)
end

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

Get a list of entry ids for a specific stream

Parameters:

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

Options Hash (options):

  • :count (String)

    mber of entry ids to return. default is 20. max is 10,000

  • :ranked (String)

    newest or oldest. default is newest

  • :unreadOnly (String)

    boolean default value is false

  • :newerThan (String)

    timestamp in ms

  • :continuation (String)

    a continuation id is used to page through the entry ids

Returns:

See Also:



20
21
22
# File 'lib/feedlr/gateway/streams.rb', line 20

def stream_entries_ids(stream_id , options = {})
  build_object(:get , "/streams/#{CGI.escape(stream_id) }/ids" , options)
end