Package org.exoplatform.webconferencing

Class UserInfo

java.lang.Object

org.exoplatform.webconferencing.IdentityInfo

org.exoplatform.webconferencing.UserInfo

Direct Known Subclasses:

GuestInfo, ParticipantInfo

public class UserInfo
extends IdentityInfo

Represent eXo user as a conversation participant for calls. Created by The eXo Platform SAS.

Version:

$Id: UserInfo.java 00000 Feb 23, 2017 pnedonosko $

Author:

Peter Nedonosko

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UserInfo.IMInfo	The Class IMInfo.

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.exoplatform.services.log.Log	LOG	The Constant LOG.
static String	TYPE_NAME	The Constant TYPE_NAME.

Fields inherited from class org.exoplatform.webconferencing.IdentityInfo

avatarLink, EMPTY, id, profileLink, title

Constructor Summary

Constructors

Constructor	Description
UserInfo(String userId, String firstName, String lastName)	Instantiates a new user info.

Method Summary

Modifier and Type	Method	Description
UserInfo.IMInfo	addImAccount(String type, String id)	Adds the user IM account.
void	addImAccount(UserInfo.IMInfo... ims)	Adds the user IM account(s).
String	getClientId()	Gets the client id.
String	getFirstName()	Gets the first name.
Collection<UserInfo.IMInfo>	getImAccount(String type)	Gets the IM accounts by type.
Map<String,Collection<UserInfo.IMInfo>>	getImAccounts()	Gets the im accounts.
String	getLastName()	Gets the last name.
String	getState()	Gets the state.
String	getType()	Gets the identity type.
boolean	hasImAccount(String type)	Checks for IM account associated with the user.
boolean	hasSameClientId(String clientId)	Checks for same client id.
boolean	isGroup()	Checks if it is a group.
void	setClientId(String clientId)	Sets the client id.
void	setState(String state)	Sets the state.

Methods inherited from class org.exoplatform.webconferencing.IdentityInfo

equals, getAvatarLink, getId, getProfileLink, getTitle, hashCode, setAvatarLink, setProfileLink

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_NAME

public static final String TYPE_NAME

The Constant TYPE_NAME.

LOG

protected static final org.exoplatform.services.log.Log LOG

The Constant LOG.

Constructor Detail

UserInfo

public UserInfo(String userId,
                String firstName,
                String lastName)

Instantiates a new user info.

Parameters:

userId - the user id in the system

firstName - the first type

lastName - the last type

Method Detail

isGroup

public boolean isGroup()

Checks if it is a group.

Specified by:

isGroup in class IdentityInfo

Returns:

true, if is a group

getType

public String getType()

Gets the identity type.

Specified by:

getType in class IdentityInfo

Returns:

the type

getFirstName

public String getFirstName()

Gets the first name.

Returns:

the firstName

getLastName

public String getLastName()

Gets the last name.

Returns:

the lastName

getImAccounts

public Map<String,Collection<UserInfo.IMInfo>> getImAccounts()

Gets the im accounts.

Returns:

the map of user instant messaging accounts: key is a type, value is a collection of UserInfo.IMInfo

addImAccount

public UserInfo.IMInfo addImAccount(String type,
                                    String id)

Adds the user IM account.

Parameters:

type - the IM type type (e.g. gtalk)

id - the IM id

Returns:

the added IM info

addImAccount

public void addImAccount(UserInfo.IMInfo... ims)

Adds the user IM account(s). Note that if IM with some type already added an another one will be skipped.

Parameters:

ims - the IM account(s) to add to the user profile

hasImAccount

public boolean hasImAccount(String type)

Checks for IM account associated with the user.

Parameters:

type - the IM account type

Returns:

true, if successful

getImAccount

public Collection<UserInfo.IMInfo> getImAccount(String type)

Gets the IM accounts by type.

Parameters:

type - the type

Returns:

the IM accounts

getState

public String getState()

Gets the state.

Returns:

the state

setState

public void setState(String state)

Sets the state.

Parameters:

state - the new state

getClientId

public String getClientId()

Gets the client id.

Returns:

the clientId

setClientId

public void setClientId(String clientId)

Sets the client id.

Parameters:

clientId - the clientId to set

hasSameClientId

public boolean hasSameClientId(String clientId)

Checks for same client id.

Parameters:

clientId - the client id

Returns:

true, if this user has same client ID (it is set and the same)