node-echo v0.1.9

Display Filters

class FeedsAPI

Feeds API for Echo

Constructor

Constructor Parameters Returns
FeedsAPI( parameters )

Parameters:

  • parameters <Object> object for options
    • parameters.consumerKey
    • parameters.consumerSecret
    • parameters.authMethod : optional, in ['oauth','basic']. Default 'oauth'

Methods

Methods Returns Description
list( callback ) void ↑ list all feeds attached to this consumer key

Parameters:

  • callback <function> callback
register( feed, callback ) void ↑ Register a new feed for a consumer key

Parameters:

  • feed <object> feed to register. Specify:
    • feed.url : (mandatory) url of the new feed
    • feed.interval : (optional) interval for polling the feed
    • callback <function> callback
unregister( feed, callback ) void ↑ Unregister a feed for a consumer key

Parameters:

  • feed <object> feed to unregister. Specify:
    • feed.url : (mandatory) url of the feed
  • callback <function> callback