Index (XWiki Platform - User

A C D E F G I O R S T U V W
All Classes All Packages

A

ADVANCED - org.xwiki.user.UserType: Advanced user (sees all possible actions in the UI).
ALL - org.xwiki.user.group.WikiTarget: Search in all wikis.

C

CurrentUserReference - Class in org.xwiki.user: Represents a reference to the current logged-in user.

D

displayHiddenDocuments() - Method in interface org.xwiki.user.UserProperties

E

Editor - Enum in org.xwiki.user: The default editor that should be used for a user, when editing content.
ENTITY - org.xwiki.user.group.WikiTarget: Search in the entity's wiki only.
ENTITY_AND_CURRENT - org.xwiki.user.group.WikiTarget: Search in the entity's wiki and the current wiki.
exists(UserReference) - Method in interface org.xwiki.user.UserManager

F

fromString(String) - Static method in enum org.xwiki.user.Editor
fromString(String) - Static method in enum org.xwiki.user.UserType

G

getEditor() - Method in interface org.xwiki.user.UserProperties
getEmail() - Method in interface org.xwiki.user.UserProperties
getFirstName() - Method in interface org.xwiki.user.UserProperties
getGroups(DocumentReference, Object, boolean) - Method in interface org.xwiki.user.group.GroupManager: Search groups the passed user or group is member of.
getGuestPreference() - Method in interface org.xwiki.user.UserConfiguration
getLastName() - Method in interface org.xwiki.user.UserProperties
getMembers(DocumentReference, boolean) - Method in interface org.xwiki.user.group.GroupManager: Retrieve the users and groups which are the members of the passed group.
getStoreHint() - Method in interface org.xwiki.user.UserConfiguration
getSuperAdminPreferences() - Method in interface org.xwiki.user.UserConfiguration
getType() - Method in interface org.xwiki.user.UserProperties
getUserQualifierProperty() - Method in interface org.xwiki.user.UserConfiguration: When displaying an user in a compact mode we usually rely only on the user avatar and their full name.
GroupException - Exception in org.xwiki.user.group: Any exception raised in the group manager.
GroupException(String) - Constructor for exception org.xwiki.user.group.GroupException: Constructs a new exception with the specified detail message.
GroupException(String, Throwable) - Constructor for exception org.xwiki.user.group.GroupException: Constructs a new exception with the specified detail message and cause.
GroupException(Throwable) - Constructor for exception org.xwiki.user.group.GroupException
GroupManager - Interface in org.xwiki.user.group: Fast access to group membership.
GuestUserReference - Class in org.xwiki.user: Represents the Super Admin user reference, i.e.

I

INSTANCE - Static variable in class org.xwiki.user.CurrentUserReference: The unique instance of this class.
INSTANCE - Static variable in class org.xwiki.user.GuestUserReference: The unique instance of this class.
INSTANCE - Static variable in class org.xwiki.user.SuperAdminUserReference: The unique instance of this class.
isActive() - Method in interface org.xwiki.user.UserProperties
isEmailChecked() - Method in interface org.xwiki.user.UserProperties
isGlobal() - Method in class org.xwiki.user.CurrentUserReference
isGlobal() - Method in class org.xwiki.user.GuestUserReference
isGlobal() - Method in class org.xwiki.user.SuperAdminUserReference
isGlobal() - Method in interface org.xwiki.user.UserReference

O

org.xwiki.user - package org.xwiki.user
org.xwiki.user.group - package org.xwiki.user.group

R

resolve(UserReference, Object...) - Method in interface org.xwiki.user.UserPropertiesResolver
resolve(T, Object...) - Method in interface org.xwiki.user.UserReferenceResolver

S

save() - Method in interface org.xwiki.user.UserProperties: Persist the various setXXX() calls made since the last call to this method.
serialize(UserReference) - Method in interface org.xwiki.user.UserReferenceSerializer
serialize(UserReference, Object...) - Method in interface org.xwiki.user.UserReferenceSerializer
setActive(boolean) - Method in interface org.xwiki.user.UserProperties
setDisplayHiddenDocuments(boolean) - Method in interface org.xwiki.user.UserProperties
setEditor(Editor) - Method in interface org.xwiki.user.UserProperties
setEmail(InternetAddress) - Method in interface org.xwiki.user.UserProperties
setEmailChecked(boolean) - Method in interface org.xwiki.user.UserProperties
setFirstName(String) - Method in interface org.xwiki.user.UserProperties
setLastName(String) - Method in interface org.xwiki.user.UserProperties
setType(UserType) - Method in interface org.xwiki.user.UserProperties
SIMPLE - org.xwiki.user.UserType: Simple user (hides complex actions in the UI for simplicity).
SuperAdminUserReference - Class in org.xwiki.user: Represents the Super Admin user reference, i.e.

T

TEXT - org.xwiki.user.Editor: Text editor (wiki editor).
TYPE_DOCUMENT_REFERENCE - Static variable in interface org.xwiki.user.UserReferenceResolver: Type instance for UserReferenceResolver<DocumentReference>.
TYPE_DOCUMENT_REFERENCE - Static variable in interface org.xwiki.user.UserReferenceSerializer: Type instance for UserReferenceSerializer<DocumentReference>.
TYPE_STRING - Static variable in interface org.xwiki.user.UserReferenceResolver: Type instance for UserReferenceResolver<String>.
TYPE_STRING - Static variable in interface org.xwiki.user.UserReferenceSerializer: Type instance for UserReferenceSerializer<String>.

U

UNDEFINED - org.xwiki.user.Editor: The editor is not explictly defined which means it'll dedcided based on some context information (for example based on the wiki's default editor).
UserConfiguration - Interface in org.xwiki.user: Configuration options for the User module.
UserException - Exception in org.xwiki.user: Generic exception for the user api module.
UserException(String, Throwable) - Constructor for exception org.xwiki.user.UserException: Constructs a new user exception with the specified detail message and cause.
UserManager - Interface in org.xwiki.user: CRUD operations on users.
UserProperties - Interface in org.xwiki.user: Represents all the properties of an XWiki user.
UserPropertiesResolver - Interface in org.xwiki.user: Gets the properties for a user (represented by a UserReference).
UserReference - Interface in org.xwiki.user: Abstracts the concept of User reference.
UserReferenceResolver<T> - Interface in org.xwiki.user: Convert a raw representation of a user reference into a UserReference object (for example converts a String containing a user name into a Document User Reference).
UserReferenceSerializer<T> - Interface in org.xwiki.user: Converts a UserReference into a serialized form (e.g.
UserType - Enum in org.xwiki.user: The type of the user (simple user, advanced user).

V

valueOf(String) - Static method in enum org.xwiki.user.Editor: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.xwiki.user.group.WikiTarget: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.xwiki.user.UserType: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.xwiki.user.Editor: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.xwiki.user.group.WikiTarget: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.xwiki.user.UserType: Returns an array containing the constants of this enum type, in the order they are declared.

W

WikiTarget - Enum in org.xwiki.user.group: The wikis where to search.
WYSIWYG - org.xwiki.user.Editor: WYSIWYG editor.

A C D E F G I O R S T U V W
All Classes All Packages