Package org.xwiki.user
Interface UserConfiguration
-
@Role public interface UserConfiguration
Configuration options for the User module.- Since:
- 12.2
- Version:
- $Id: e670381543ab05e3ff27489e90e7c81f24aebd05 $
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description Properties
getGuestPreference()
String
getStoreHint()
Properties
getSuperAdminPreferences()
default String
getUserQualifierProperty()
When displaying an user in a compact mode we usually rely only on the user avatar and their full name.
-
-
-
Method Detail
-
getStoreHint
String getStoreHint()
- Returns:
- the hint of the implementation components used to store users (defaults to
document
-
getSuperAdminPreferences
Properties getSuperAdminPreferences()
- Returns:
- the overriding preferences for the superadmin user
-
getGuestPreference
Properties getGuestPreference()
- Returns:
- the overriding preferences for the guest user
-
getUserQualifierProperty
@Unstable default String getUserQualifierProperty()
When displaying an user in a compact mode we usually rely only on the user avatar and their full name. If this is not enough to properly identify the user then this configuration can be used to display additional information.- Returns:
- the name of the user property to be used as qualifier (hint) when displaying the user in a compact mode,
or
null
if no additional information should be displayed - Since:
- 14.10.12, 15.5RC1
-
-