Package com.atlassian.confluence.core

Interface HeartbeatManager

All Known Implementing Classes:
DefaultHeartbeatManager
public interface HeartbeatManager

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getHeartbeatInterval()
    Fetches the time at which activities will expire
    List<com.atlassian.user.User>
    getUsersForActivity(String activity)
    Fetches a list of users who are participating in a specified activity
    void
    startActivity(String activity, com.atlassian.user.User user)
    Adds a username as an active participant to the specified activity
    void
    startActivity(String activityKey, String username)
    Adds a username as an active participant to the specified activity
    void
    stopActivity(String activity, com.atlassian.user.User user)
    Remove a user from the active participants from the specified activity
    void
    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

      List<com.atlassian.user.User> getUsersForActivity(String 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

    • startActivity

      void startActivity(String activityKey, String username)
      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

      void startActivity(String activity, com.atlassian.user.User 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

    • stopActivity

      void stopActivity(String activity, com.atlassian.user.User 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

    • stopActivity

      void stopActivity(String activityKey, String username)
      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