The Javascript API is designed to closely follow the design of the
Newsgator API (note - the newsgator api documentation is required reading to understand this library), it has the same main objects - Locations, Folders, Subscriptions, Feeds, and Posts. It also has a Newsgator object which is the application entry point.
Currently only GET operations are supported i.e. you cannot modify (subscribe, delete, mark as read etc) the aggregator.
The api is designed to be used asynchronously, using
Mochkit's
Signals library. This library has a very simple syntax connect(object, event, handler), handler can be designated as either a function, an object and the name of a method of that object, or an object and a function. With the last two the function is called with the
this pointer set to the object.