Package com.atlassian.confluence.core
Interface HeartbeatManager
- All Known Implementing Classes:
DefaultHeartbeatManager
public interface HeartbeatManager
-
Method Summary
Modifier and TypeMethodDescriptionlong
Fetches the time at which activities will expireList<com.atlassian.user.User>
getUsersForActivity
(String activity) Fetches a list of users who are participating in a specified activityvoid
startActivity
(String activity, com.atlassian.user.User user) Adds a username as an active participant to the specified activityvoid
startActivity
(String activityKey, String username) Adds a username as an active participant to the specified activityvoid
stopActivity
(String activity, com.atlassian.user.User user) Remove a user from the active participants from the specified activityvoid
stopActivity
(String activityKey, String username) Remove a username from the active participants from the specified activity
-
Method Details
-
getHeartbeatInterval
long getHeartbeatInterval()Fetches the time at which activities will expire- Returns:
- The activity timeout in milliseconds
-
getUsersForActivity
Fetches a list of users who are participating in a specified activity- Parameters:
activity
- The key used to identify the activity- Returns:
- A list of users who are actively engaging in the specified activity
-
startActivity
Adds a username as an active participant to the specified activity- Parameters:
activityKey
- The key used to identify the activityusername
- The username of the user who is participating in the activity
-
startActivity
Adds a username as an active participant to the specified activity- Parameters:
activity
- The key used to identify the activityuser
- The user who is participating in the activity
-
stopActivity
Remove a user from the active participants from the specified activity- Parameters:
activity
- The key used to identify the activityuser
- The user who is participating in the activity
-
stopActivity
Remove a username from the active participants from the specified activity- Parameters:
activityKey
- The key used to identify the activityusername
- The username of the user who is participating in the activity
-