Package com.atlassian.confluence.setup.settings

Interface DarkFeaturesManager

All Known Implementing Classes:

DefaultDarkFeaturesManager, VacantDarkFeaturesManager

public interface DarkFeaturesManager

Creates DarkFeatures instances from the PropertySet associated with the ThreadLocal user.

Method Summary

Modifier and Type	Method	Description
void	disableSiteFeature(String featureKey)
void	disableUserFeature(ConfluenceUser user, String featureKey)	Deprecated, for removal: This API element is subject to removal in a future version. since 9.3.
void	disableUserFeature(String featureKey)	Deprecated, for removal: This API element is subject to removal in a future version. since 9.3.
void	enableSiteFeature(String featureKey)
void	enableUserFeature(ConfluenceUser user, String featureKey)	Deprecated, for removal: This API element is subject to removal in a future version. since 9.3.
void	enableUserFeature(String featureKey)	Deprecated, for removal: This API element is subject to removal in a future version. since 9.3.
DarkFeatures	getDarkFeatures()
DarkFeatures	getDarkFeatures(ConfluenceUser user)	Deprecated, for removal: This API element is subject to removal in a future version. since 9.3.
DarkFeatures	getDarkFeaturesAllUsers()
DarkFeatures	getSiteDarkFeatures()

Method Details

getDarkFeatures

DarkFeatures getDarkFeatures()

Returns:

the dark features for all users. Since 9.3, always returns features for all users, not just current user

getDarkFeatures

@Deprecated(since="9.3",
            forRemoval=true)
DarkFeatures getDarkFeatures(ConfluenceUser user)

Deprecated, for removal: This API element is subject to removal in a future version.

since 9.3. Use getDarkFeaturesAllUsers() instead

Returns:

the dark features for the given user.

Since:

5.2

getSiteDarkFeatures

DarkFeatures getSiteDarkFeatures()

Returns:

the dark features that are set for the instance

enableUserFeature

@Deprecated(since="9.3",
            forRemoval=true)
void enableUserFeature(String featureKey)
                throws UnknownFeatureException

Deprecated, for removal: This API element is subject to removal in a future version.

since 9.3. Per user dark features are no longer supported

Throws:

UnknownFeatureException

enableUserFeature

@Deprecated(since="9.3",
            forRemoval=true)
void enableUserFeature(ConfluenceUser user,
 String featureKey)
                throws UnknownFeatureException

Deprecated, for removal: This API element is subject to removal in a future version.

since 9.3. Per user dark features are no longer supported

Enables the specified feature for the specified User

Throws:

UnknownFeatureException

disableUserFeature

@Deprecated(since="9.3",
            forRemoval=true)
void disableUserFeature(String featureKey)
                 throws UnknownFeatureException

Deprecated, for removal: This API element is subject to removal in a future version.

since 9.3. Per user dark features are no longer supported

Throws:

UnknownFeatureException

disableUserFeature

@Deprecated(since="9.3",
            forRemoval=true)
void disableUserFeature(ConfluenceUser user,
 String featureKey)
                 throws UnknownFeatureException

Deprecated, for removal: This API element is subject to removal in a future version.

since 9.3. Per user dark features are no longer supported

Disables the specified feature for the specified User

Throws:

UnknownFeatureException

enableSiteFeature

void enableSiteFeature(String featureKey)
                throws UnknownFeatureException

Throws:

UnknownFeatureException

disableSiteFeature

void disableSiteFeature(String featureKey)
                 throws UnknownFeatureException

Throws:

UnknownFeatureException

getDarkFeaturesAllUsers

DarkFeatures getDarkFeaturesAllUsers()

Returns:

the dark features enabled for all users