com.electrotank.electroserver5.extensions.api.value
Class UserConfig

java.lang.Object
  com.electrotank.electroserver5.extensions.api.value.UserConfig

public class UserConfig
extends Object

This class defines the configuration of a given user and its relationship with a specific room/zone. Default for each boolean is false.

See Also:

ElectroServerApi.addUsersToRoom, ElectroServerApi.createRoom, ElectroServerApi.createRoomInNamedZone

Constructor Summary

UserConfig()

Method Summary

String	getUserName() Gets the name of the user.
boolean	isReceivingRoomAttributeUpdates() Is the user receiving room attribute updates?
boolean	isReceivingRoomListUpdates() Is the user receiving room list updates?
boolean	isReceivingRoomVariableUpdates() Is the user receiving room variable updates?
boolean	isReceivingUserListUpdates() Is the user receiving user list updates?
boolean	isReceivingUserVariableUpdates() Is the user receiving user variable updates?
boolean	isReceivingVideoEvents() Is the user receiving video events?
void	setReceivingRoomAttributeUpdates(boolean receivingRoomAttributeUpdates) Sets whether a user is receiving room attribute updates
void	setReceivingRoomListUpdates(boolean receivingRoomListUpdates) Sets if the user is receiving room list updates.
void	setReceivingRoomVariableUpdates(boolean receivingRoomVariableUpdates) Sets if the user is receiving room variable updates.
void	setReceivingUserListUpdates(boolean receivingUserListUpdates) Sets if the user is receiving user list updates.
void	setReceivingUserVariableUpdates(boolean receivingUserVariableUpdates) Sets if the user is receiving user variable updates.
void	setReceivingVideoEvents(boolean receivingVideoEvents) Sets whether the user is receiving video events.
void	setUserName(String userName) Sets the name of the user.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserConfig

public UserConfig()

Method Detail

isReceivingRoomListUpdates

public boolean isReceivingRoomListUpdates()

Is the user receiving room list updates?

Returns:

a boolean indicating if the user is receiving room list updates

setReceivingRoomListUpdates

public void setReceivingRoomListUpdates(boolean receivingRoomListUpdates)

Sets if the user is receiving room list updates.

Parameters:

receivingRoomListUpdates - a boolean indicating if the user is receiving room list updates

isReceivingRoomVariableUpdates

public boolean isReceivingRoomVariableUpdates()

Is the user receiving room variable updates?

Returns:

a boolean indicating if the user is receiving room variable updates

setReceivingRoomVariableUpdates

public void setReceivingRoomVariableUpdates(boolean receivingRoomVariableUpdates)

Sets if the user is receiving room variable updates.

Parameters:

receivingRoomVariableUpdates - a boolean indicating if the user is receiving room variable updates

isReceivingUserListUpdates

public boolean isReceivingUserListUpdates()

Is the user receiving user list updates?

Returns:

a boolean indicating if the user is receiving user list updates

setReceivingUserListUpdates

public void setReceivingUserListUpdates(boolean receivingUserListUpdates)

Sets if the user is receiving user list updates.

Parameters:

receivingUserListUpdates - a boolean indicating if the user is receiving user list updates

isReceivingUserVariableUpdates

public boolean isReceivingUserVariableUpdates()

Is the user receiving user variable updates?

Returns:

a boolean indicating if the user is receiving user variable updates

setReceivingUserVariableUpdates

public void setReceivingUserVariableUpdates(boolean receivingUserVariableUpdates)

Sets if the user is receiving user variable updates.

Parameters:

receivingUserVariableUpdates - a boolean indicating if the user is receiving user variable updates

isReceivingVideoEvents

public boolean isReceivingVideoEvents()

Is the user receiving video events?

Returns:

a boolean indicating if the user is receiving video events

setReceivingVideoEvents

public void setReceivingVideoEvents(boolean receivingVideoEvents)

Sets whether the user is receiving video events.

Parameters:

receivingVideoEvents - a boolean indicating if the user is receiving video events

getUserName

public String getUserName()

Gets the name of the user.

Returns:

userName

setUserName

public void setUserName(String userName)

Sets the name of the user.

Parameters:

userName - unique string identifying the user

isReceivingRoomAttributeUpdates

public boolean isReceivingRoomAttributeUpdates()

Is the user receiving room attribute updates?

Returns:

a boolean indicating if the user is receiving room attribute updates

setReceivingRoomAttributeUpdates

public void setReceivingRoomAttributeUpdates(boolean receivingRoomAttributeUpdates)

Sets whether a user is receiving room attribute updates

Parameters:

receivingRoomAttributeUpdates - a boolean indicating if the user is receiving room attribute updates