org.jivesoftware.smack

Class Chat

java.lang.Object

org.jivesoftware.smack.Chat

public class Chat
extends java.lang.Object

A chat is a series of messages sent between two users. Each chat has a unique thread ID, which is used to track which messages are part of a particular conversation. Some messages are sent without a thread ID, and some clients don't send thread IDs at all. Therefore, if a message without a thread ID arrives it is routed to the most recently created Chat with the message sender.

Method Summary

Methods

Modifier and Type	Method and Description
void	addMessageListener(ChatMessageListener listener) Adds a packet listener that will be notified of any new messages in the chat.
void	close() Closes the Chat and removes all references to it from the ChatManager.
PacketCollector	createCollector() Creates a PacketCollector which will accumulate the Messages for this chat.
boolean	equals(java.lang.Object obj)
java.util.Collection<ChatMessageListener>	getListeners() Returns an unmodifiable collection of all of the listeners registered with this chat.
java.lang.String	getParticipant() Returns the name of the user the chat is with.
java.lang.String	getThreadID() Returns the thread id associated with this chat, which corresponds to the thread field of XMPP messages.
int	hashCode()
void	removeMessageListener(ChatMessageListener listener)
void	sendMessage(Message message) Sends a message to the other chat participant.
void	sendMessage(java.lang.String text) Sends the specified text as a message to the other chat participant.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getThreadID

public java.lang.String getThreadID()

Returns the thread id associated with this chat, which corresponds to the thread field of XMPP messages. This method may return null if there is no thread ID is associated with this Chat.

Returns:

the thread ID of this chat.

getParticipant

public java.lang.String getParticipant()

Returns the name of the user the chat is with.

Returns:

the name of the user the chat is occuring with.

sendMessage

public void sendMessage(java.lang.String text)
                 throws XMPPException,
                        SmackException.NotConnectedException

Sends the specified text as a message to the other chat participant. This is a convenience method for:

     Message message = chat.createMessage();
     message.setBody(messageText);
     chat.sendMessage(message);
 

Parameters:

text - the text to send.

Throws:

XMPPException - if sending the message fails.

SmackException.NotConnectedException

sendMessage

public void sendMessage(Message message)
                 throws SmackException.NotConnectedException

Sends a message to the other chat participant. The thread ID, recipient, and message type of the message will automatically set to those of this chat.

Parameters:

message - the message to send.

Throws:

SmackException.NotConnectedException

addMessageListener

public void addMessageListener(ChatMessageListener listener)

Adds a packet listener that will be notified of any new messages in the chat.

Parameters:

listener - a packet listener.

removeMessageListener

public void removeMessageListener(ChatMessageListener listener)

close

public void close()

Closes the Chat and removes all references to it from the ChatManager. The chat will be unusable when this method returns, so it's recommend to drop all references to the instance right after calling close().

getListeners

public java.util.Collection<ChatMessageListener> getListeners()

Returns an unmodifiable collection of all of the listeners registered with this chat.

Returns:

an unmodifiable collection of all of the listeners registered with this chat.

createCollector

public PacketCollector createCollector()

Creates a PacketCollector which will accumulate the Messages for this chat. Always cancel PacketCollectors when finished with them as they will accumulate messages indefinitely.

Returns:

the PacketCollector which returns Messages for this chat.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object