ActivityService (Alfresco 5.1.4.1 Public Java API)

org.alfresco.service.cmr.activities

Interface ActivityService

All Superinterfaces:

@org.alfresco.api.AlfrescoPublicApi
public interface ActivityService

The activity service

Method Summary
boolean	existsFeedControl(org.alfresco.service.cmr.activities.FeedControl feedControl) For current user, does the feed control exist ?
List<org.alfresco.service.cmr.activities.FeedControl>	getFeedControls() For current user, get feed controls
List<org.alfresco.service.cmr.activities.FeedControl>	getFeedControls(String userId) For given user, get feed controls
int	getMaxFeedItems() Return maximum configured item entries (per feed)
PagingResults<org.alfresco.repo.domain.activities.ActivityFeedEntity>	getPagedUserFeedEntries(String feedUserId, String siteId, boolean excludeThisUser, boolean excludeOtherUsers, long minFeedId, PagingRequest pagingRequest)
List<String>	getSiteFeedEntries(String siteId) Retrieve site feed
List<String>	getUserFeedEntries(String userId, String siteId) Retrieve user feed with optional site filter Will return activities for all users across all sites, or optionally for all users for specified site.
List<String>	getUserFeedEntries(String userId, String siteId, boolean excludeThisUser, boolean excludeOtherUsers) Retrieve user feed with optional site filter and optional user filters Will return activities for users across all sites, or optionally for users for specified site.
List<org.alfresco.repo.domain.activities.ActivityFeedEntity>	getUserFeedEntries(String feedUserId, String siteId, boolean excludeThisUser, boolean excludeOtherUsers, long minFeedId) Retrieve user feed with optional site filter and optional user filters and optional min feed DB id Will return activities for users across all sites, or optionally for users for specified site.
List<String>	getUserFeedEntries(String userId, String siteId, boolean excludeThisUser, boolean excludeOtherUsers, Set<String> userFilter, Set<String> actvityFilter) Retrieve user feed with optional site filter and optional user filters Will return activities for users across all sites, or optionally for users for specified site.
List<org.alfresco.repo.domain.activities.ActivityFeedEntity>	getUserFeedEntries(String feedUserId, String siteId, boolean excludeThisUser, boolean excludeOtherUsers, Set<String> userFilter, Set<String> actvityFilter, long minFeedId) Retrieve user feed with optional site filter and optional user filters and optional min feed DB id Will return activities for users across all sites, or optionally for users for specified site.
void	setFeedControl(org.alfresco.service.cmr.activities.FeedControl feedControl) For current user, set feed control (opt-out) for a site or an appTool or a site/appTool combination
void	unsetFeedControl(org.alfresco.service.cmr.activities.FeedControl feedControl) For current user, unset feed control

Methods inherited from interface org.alfresco.service.cmr.activities.ActivityPostService

postActivity, postActivity, postActivity, postActivity, postActivity, postActivity, postActivity

@NotAuditable
List<String> getUserFeedEntries(String userId,
String siteId)

Retrieve user feed with optional site filter Will return activities for all users across all sites, or optionally for all users for specified site.

siteId - - optional, if set then will filter by given siteId else return all sites

list of JSON feed entries

@NotAuditable
List<String> getUserFeedEntries(String userId,
                                String siteId,
                                boolean excludeThisUser,
                                boolean excludeOtherUsers)

Retrieve user feed with optional site filter and optional user filters Will return activities for users across all sites, or optionally for users for specified site. User filters are: - all user activities (excludeThisUser = false, excludeOtherUsers = false) - other user activities (excludeThisUser = true, excludeOtherUsers = false) - my user activities (excludeThisUser = false, excludeOtherUsers = true) note: if both excludes are true then no activities will be returned.

siteId - - optional, if set then will filter by given siteId else return all sites

excludeThisUser - - if TRUE then will exclude activities for this user (hence returning other users only)

excludeOtherUsers - - if TRUE then will exclude activities for other users (hence returning this user only)

list of JSON feed entries

@NotAuditable
List<String> getUserFeedEntries(String userId,
                                String siteId,
                                boolean excludeThisUser,
                                boolean excludeOtherUsers,
                                Set<String> userFilter,
                                Set<String> actvityFilter)

siteId - - optional, if set then will filter by given siteId else return all sites

excludeThisUser - - if TRUE then will exclude activities for this user (hence returning other users only)

excludeOtherUsers - - if TRUE then will exclude activities for other users (hence returning this user only)

userFilter - - if not NULL then will only return activities of users in this set

actvityFilter - - if not NULL then will only return activities that are in this set

list of JSON feed entries

@NotAuditable
List<org.alfresco.repo.domain.activities.ActivityFeedEntity> getUserFeedEntries(String feedUserId,
                                                                                String siteId,
                                                                                boolean excludeThisUser,
                                                                                boolean excludeOtherUsers,
                                                                                long minFeedId)

Retrieve user feed with optional site filter and optional user filters and optional min feed DB id Will return activities for users across all sites, or optionally for users for specified site. User filters are: - all user activities (excludeThisUser = false, excludeOtherUsers = false) - other user activities (excludeThisUser = true, excludeOtherUsers = false) - my user activities (excludeThisUser = false, excludeOtherUsers = true) note: if both excludes are true then no activities will be returned.

feedUserId - - required

siteId - - optional, if set then will filter by given siteId else return all sites

excludeThisUser - - if TRUE then will exclude activities for this user (hence returning other users only)

excludeOtherUsers - - if TRUE then will exclude activities for other users (hence returning this user only)

minFeedId - - inclusive from min feed DB id, if -1 then return all available

list of JSON feed entries

feedUserId - - required

siteId - - optional, if set then will filter by given siteId else return all sites

excludeThisUser - - if TRUE then will exclude activities for this user (hence returning other users only)

excludeOtherUsers - - if TRUE then will exclude activities for other users (hence returning this user only)

userFilter - - if not NULL then will only return activities of users in this set

actvityFilter - - if not NULL then will only return activities that are in this set

minFeedId - - inclusive from min feed DB id, if -1 then return all available

list of JSON feed entries

getPagedUserFeedEntries

@NotAuditable
PagingResults<org.alfresco.repo.domain.activities.ActivityFeedEntity> getPagedUserFeedEntries(String feedUserId,
                                                                                              String siteId,
                                                                                              boolean excludeThisUser,
                                                                                              boolean excludeOtherUsers,
                                                                                              long minFeedId,
                                                                                              PagingRequest pagingRequest)

@NotAuditable
List<String> getSiteFeedEntries(String siteId)

list of JSON feed entries

@NotAuditable
int getMaxFeedItems()

Return maximum configured item entries (per feed)

@NotAuditable
void setFeedControl(org.alfresco.service.cmr.activities.FeedControl feedControl)

For current user, set feed control (opt-out) for a site or an appTool or a site/appTool combination

feedControl - - required

@NotAuditable
List<org.alfresco.service.cmr.activities.FeedControl> getFeedControls(String userId)

For given user, get feed controls

userId - - required (must match

list of user feed controls

@NotAuditable
List<org.alfresco.service.cmr.activities.FeedControl> getFeedControls()

For current user, get feed controls

list of user feed controls

@NotAuditable
void unsetFeedControl(org.alfresco.service.cmr.activities.FeedControl feedControl)

For current user, unset feed control

feedControl - - required

@NotAuditable
boolean existsFeedControl(org.alfresco.service.cmr.activities.FeedControl feedControl)

For current user, does the feed control exist ?

feedControl - - required

true, if user feed control exists

Java API documentation generated with DocFlex/Javadoc 1.6.1 using JavadocPro template set.