org.symphonyoss.client.services

Class MessageService

java.lang.Object

org.symphonyoss.client.services.MessageService

public class MessageService
extends java.lang.Object

MessageService listens for all messages for a given BOT identity, identifies the type (Message, Chat, Room) of message and then publishes the message registered listeners associated with type.

The service exposes methods for retrieving messages for a given stream or user historically.

The service provides convenience methods to support the sending of messages using standard models (Chat, Room)

The service converts all base messages to SymMessage.

Multiple listeners of different types can be registered at any time.

MessageListener - Listen for all messages ChatListener - Listen for chat conversations (1:1 or multi-party) RoomServiceListener - Listen for all Room related events.

Constructor Summary

Constructors

Constructor and Description
MessageService(SymphonyClient symClient) Constructor

Method Summary

Modifier and Type	Method and Description
void	addChatListener(ChatListener chatListener) Add ChatListener to receive new conversation chat messages
void	addConnectionsEventListener(ConnectionsEventListener connectionsEventListener) Add ConnectionsEventListener to service to receive new Connection events
void	addMessageListener(MessageListener messageListener) Add MessageListener to receive for all new messages
void	addRoomServiceEventListener(RoomServiceEventListener roomServiceEventListener) Add RoomServiceEventListener to service to receive new Room events
java.util.List<SymMessage>	getMessagesFromUserId(long userId, java.lang.Long since, java.lang.Integer offset, java.lang.Integer maxMessages) Retrieve messages for a given user ID based on window of time
void	onEvent(SymEvent symEvent) Listen to all events from datafeed polling This is only enabled when V4+ API is being used.
boolean	removeChatListener(ChatListener chatListener) Remove a registered chat listener
boolean	removeConnectionsEventListener(ConnectionsEventListener connectionsEventListener) Remove connections event listener from service
boolean	removeMessageListener(MessageListener messageListener) Remove a registered MessageListener t
boolean	removeRoomServiceEventListener(RoomServiceEventListener roomServiceEventListener) Remove room event listener from service
SymMessage	sendMessage(Chat chat, SymMessage symMessage) Convenience method for sending messages to chat conversation (1:1 or Multi-party)
SymMessage	sendMessage(Room room, SymMessage symMessage) Convenience method for sending messages to a room
SymMessage	sendMessage(java.lang.String email, SymMessage symMessage) Convenience method to send a message to a given user by email address
SymMessage	sendMessage(SymStream symStream, SymMessage symMessage) Send a message to a given stream
SymMessage	sendMessage(SymUser symUser, SymMessage symMessage) Send a message to a given user
void	shutdown() Shutdown the underlying threads and workers.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageService

public MessageService(SymphonyClient symClient)

Constructor

Parameters:

symClient - Identifies the BOT user and exposes client APIs

Method Detail

sendMessage

public SymMessage sendMessage(Room room,
                              SymMessage symMessage)
                       throws MessagesException

Convenience method for sending messages to a room

Parameters:

room - Room object

symMessage - Message to send to the room

Returns:

Symphony message

Throws:

MessagesException - Generated from API calls into Symphony

sendMessage

public SymMessage sendMessage(Chat chat,
                              SymMessage symMessage)
                       throws MessagesException

Convenience method for sending messages to chat conversation (1:1 or Multi-party)

Parameters:

chat - Chat object representing conversation

symMessage - Message to send to the conversation

Returns:

Symphony Message

Throws:

MessagesException - Generated from API calls into Symphony

sendMessage

public SymMessage sendMessage(java.lang.String email,
                              SymMessage symMessage)
                       throws MessagesException

Convenience method to send a message to a given user by email address

Parameters:

email - email of destination user

symMessage - Message to send

Returns:

Symphony message

Throws:

MessagesException - Generated from API calls into Symphony

sendMessage

public SymMessage sendMessage(SymUser symUser,
                              SymMessage symMessage)
                       throws MessagesException

Send a message to a given user

Parameters:

symUser - User to send message to

symMessage - Message to send

Returns:

Symphony message

Throws:

MessagesException - Generated from API calls into Symphony

sendMessage

public SymMessage sendMessage(SymStream symStream,
                              SymMessage symMessage)
                       throws MessagesException

Send a message to a given stream

Parameters:

symStream - Stream to send message to

symMessage - Message to send

Returns:

Symphony message

Throws:

MessagesException - Generated from API calls into Symphony

getMessagesFromUserId

public java.util.List<SymMessage> getMessagesFromUserId(long userId,
                                                        java.lang.Long since,
                                                        java.lang.Integer offset,
                                                        java.lang.Integer maxMessages)
                                                 throws MessagesException

Retrieve messages for a given user ID based on window of time

Parameters:

userId - A userId (long value)

since - Starting point date (long value)

offset - (Optional) No. of messages to skip.

maxMessages - (Optional) Maximum number of messages to retrieve from the starting point

Returns:

List List of messages

Throws:

MessagesException - Generated from API calls into Symphony

onEvent

public void onEvent(SymEvent symEvent)

Listen to all events from datafeed polling This is only enabled when V4+ API is being used.

Parameters:

symEvent - Events received from datafeed polling

addMessageListener

public void addMessageListener(MessageListener messageListener)

Add MessageListener to receive for all new messages

Parameters:

messageListener - listener that will be notified of events

removeMessageListener

public boolean removeMessageListener(MessageListener messageListener)

Remove a registered MessageListener t

Parameters:

messageListener - listener that will removed from service

Returns:

True if listener is removed

addRoomServiceEventListener

public void addRoomServiceEventListener(RoomServiceEventListener roomServiceEventListener)

Add RoomServiceEventListener to service to receive new Room events

Parameters:

roomServiceEventListener - listener to register

removeRoomServiceEventListener

public boolean removeRoomServiceEventListener(RoomServiceEventListener roomServiceEventListener)

Remove room event listener from service

Parameters:

roomServiceEventListener - listener to remove

Returns:

True if listener is removed

addConnectionsEventListener

public void addConnectionsEventListener(ConnectionsEventListener connectionsEventListener)

Add ConnectionsEventListener to service to receive new Connection events

Parameters:

connectionsEventListener - listener to register

removeConnectionsEventListener

public boolean removeConnectionsEventListener(ConnectionsEventListener connectionsEventListener)

Remove connections event listener from service

Parameters:

connectionsEventListener - listener to remove

Returns:

True if listener is removed

addChatListener

public void addChatListener(ChatListener chatListener)

Add ChatListener to receive new conversation chat messages

Parameters:

chatListener - listener to register

removeChatListener

public boolean removeChatListener(ChatListener chatListener)

Remove a registered chat listener

Parameters:

chatListener - listener to remove

Returns:

True if listener is registered

shutdown

public void shutdown()

Shutdown the underlying threads and workers.