org.symphonyoss.client.services

Class ChatService

java.lang.Object

org.symphonyoss.client.services.ChatService

All Implemented Interfaces:

ChatListener

public class ChatService
extends java.lang.Object
implements ChatListener

The chat service provides capabilities to construct and monitor chat conversations. Supports the ability to add chat conversations which are validated and enriched. Supports the creation and callback of new chat conversations from incoming messages.

NOTE: Multi-party conversations that are constructed via incoming messages are enriched over time. Currently there is no way of identifying all users of an incoming message from a given stream.

Constructor Summary

Constructors

Constructor and Description
ChatService(SymphonyClient symClient) Init

Method Summary

Modifier and Type	Method and Description
boolean	addChat(Chat chat) Add a predefined chat to the service.
boolean	addListener(ChatServiceListener chatServiceListener)
Chat	getChatByStream(java.lang.String streamId) Get a given Chat by streamId
java.util.Set<Chat>	getChats(SymUser user) Return a set of chats for a given user
java.util.Set<Chat>	getChatsByEmail(java.lang.String email) Returns a set of chats from a given email address (resolved to UserID).
void	onChatMessage(SymMessage symMessage) Process incoming message from ChatListener
boolean	registerListener(ChatServiceListener chatServiceListener) Deprecated.
boolean	removeChat(Chat chat) Remove Chat conversation
boolean	removeListener(ChatServiceListener chatServiceListener)

Methods inherited from class java.lang.Object

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

Constructor Detail

ChatService

public ChatService(SymphonyClient symClient)

Init

Parameters:

symClient - Symphony Client required to access all underlying clients functions.

Method Detail

addChat

public boolean addChat(Chat chat)

Add a predefined chat to the service. RemoteUsers are required and streams will be generated and verified, so if one of the remote users are not connected to the BOT this will fail and return false.

Note: In the future response object will be available to provide additional detail.

Parameters:

chat - Chat with remote users defined. Stream not required and will be generated.

Returns:

True if chat has been verified and accepted.

removeChat

public boolean removeChat(Chat chat)

Remove Chat conversation

Parameters:

chat - Chat object to remove

Returns:

Removed chat

onChatMessage

public void onChatMessage(SymMessage symMessage)

Process incoming message from ChatListener

Specified by:

onChatMessage in interface ChatListener

Parameters:

symMessage - Incoming SymMessage

registerListener

@Deprecated
public boolean registerListener(ChatServiceListener chatServiceListener)

Deprecated.

Please use addListener(ChatServiceListener)

Parameters:

chatServiceListener - ChatServiceListener

Returns:

True if successful.

addListener

public boolean addListener(ChatServiceListener chatServiceListener)

Parameters:

chatServiceListener - ChatServiceListener

Returns:

True if successful.

removeListener

public boolean removeListener(ChatServiceListener chatServiceListener)

Parameters:

chatServiceListener - ChatServiceListener

Returns:

True if successful

getChatsByEmail

public java.util.Set<Chat> getChatsByEmail(java.lang.String email)

Returns a set of chats from a given email address (resolved to UserID). This can be BOT or users that the BOT is communicating with.

Parameters:

email - User email

Returns:

A set of Chats associated with the given user.

getChats

public java.util.Set<Chat> getChats(SymUser user)

Return a set of chats for a given user

Parameters:

user - SymUser

Returns:

A set of Chats associated with the given user.

getChatByStream

public Chat getChatByStream(java.lang.String streamId)

Get a given Chat by streamId

Parameters:

streamId - Stream ID

Returns:

A Chat