Package org.silverpeas.core.webapi.profile

Class ChatUserProfileEntity

java.lang.Object

org.silverpeas.core.admin.user.model.UserDetail

org.silverpeas.core.webapi.profile.UserProfileEntity

org.silverpeas.core.webapi.profile.ChatUserProfileEntity

All Implemented Interfaces:

Serializable, Comparable<User>, User, WebEntity

public class ChatUserProfileEntity
extends UserProfileEntity

The profile of a user that is registered into a chat service.

Author:

mmoquillon

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.silverpeas.core.admin.user.model.UserDetail

UserDetail.OnFirstNameAndLastName

Field Summary

Fields inherited from class org.silverpeas.core.admin.user.model.UserDetail

BLANK_NAME, SYSTEM_USER_ID

Fields inherited from interface org.silverpeas.core.admin.user.model.User

DEFAULT_AVATAR_PATH

Method Summary

Modifier and Type	Method	Description
static ChatUserProfileEntity	fromUser(ChatUser user)	Decorates the specified user details with the required WEB exposition features.
String	getChatId()	Gets the identifier of the user in the chat service.
boolean	isChatEnabled()	Is the chat service is enabled?

Methods inherited from class org.silverpeas.core.webapi.profile.UserProfileEntity

equals, fromUser, fromUsers, getAccessLevel, getAvatar, getContactsURI, getDomainId, getDomainName, geteMail, getFirstName, getFullName, getId, getLanguage, getLastName, getLogin, getSpecificId, getStatus, getURI, getWebPage, hashCode, isAnonymous, isConnected, isDeactivatedState, isDeletedState, isRemovedState, isSystem, setAccessLevel, setDeactivatedState, setDeletedState, setDomainId, seteMail, setFirstName, setId, setLastName, setLogin, setSpecificId, setStatus, toUserDetail, withAsUri

Methods inherited from class org.silverpeas.core.admin.user.model.UserDetail

compareTo, from, getAll, getAllInDomain, getAnonymousUser, getAnonymousUserId, getAvatarFileName, getById, getCreationDate, getCurrentRequester, getDisplayedName, getDomain, getDurationOfCurrentSession, getExpirationDate, getInvitationReceivedFrom, getInvitationSentTo, getLastLoginCredentialUpdateDate, getLastLoginDate, getLoginAnswer, getLoginQuestion, getNbSuccessfulLoginAttempts, getNotifManualReceiverLimit, getOrganisationController, getSaveDate, getSmallAvatar, getState, getStateSaveDate, getSystemUser, getToken, getTosAcceptanceDate, getUserManualNotificationUserReceiverLimitValue, getUserPreferences, getVersion, isAccessAdmin, isAccessDomainManager, isAccessGuest, isAccessPdcManager, isAccessSpaceManager, isAccessUnknown, isAccessUser, isActivatedState, isAnonymousUser, isAnonymousUserExist, isAvatarDefined, isBackOfficeVisible, isBlanked, isBlockedState, isDomainAdminRestricted, isDomainRestricted, isExpiredState, isFullyDefined, isInRelationWith, isUserManualNotificationUserReceiverLimit, isValidState, setCreationDate, setExpirationDate, setLastLoginCredentialUpdateDate, setLastLoginDate, setLoginAnswer, setLoginQuestion, setNbSuccessfulLoginAttempts, setNotifManualReceiverLimit, setSaveDate, setState, setStateSaveDate, setTosAcceptanceDate, setUserManualNotificationUserReceiverLimit, setVersion, traceUser

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

fromUser

public static ChatUserProfileEntity fromUser(ChatUser user)

Decorates the specified user details with the required WEB exposition features.

Parameters:

user - the user details to decorate.

Returns:

a web entity representing the profile of a user.

getChatId

public String getChatId()

Gets the identifier of the user in the chat service.

Returns:

the chat identifier of the user.

isChatEnabled

public boolean isChatEnabled()

Is the chat service is enabled? It is a short hand to check the chat service is enabled in the Javascript code in the web client side.

Returns:

true if the chat service is enabled and this user can chat with others users in Silverpeas.