URoomEvent Class

Extends

org.moock.event.EventObject

Constructor

URoomEvent(src, clientID, status, changedAttr, numClients)

Arguments

src: A reference to the object that generated the event (normally an instance of URoom).
clientID: The clientID of the client to which the event pertains.
status: The status of the operation to which the event pertains.
changedAttr: An object representing a changed client or room attribute.
numClients: The number of clients now in the room (used with URoomListener.onNumClients() only).

Methods

getClientID()	Returns the client ID of the client added to or removed from the room, or whose attribute changed.
getChangedAttr()	Returns an object containing information about a changed client or room attribute. The object's properties are: `attrName` - the name of the attribute `attrVal` - the new value of the attribute `fqRoomID` - the scope of the changed client attribute (does not apply to room attributes)
getNumClients()	Returns the number of unique clients now in this room.
getStatus()	Returns the status of the operation to which this event pertains (either joining or leaving the room).

Description

Contains information about a specific URoomListener event, such as onAddClient() or onUpdateRoomAttribute(). Passed to all URoomListener objects that have registered to receive events via URoom.addURoomListener().

Documentation Version

1.0.1