com.electrotank.electroserver4.extensions.api.value
Class UserPublicMessageContext

java.lang.Object
  com.electrotank.electroserver4.extensions.api.value.UserPublicMessageContext

public class UserPublicMessageContext
extends Object

Contains the context for a userPublicMessage event.

See Also:

RoomUserEvents.userSendPublicMessage

Constructor Summary

UserPublicMessageContext(String userName, String message, EsObjectRO esObject)
Creates a new instance of UserPublicMessageContext

Method Summary

EsObjectRO	getEsObject() Gets a read-only copy of the optional EsObject broadcast.
String	getMessage() Gets the message broadcast.
EsObject	getResponseParameters() Gets the response parameters for the broadcast message.
String	getUserName() Gets the name of the user who broadcast the message.
void	setEsObject(EsObjectRO esObject) Sets the optional EsObject broadcast.
void	setMessage(String message) Sets the message broadcast.
void	setResponseParameters(EsObject responseParameters) Sets the response parameters for the broadcast message.
void	setUserName(String userName) Sets the name of the user who broadcast the message.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserPublicMessageContext

public UserPublicMessageContext(String userName,
                                String message,
                                EsObjectRO esObject)

Creates a new instance of UserPublicMessageContext

Parameters:

userName - name of the user sending the public message

message - message sent

esObject - optional EsObject that could contain other information to be broadcast, such as an audio clip or animation.

Method Detail

getEsObject

public EsObjectRO getEsObject()

Gets a read-only copy of the optional EsObject broadcast.

Returns:

optional EsObject

setEsObject

public void setEsObject(EsObjectRO esObject)

Sets the optional EsObject broadcast.

Parameters:

esObject - optional object to be broadcast

getMessage

public String getMessage()

Gets the message broadcast.

Returns:

message

setMessage

public void setMessage(String message)

Sets the message broadcast.

Parameters:

message - message broadcast

getResponseParameters

public EsObject getResponseParameters()

Gets the response parameters for the broadcast message. This will contain any error messages from the (attempted) broadcast.

Returns:

response parameters

setResponseParameters

public void setResponseParameters(EsObject responseParameters)

Sets the response parameters for the broadcast message.

Parameters:

responseParameters - response parameters for the message

getUserName

public String getUserName()

Gets the name of the user who broadcast the message.

Returns:

userName

setUserName

public void setUserName(String userName)

Sets the name of the user who broadcast the message.

Parameters:

userName - name of the user