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 Summary

Fields

Modifier and Type	Field	Description
static String	COLLABORATIVE_MODE
static String	LEGACY_MODE
static String	LIMITED_MODE	Deprecated. since 7.5.0.
static String	SHARED_DRAFTS_DARK_FEATURE
static String	SITE_WIDE_SHARED_DRAFTS_DARK_FEATURE
static String	SITE_WIDE_SYNCHRONY_DARK_FEATURE	Deprecated. since 7.5.0.
static String	SYNCHRONY_DARK_FEATURE	Deprecated. since 7.5.0.
static String	USER_LIMIT_DARK_FEATURE_DISABLE

Method Summary

Modifier and Type	Method	Description
String	getEditMode(String spaceKey)	Returns the current editing mode.
int	getUserLimit()	Returns the number of users allowed in editor.
boolean	isLimitedModeEnabled(String spaceKey)	Deprecated. since 7.5.0.
boolean	isOverLimit(int numberOfConcurrentUsers)
boolean	isSharedDraftsFeatureEnabled(String spaceKey)	Checks if the Shared Drafts dark feature is enabled for the space or globally when no space is passed.
boolean	isUpgraded()	Maybe better alternative is do synchrony event propagation via this class so upgrade check is isolated in one place.

Field Detail

COLLABORATIVE_MODE

static final String COLLABORATIVE_MODE

See Also:

Constant Field Values

LEGACY_MODE

static final String LEGACY_MODE

See Also:

Constant Field Values

LIMITED_MODE

@Deprecated
static final String LIMITED_MODE

Deprecated.

since 7.5.0. Limited mode is no longer supported since 7.5.0

See Also:

Constant Field Values

SHARED_DRAFTS_DARK_FEATURE

static final String SHARED_DRAFTS_DARK_FEATURE

See Also:

Constant Field Values

SITE_WIDE_SHARED_DRAFTS_DARK_FEATURE

static final String SITE_WIDE_SHARED_DRAFTS_DARK_FEATURE

See Also:

Constant Field Values

SYNCHRONY_DARK_FEATURE

@Deprecated
static final String SYNCHRONY_DARK_FEATURE

Deprecated.

since 7.5.0. Limited mode is no longer supported since 7.5.0

See Also:

Constant Field Values

SITE_WIDE_SYNCHRONY_DARK_FEATURE

@Deprecated
static final String SITE_WIDE_SYNCHRONY_DARK_FEATURE

Deprecated.

since 7.5.0. Limited mode is no longer supported since 7.5.0

See Also:

Constant Field Values

USER_LIMIT_DARK_FEATURE_DISABLE

static final String USER_LIMIT_DARK_FEATURE_DISABLE

See Also:

Constant Field Values

Method Detail

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