Package com.atlassian.confluence.core

Interface HeartbeatManager

All Known Implementing Classes:
DefaultHeartbeatManager
public interface HeartbeatManager

  • Method Details

    • getHeartbeatInterval

      long getHeartbeatInterval()
      Fetches the time at which activities will expire
      Returns:
      The activity timeout in milliseconds

    • getUsersForActivity

      @Deprecated(forRemoval=true, since="9.5") List<com.atlassian.user.User> getUsersForActivity(String activity)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 9.5 use getUserKeysForActivity(ActivityKey)
      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

    • getUserKeysForActivity

      Set<com.atlassian.sal.api.user.UserKey> getUserKeysForActivity(HeartbeatManager.ActivityKey activity)
      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
      Since:
      9.5

    • countUsersForActivity

      default int countUsersForActivity(HeartbeatManager.ActivityKey activity)
      Since:
      9.5

    • startActivity

      default void startActivity(HeartbeatManager.ActivityKey activity, ConfluenceUser user)
      Adds a username as an active participant to the specified activity
      Parameters:
      activity - The key used to identify the activity
      user - The user who is participating in the activity
      Since:
      9.5

    • startActivity

      @Deprecated(since="9.5", forRemoval=true) void startActivity(String activityKey, String username)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 9.5 use startActivity(ActivityKey, ConfluenceUser)
      Adds a username as an active participant to the specified activity
      Parameters:
      activityKey - The key used to identify the activity
      username - The username of the user who is participating in the activity

    • startActivity

      @Deprecated(since="9.5", forRemoval=true) void startActivity(String activity, com.atlassian.user.User user)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 9.5 use startActivity(ActivityKey, ConfluenceUser)
      Adds a username as an active participant to the specified activity
      Parameters:
      activity - The key used to identify the activity
      user - The user who is participating in the activity

    • stopActivity

      default void stopActivity(HeartbeatManager.ActivityKey activity, ConfluenceUser user)
      Remove a user from the active participants from the specified activity
      Parameters:
      activity - The key used to identify the activity
      user - The user who is participating in the activity
      Since:
      9.5

    • stopActivity

      @Deprecated(since="9.5", forRemoval=true) void stopActivity(String activity, com.atlassian.user.User user)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 9.5 use stopActivity(ActivityKey, ConfluenceUser)
      Remove a user from the active participants from the specified activity
      Parameters:
      activity - The key used to identify the activity
      user - The user who is participating in the activity

    • stopActivity

      @Deprecated(since="9.5", forRemoval=true) void stopActivity(String activityKey, String username)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 9.5 use stopActivity(ActivityKey, ConfluenceUser)
      Remove a username from the active participants from the specified activity
      Parameters:
      activityKey - The key used to identify the activity
      username - The username of the user who is participating in the activity