ActivityStreamPluginApi (XWiki Platform - Activity Stream

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.xpn.xwiki.plugin.activitystream.plugin
Class ActivityStreamPluginApi

java.lang.Object
  com.xpn.xwiki.api.Api
      com.xpn.xwiki.plugin.PluginApi<ActivityStreamPlugin>
          com.xpn.xwiki.plugin.activitystream.plugin.ActivityStreamPluginApi

public class ActivityStreamPluginApi
extends com.xpn.xwiki.plugin.PluginApi<ActivityStreamPlugin>
extends com.xpn.xwiki.plugin.PluginApi<ActivityStreamPlugin>

API for ActivityStreamPlugin.

Version:: $Id: 188b2aa54315eee72ece8f2834340e639b7fdcae $

Field Summary

Fields inherited from class com.xpn.xwiki.api.Api
`context`

Constructor Summary
`ActivityStreamPluginApi(ActivityStreamPlugin plugin, com.xpn.xwiki.XWikiContext context)` Constructor.

Method Summary
`void`	`addActivityEvent(ActivityEvent event)` Record in database the given `ActivityEvent` event.
`void`	`addActivityEvent(String streamName, String type, String title)` Records in database the a event built upon the passed parameters.
`void`	`addActivityEvent(String streamName, String type, String title, List<String> params)` Records in database an event built upon the passed document and other parameters.
`void`	`addDocumentActivityEvent(String streamName, Document doc, String type, int priority, String title)` Records in database an event built upon the passed document and other parameters.
`void`	`addDocumentActivityEvent(String streamName, Document doc, String type, int priority, String title, List<String> params)` Records in database an event built upon the passed document and other parameters.
`void`	`addDocumentActivityEvent(String streamName, Document doc, String type, String title)` Records in database an event built upon the passed document and other parameters.
`void`	`addDocumentActivityEvent(String streamName, Document doc, String type, String title, List<String> params)` Records in database an event built upon the passed document and other parameters.
`void`	`deleteActivityEvent(ActivityEvent event)` Delete the passed event form the database.
`void`	`deleteActivityEvents(List<ActivityEvent> evs)` Delete the passed events from the database.
`protected ActivityStream`	`getActivityStream()`
`List<ActivityEvent>`	`getEvents(boolean filter, int nb, int start)` Return the latest recorded events.
`List<ActivityEvent>`	`getEvents(String streamName, boolean filter, int nb, int start)` Return the latest events recorded for the given stream name.
`List<ActivityEvent>`	`getEventsForSpace(String space, boolean filter, int nb, int start)` Return the latest recorded events for the given wiki space.
`List<ActivityEvent>`	`getEventsForSpace(String streamName, String space, boolean filter, int nb, int start)` Return the latest events recorded for the given stream name in the given space.
`List<ActivityEvent>`	`getEventsForUser(String user, boolean filter, int nb, int start)` Return the latest recorded events triggered by the given user.
`List<ActivityEvent>`	`getEventsForUser(String streamName, String user, boolean filter, int nb, int start)` Return the latest events recorded for the given stream name and the given user.
`com.sun.syndication.feed.synd.SyndFeed`	`getFeed(List<ActivityEvent> events)` Get a feed from the given events.
`com.sun.syndication.feed.synd.SyndFeed`	`getFeed(List<ActivityEvent> events, String suffix)` Get a feed from the given events.
`com.sun.syndication.feed.synd.SyndFeed`	`getFeed(List<ActivityEvent> events, String author, String title, String description, String copyright, String encoding, String url)` Get a feed from the given events.
`com.sun.syndication.feed.synd.SyndFeed`	`getFeed(List<ActivityEvent> events, String author, String title, String description, String copyright, String encoding, String url, String suffix)` Get a feed from the given events.
`com.sun.syndication.feed.synd.SyndEntry`	`getFeedEntry(ActivityEvent event)` Get the feed entry for the given event.
`com.sun.syndication.feed.synd.SyndEntry`	`getFeedEntry(ActivityEvent event, String suffix)` Get the feed entry for the given event.
`String`	`getFeedOutput(List<ActivityEvent> events, String author, String title, String description, String copyright, String encoding, String url, String type)` Get the string representation of a feed from the given events.
`String`	`getFeedOutput(List<ActivityEvent> events, String author, String title, String description, String copyright, String encoding, String url, String type, String suffix)` Get the string representation of a feed from the given events.
`String`	`getFeedOutput(com.sun.syndication.feed.synd.SyndFeed feed, String type)` Get the string representation of a feed from the given feed.
`List<ActivityEvent>`	`getRelatedEvents(ActivityEvent event)` Get events that have the same requestId as the event passed as parameter.
`String`	`getStreamName(String spaceName)`
`List<Object[]>`	`searchDailyPages(String optionalWhereClause, int maxItems, int startAt)` Get unique pages with events sorted by date, grouped by days.
`List<Object[]>`	`searchDailyPages(String optionalWhereClause, List<Object> parametersValues, int maxItems, int startAt)` Get unique pages with events sorted by date, grouped by days.
`List<ActivityEvent>`	`searchEvents(String hql, boolean filter, boolean globalSearch, int nb, int start)` Search in database activity events matching the given hql query.
`List<ActivityEvent>`	`searchEvents(String hql, boolean filter, boolean globalSearch, int nb, int start, List<Object> parameterValues)` Search in database activity events matching the given hql query.
`List<ActivityEvent>`	`searchEvents(String hql, boolean filter, int nb, int start)` Search in database activity events matching the given hql query.
`List<ActivityEvent>`	`searchEvents(String hql, boolean filter, int nb, int start, List<Object> parameterValues)` Search in database activity events matching the given hql query.
`List<ActivityEvent>`	`searchEvents(String fromHql, String hql, boolean filter, boolean globalSearch, int nb, int start)` Search in database activity events matching the given hql query.
`List<ActivityEvent>`	`searchEvents(String fromHql, String hql, boolean filter, boolean globalSearch, int nb, int start, List<Object> parameterValues)` Search in database activity events matching the given hql query.
`List<ActivityEvent>`	`searchEvents(String fromHql, String hql, boolean filter, int nb, int start)` Search in database activity events matching the given hql query.
`List<ActivityEvent>`	`searchEvents(String fromHql, String hql, boolean filter, int nb, int start, List<Object> parameterValues)` Search in database activity events matching the given hql query.
`List<Object[]>`	`searchUniquePages(String optionalWhereClause, int maxItems, int startAt)` Get unique pages with events sorted by date.
`List<Object[]>`	`searchUniquePages(String optionalWhereClause, List<Object> parametersValues, int maxItems, int startAt)` Get unique pages with events sorted by date.
`protected List<ActivityEvent>`	`unwrapEvents(List<ActivityEvent> events)` Unwrap a list of events.
`protected List<ActivityEvent>`	`wrapEvents(List<ActivityEvent> events)` Wrap a list of events.

Methods inherited from class com.xpn.xwiki.plugin.PluginApi
`getInternalPlugin, getProtectedPlugin, setPlugin`

Methods inherited from class com.xpn.xwiki.api.Api
`convert, convert, getXWikiContext, hasAccessLevel, hasAdminRights, hasProgrammingRights, hasWikiAdminRights`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

ActivityStreamPluginApi

public ActivityStreamPluginApi(ActivityStreamPlugin plugin,
                               com.xpn.xwiki.XWikiContext context)

Constructor.

Parameters:: plugin - plugin to wrap; context - the XWiki context
See Also:: PluginApi.PluginApi(XWikiPluginInterface, XWikiContext)

Method Detail

getActivityStream

protected ActivityStream getActivityStream()

Returns:: The ActivityStream component to use inside the API

addActivityEvent

public void addActivityEvent(ActivityEvent event)
                      throws ActivityStreamException

Record in database the given ActivityEvent event.

Parameters:: event - the event to record in databases
Throws:: ActivityStreamException - if the event addition fails

addActivityEvent

public void addActivityEvent(String streamName,
                             String type,
                             String title)
                      throws ActivityStreamException

Records in database the a event built upon the passed parameters.

Parameters:: streamName - the name of the stream to record the event for; type - the type of event. The type can be a value picked from the list of values defined in ActivityEventType or any other String; title - the event title
Throws:: ActivityStreamException - if the event addition fails

addActivityEvent

public void addActivityEvent(String streamName,
                             String type,
                             String title,
                             List<String> params)
                      throws ActivityStreamException

Records in database an event built upon the passed document and other parameters. The passed document is used to retrieve document-related data for the event : date, page name, database.

Parameters:: streamName - name of the stream to use for the addition; type - type of the event; title - title of the event; params - parameters of the event
Throws:: ActivityStreamException - if the addition to the stream fails

addDocumentActivityEvent

public void addDocumentActivityEvent(String streamName,
                                     Document doc,
                                     String type,
                                     String title)
                              throws ActivityStreamException

Records in database an event built upon the passed document and other parameters. The passed document is used to retrieve document-related data for the event : date, page name, database.

Parameters:: streamName - the name of the stream to add the event to; doc - the document from which to retrieve document data for the event; type - the type of event. (see addActivityEvent(String, String, String); title - the title of the event
Throws:: ActivityStreamException - if the event addition fails

addDocumentActivityEvent

public void addDocumentActivityEvent(String streamName,
                                     Document doc,
                                     String type,
                                     int priority,
                                     String title)
                              throws ActivityStreamException

Records in database an event built upon the passed document and other parameters. The passed document is used to retrieve document-related data for the event : date, page name, database.

Parameters:: streamName - name of the stream to use for the addition; doc - which fired the event; type - type of the event; priority - priority of the event; title - title of the event
Throws:: ActivityStreamException - if the addition to the stream fails

deleteActivityEvents

public void deleteActivityEvents(List<ActivityEvent> evs)
                          throws ActivityStreamException

Delete the passed events from the database.

Parameters:: evs - the events to be deleted
Throws:: ActivityStreamException - if the event deletion fails

deleteActivityEvent

public void deleteActivityEvent(ActivityEvent event)
                         throws ActivityStreamException

Delete the passed event form the database.

Parameters:: event - the event to delete from database
Throws:: ActivityStreamException - if the event deletion fails

addDocumentActivityEvent

public void addDocumentActivityEvent(String streamName,
                                     Document doc,
                                     String type,
                                     String title,
                                     List<String> params)
                              throws ActivityStreamException

Records in database an event built upon the passed document and other parameters. The passed document is used to retrieve document-related data for the event : date, page name, database.

Parameters:: streamName - name of the stream to use for the addition; doc - which fired the event; type - type of the event; title - title of the event; params - parameters of the event
Throws:: ActivityStreamException - if the addition to the stream fails

addDocumentActivityEvent

public void addDocumentActivityEvent(String streamName,
                                     Document doc,
                                     String type,
                                     int priority,
                                     String title,
                                     List<String> params)
                              throws ActivityStreamException

Records in database an event built upon the passed document and other parameters. The passed document is used to retrieve document-related data for the event : date, page name, database.

Parameters:: streamName - name of the stream to use for the addition; doc - which fired the event; type - type of the event; priority - priority of the event; title - title of the event; params - parameters of the event
Throws:: ActivityStreamException - if the addition to the stream fails