Package org.craftercms.studio.api.v2.dal

Interface ActivityStreamDAO

public interface ActivityStreamDAO

Method Summary

Modifier and Type	Method	Description
List<Activity>	getActivitiesForUsers(long siteId, List<String> usernames, List<String> actions, ZonedDateTime dateForm, ZonedDateTime dateTo, int offset, int limit)	Get activities for users
int	getActivitiesForUsersTotal(long siteId, List<String> usernames, List<String> actions, ZonedDateTime dateForm, ZonedDateTime dateTo)	Get total number activities for users
void	insertActivity(long siteId, long userId, String action, ZonedDateTime actionTimestamp, Item item, String packageId)	Insert record into activity stream

Method Details

insertActivity

void insertActivity(@Param("siteId")
 long siteId,
 @Param("userId")
 long userId,
 @Param("action")
 String action,
 @Param("actionTimestamp")
 ZonedDateTime actionTimestamp,
 @Param("item")
 Item item,
 @Param("packageId")
 String packageId)

Insert record into activity stream

Parameters:

siteId - site identifier

userId - user identifier

action - action that was performed

actionTimestamp - timestamp when action was performed

item - item that was actioned upon

packageId - package identifier that was actioned upon

getActivitiesForUsersTotal

int getActivitiesForUsersTotal(@Param("siteId")
 long siteId,
 @Param("usernames")
 List<String> usernames,
 @Param("actions")
 List<String> actions,
 @Param("dateFrom")
 ZonedDateTime dateForm,
 @Param("dateTo")
 ZonedDateTime dateTo)

Get total number activities for users

Parameters:

siteId - site identifier

usernames - list of usernames

actions - list of actions to filter

dateForm - lower boundary for filtering by date range

dateTo - upper boundary for filtering by date range

Returns:

total number of activities for given users

getActivitiesForUsers

List<Activity> getActivitiesForUsers(@Param("siteId")
 long siteId,
 @Param("usernames")
 List<String> usernames,
 @Param("actions")
 List<String> actions,
 @Param("dateFrom")
 ZonedDateTime dateForm,
 @Param("dateTo")
 ZonedDateTime dateTo,
 @Param("offset")
 int offset,
 @Param("limit")
 int limit)

Get activities for users

Parameters:

siteId - site identifier

usernames - list of usernames

actions - list of actions to filter

dateForm - lower boundary for filtering by date range

dateTo - upper boundary for filtering by date range

offset - offset of the first record in the result

limit - limit the number of the results to return

Returns:

list of activities for given users