Package com.atlassian.confluence.setup.settings

Interface CollaborativeEditingHelper

All Known Implementing Classes:
DefaultCollaborativeEditingHelper
@Internal public interface CollaborativeEditingHelper
Provides helper methods to check Collaborative Editing Mode and status.
Since:
6.3.0

  • Field Details

  • Method Details

    • isSharedDraftsFeatureEnabled

      boolean isSharedDraftsFeatureEnabled(String spaceKey)
      Checks if the Shared Drafts dark feature is enabled for the space or globally when no space is passed.
      Parameters:
      spaceKey - space key
      Returns:
      true if Share Drafts dark feature is enabled.

    • isUpgraded

      boolean isUpgraded()
      Maybe better alternative is do synchrony event propagation via this class so upgrade check is isolated in one place.
      Returns:
      false if upgrade is in progress so synchrony events could be suppressed.

    • isLimitedModeEnabled

      @Deprecated boolean isLimitedModeEnabled(String spaceKey)
      Deprecated.
      since 7.5.0. Limited mode is no longer supported since 7.5.0
      Parameters:
      spaceKey - space key
      Returns:
      true if limited mode is enabled (since 7.5.0 this method always returns false)

    • getEditMode

      String getEditMode(String spaceKey)
      Returns the current editing mode.
      Parameters:
      spaceKey - space key
      Returns:
      the current editing mode, one of LEGACY_MODE, COLLABORATIVE_MODE,

    • isOverLimit

      boolean isOverLimit(int numberOfConcurrentUsers)
      Parameters:
      numberOfConcurrentUsers - Number of users currently in the editor including the current user.
      Returns:
      true if the number of users in the editor is greater than the limit

    • getUserLimit

      int getUserLimit()
      Returns the number of users allowed in editor.
      Returns:
      the number of users allowed in editor