org.symphonyoss.client.services

Class RoomService

java.lang.Object

org.symphonyoss.client.services.RoomService

All Implemented Interfaces:

RoomServiceEventListener

public class RoomService
extends java.lang.Object
implements RoomServiceEventListener

The room service provides capabilities that support room access and events. The running service will construct room objects detected from new message events. The service supports listeners that provide callbacks to all registered room events and general messaging.

Its important to note the distinction between creating a room and joining a room. Creating a room implies the creation of the room object, but not the monitoring of it by the service. You must explicitly join a room (register with the RoomService) in order to receive individual room events.

Constructor Summary

Constructors

Constructor and Description
RoomService(SymphonyClient symClient)

Method Summary

Modifier and Type	Method and Description
void	addRoomServiceEventListener(RoomServiceEventListener roomServiceEventListener)
Room	createRoom(SymRoomAttributes symRoomAttributes) Create a new room object from SymRoomAttributes provided.
Room	getRoom(java.lang.String streamId) Return registered room by provided stream.
Room	getRoom(SymStream symStream) Return registered room by provided stream.
void	joinRoom(Room room) Logical join of the room which registers the listeners and the Room object to the service.
void	onMessage(SymMessage symMessage) Callback from registered room listener on the MessageService.
void	onNewRoom(Room room) Publish new room objects based on detection and/or registration to the service
void	onSymRoomCreated(SymRoomCreated symRoomCreated)
void	onSymRoomDeactivated(SymRoomDeactivated symRoomDeactivated)
void	onSymRoomMemberDemotedFromOwner(SymRoomMemberDemotedFromOwner symRoomMemberDemotedFromOwner)
void	onSymRoomMemberPromotedToOwner(SymRoomMemberPromotedToOwner symRoomMemberPromotedToOwner)
void	onSymRoomReactivated(SymRoomReactivated symRoomReactivated)
void	onSymRoomUpdated(SymRoomUpdated symRoomUpdated)
void	onSymUserJoinedRoom(SymUserJoinedRoom symUserJoinedRoom)
void	onSymUserLeftRoom(SymUserLeftRoom symUserLeftRoom)
void	removeRoomServiceEventListener(RoomServiceEventListener roomServiceEventListener)

Methods inherited from class java.lang.Object

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

Constructor Detail

RoomService

public RoomService(SymphonyClient symClient)

Parameters:

symClient - SymphonyClient provides access to client implementations and dependant services such as the MessageService

Method Detail

createRoom

public Room createRoom(SymRoomAttributes symRoomAttributes)
                throws RoomException

Create a new room object from SymRoomAttributes provided. The room object will be enriched with all associated room metadata at the point of creation.

Note: Future lifecycle room events are not automatically reflected in the created room object. updated.

Parameters:

symRoomAttributes - Room attributes required to create the room object

Returns:

Fully populated Room object

Throws:

RoomException - Exception generated from the logical creation of the room object

getRoom

public Room getRoom(java.lang.String streamId)

Return registered room by provided stream. The room object must be registered to the service through the joinRoom(Room) method.

Parameters:

streamId - Stream Room ID as key to lookup registered room

Returns:

Room based on stream ID provided

getRoom

public Room getRoom(SymStream symStream)

Return registered room by provided stream. The room object must be registered to the service through the joinRoom(Room) method.

Parameters:

symStream - Stream ID as key to lookup registered room

Returns:

Room based on stream ID provided

joinRoom

public void joinRoom(Room room)
              throws RoomException

Logical join of the room which registers the listeners and the Room object to the service.

This call will also update room details within the Room object.

Parameters:

room - Room to register

Throws:

RoomException - Caused by room details that prevent logical monitoring of the room object

onMessage

public void onMessage(SymMessage symMessage)

Callback from registered room listener on the MessageService. All messages will be associated with Rooms. If a message underlying stream is not associated with a registered room, then a new room object is created and events are published to registered RoomServiceEventListener

Messages associated with registered rooms are published to room object listeners.

Specified by:

onMessage in interface RoomServiceEventListener

Parameters:

symMessage - Room messages detected and published

onSymRoomDeactivated

public void onSymRoomDeactivated(SymRoomDeactivated symRoomDeactivated)

Specified by:

onSymRoomDeactivated in interface RoomServiceEventListener

onSymRoomMemberDemotedFromOwner

public void onSymRoomMemberDemotedFromOwner(SymRoomMemberDemotedFromOwner symRoomMemberDemotedFromOwner)

Specified by:

onSymRoomMemberDemotedFromOwner in interface RoomServiceEventListener

onSymRoomMemberPromotedToOwner

public void onSymRoomMemberPromotedToOwner(SymRoomMemberPromotedToOwner symRoomMemberPromotedToOwner)

Specified by:

onSymRoomMemberPromotedToOwner in interface RoomServiceEventListener

onSymRoomReactivated

public void onSymRoomReactivated(SymRoomReactivated symRoomReactivated)

Specified by:

onSymRoomReactivated in interface RoomServiceEventListener

onSymRoomUpdated

public void onSymRoomUpdated(SymRoomUpdated symRoomUpdated)

Specified by:

onSymRoomUpdated in interface RoomServiceEventListener

onSymUserJoinedRoom

public void onSymUserJoinedRoom(SymUserJoinedRoom symUserJoinedRoom)

Specified by:

onSymUserJoinedRoom in interface RoomServiceEventListener

onSymUserLeftRoom

public void onSymUserLeftRoom(SymUserLeftRoom symUserLeftRoom)

Specified by:

onSymUserLeftRoom in interface RoomServiceEventListener

onSymRoomCreated

public void onSymRoomCreated(SymRoomCreated symRoomCreated)

Specified by:

onSymRoomCreated in interface RoomServiceEventListener

onNewRoom

public void onNewRoom(Room room)

Publish new room objects based on detection and/or registration to the service

Specified by:

onNewRoom in interface RoomServiceEventListener

Parameters:

room - Room object published from callback

addRoomServiceEventListener

public void addRoomServiceEventListener(RoomServiceEventListener roomServiceEventListener)

removeRoomServiceEventListener

public void removeRoomServiceEventListener(RoomServiceEventListener roomServiceEventListener)