|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.xpn.xwiki.api.Api com.xpn.xwiki.api.User
public class User
Scriptable API for easy handling of users. For the moment this API is very limited, containing only one method. In the future it should be extended to provide useful methods for working with users.
Field Summary | |
---|---|
protected static org.slf4j.Logger |
LOGGER
Logging helper object. |
Fields inherited from class com.xpn.xwiki.api.Api |
---|
context |
Constructor Summary | |
---|---|
User(XWikiUser user,
XWikiContext context)
Constructs a wrapper for the given protected XWikiUser object. |
Method Summary | |
---|---|
String |
getEmail()
API to retrieve the e-mail address of this user. |
XWikiUser |
getUser()
Expose the wrapped XWikiUser object. |
protected boolean |
isMain()
See if the user is global (i.e. |
boolean |
isUserInGroup(String groupName)
Check if the user belongs to a group or not. |
Methods inherited from class com.xpn.xwiki.api.Api |
---|
convert, convert, getXWikiContext, hasAccessLevel, hasAdminRights, hasProgrammingRights, hasWikiAdminRights |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final org.slf4j.Logger LOGGER
Constructor Detail |
---|
public User(XWikiUser user, XWikiContext context)
user
- The XWikiUser object that should be wrapper.context
- The current context
.Method Detail |
---|
@Programming public XWikiUser getUser()
public boolean isUserInGroup(String groupName)
groupName
- The group to check.
protected boolean isMain()
See if the user is global (i.e. registered in the main wiki) or local to a virtual wiki.
This method is not public, as the underlying implementation is not fully functional
public String getEmail()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |