Class ActivityStream

Object
   |
   +--ActivityStream

class ActivityStream

The main interface for this library. Contains methods for adding activities, generating the Atom activity feed and helpers
Defined in activityStream.js

Field Detail

instance

<static> Object instance

ActivityStream

ActivityStream()

__ActivityStream.getAtom

String __ActivityStream.getAtom()

Generates and returns the atom feed with elements for the activity extension

Returns:
A string with the feed in XML format

__ActivityStream.listen

void __ActivityStream.listen()

Method for setting up listeners for Unite.

__ActivityStream.publish

void __ActivityStream.publish(<String> title, <ActivityVerbType|ActivityVerbType[]> verb, <ActivityObjectModel|ActivityObjectModel[]> object, <String> content)

Generic method for publishing an activity. Future plan is to introduce more fine grained methods for publishing activities.

Parameters:
title - the title of a specific activity
verb - either an ActivityVerbType or an array of ActivityVerbType
object - either an ActivityObjectModel or an array of ActivityObjectModel
content - the content of the activity

getAtom

String getAtom()

Generates and returns the atom feed with elements for the activity extension

Returns:
A string with the feed in XML format

listen

void listen()

Method for setting up listeners for Unite.

publish

void publish(<String> title, <ActivityVerbType|ActivityVerbType[]> verb, <ActivityObjectModel|ActivityObjectModel[]> object, <String> content)

Generic method for publishing an activity. Future plan is to introduce more fine grained methods for publishing activities.

Parameters:
title - the title of a specific activity
verb - either an ActivityVerbType or an array of ActivityVerbType
object - either an ActivityObjectModel or an array of ActivityObjectModel
content - the content of the activity