org.symphonyoss.client.model

Class Chat

java.lang.Object

org.symphonyoss.client.model.Chat

public class Chat
extends java.lang.Object

Chat is a core model that defines an active conversation between users. It includes the ability to register ChatListener callbacks, which are monitored by the ChatService. Once defined, make sure to add the chat model to the ChatService in order to receive events when a listeners are defined.

Constructor Summary

Constructors

Constructor and Description
Chat()

Method Summary

Modifier and Type	Method and Description
boolean	addListener(ChatListener chatListener) Add Chat listeners.
boolean	equals(java.lang.Object obj)
SymMessage	getLastMessage()
SymUser	getLocalUser()
java.util.Set<SymUser>	getRemoteUsers()
SymStream	getStream()
java.lang.String	getStreamId()
int	hashCode()
void	onChatMessage(SymMessage message) Push message to all registered listeners.
boolean	registerListener(ChatListener chatListener) Deprecated.
boolean	removeListener(ChatListener chatListener) Remove a specific listener
void	setLastMessage(SymMessage lastMessage) Sometimes you want to have the last message...just in case!
void	setLocalUser(SymUser localUser)
void	setRemoteUsers(java.util.Set<SymUser> remoteUsers)
void	setStream(SymStream stream)
void	setStreamId(java.lang.String streamId)

Methods inherited from class java.lang.Object

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

Constructor Detail

Chat

public Chat()

Method Detail

getStreamId

public java.lang.String getStreamId()

Returns:

current stream ID for chat session

setStreamId

public void setStreamId(java.lang.String streamId)

getRemoteUsers

public java.util.Set<SymUser> getRemoteUsers()

setRemoteUsers

public void setRemoteUsers(java.util.Set<SymUser> remoteUsers)

getLocalUser

public SymUser getLocalUser()

setLocalUser

public void setLocalUser(SymUser localUser)

getStream

public SymStream getStream()

setStream

public void setStream(SymStream stream)

onChatMessage

public void onChatMessage(SymMessage message)

Push message to all registered listeners.

Parameters:

message - Message

registerListener

@Deprecated
public boolean registerListener(ChatListener chatListener)

Deprecated.

Register Chat listeners. A chat can have more than one listener at any time. Please use addListener(ChatListener)

Parameters:

chatListener - Listener to register

Returns:

Success

addListener

public boolean addListener(ChatListener chatListener)

Add Chat listeners. A chat can have more than one listener at any time.

Parameters:

chatListener - Listener to add

Returns:

Success

removeListener

public boolean removeListener(ChatListener chatListener)

Remove a specific listener

Parameters:

chatListener - Listener to remove

Returns:

True if listener was removed

getLastMessage

public SymMessage getLastMessage()

setLastMessage

public void setLastMessage(SymMessage lastMessage)

Sometimes you want to have the last message...just in case!

Parameters:

lastMessage - Last message recorded

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object