org.jivesoftware.smack.chat

Class ChatManager

java.lang.Object

org.jivesoftware.smack.Manager

org.jivesoftware.smack.chat.ChatManager

public class ChatManager
extends Manager

The chat manager keeps track of references to all current chats. It will not hold any references in memory on its own so it is necessary to keep a reference to the chat object itself. To be made aware of new chats, register a listener by calling addChatListener(ChatManagerListener).

Author:

Alexander Wenckus

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChatManager.MatchMode Defines the different modes under which a match will be attempted with an existing chat when the incoming message does not have a thread id.

Method Summary

Modifier and Type	Method and Description
void	addChatListener(ChatManagerListener listener) Register a new listener with the ChatManager to recieve events related to chats.
void	addOutgoingMessageInterceptor(MessageListener messageInterceptor) Adds an interceptor which intercepts any messages sent through chats.
void	addOutgoingMessageInterceptor(MessageListener messageInterceptor, StanzaFilter filter)
Chat	createChat(String userJID) Creates a new chat and returns it.
Chat	createChat(String userJID, ChatMessageListener listener) Creates a new chat and returns it.
Chat	createChat(String userJID, String thread, ChatMessageListener listener) Creates a new chat using the specified thread ID, then returns it.
Set<ChatManagerListener>	getChatListeners() Returns an unmodifiable set of all chat listeners currently registered with this manager.
static ChatManager	getInstanceFor(XMPPConnection connection) Returns the ChatManager instance associated with a given XMPPConnection.
ChatManager.MatchMode	getMatchMode() Gets the current mode for matching messages with NO thread id to existing chats.
Chat	getThreadChat(String thread)
boolean	isNormalIncluded() Determines whether incoming messages of type normal will be used for creating new chats or matching a message to existing ones.
void	removeChatListener(ChatManagerListener listener) Removes a listener, it will no longer be notified of new events related to chats.
static void	setDefaultIsNormalIncluded(boolean allowNormal)
static void	setDefaultMatchMode(ChatManager.MatchMode mode)
void	setMatchMode(ChatManager.MatchMode matchMode) Sets the mode for matching messages with NO thread id to existing chats.
void	setNormalIncluded(boolean normalIncluded) Sets whether to allow incoming messages of type normal to be used for creating new chats or matching a message to an existing one.

Methods inherited from class org.jivesoftware.smack.Manager

connection

Methods inherited from class java.lang.Object

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

Method Detail

getInstanceFor

public static ChatManager getInstanceFor(XMPPConnection connection)

Returns the ChatManager instance associated with a given XMPPConnection.

Parameters:

connection - the connection used to look for the proper ServiceDiscoveryManager.

Returns:

the ChatManager associated with a given XMPPConnection.

isNormalIncluded

public boolean isNormalIncluded()

Determines whether incoming messages of type normal will be used for creating new chats or matching a message to existing ones.

Returns:

true if normal is allowed, false otherwise.

setNormalIncluded

public void setNormalIncluded(boolean normalIncluded)

Sets whether to allow incoming messages of type normal to be used for creating new chats or matching a message to an existing one.

Parameters:

normalIncluded - true to allow normal, false otherwise.

getMatchMode

public ChatManager.MatchMode getMatchMode()

Gets the current mode for matching messages with NO thread id to existing chats.

Returns:

The current mode.

setMatchMode

public void setMatchMode(ChatManager.MatchMode matchMode)

Sets the mode for matching messages with NO thread id to existing chats.

Parameters:

matchMode - The mode to set.

createChat

public Chat createChat(String userJID)

Creates a new chat and returns it.

Parameters:

userJID - the user this chat is with.

Returns:

the created chat.

createChat

public Chat createChat(String userJID,
                       ChatMessageListener listener)

Creates a new chat and returns it.

Parameters:

userJID - the user this chat is with.

listener - the optional listener which will listen for new messages from this chat.

Returns:

the created chat.

createChat

public Chat createChat(String userJID,
                       String thread,
                       ChatMessageListener listener)

Creates a new chat using the specified thread ID, then returns it.

Parameters:

userJID - the jid of the user this chat is with

thread - the thread of the created chat.

listener - the optional listener to add to the chat

Returns:

the created chat.

getThreadChat

public Chat getThreadChat(String thread)

addChatListener

public void addChatListener(ChatManagerListener listener)

Register a new listener with the ChatManager to recieve events related to chats.

Parameters:

listener - the listener.

removeChatListener

public void removeChatListener(ChatManagerListener listener)

Removes a listener, it will no longer be notified of new events related to chats.

Parameters:

listener - the listener that is being removed

getChatListeners

public Set<ChatManagerListener> getChatListeners()

Returns an unmodifiable set of all chat listeners currently registered with this manager.

Returns:

an unmodifiable collection of all chat listeners currently registered with this manager.

addOutgoingMessageInterceptor

public void addOutgoingMessageInterceptor(MessageListener messageInterceptor)

Adds an interceptor which intercepts any messages sent through chats.

Parameters:

messageInterceptor - the interceptor.

addOutgoingMessageInterceptor

public void addOutgoingMessageInterceptor(MessageListener messageInterceptor,
                                          StanzaFilter filter)

setDefaultMatchMode

public static void setDefaultMatchMode(ChatManager.MatchMode mode)

setDefaultIsNormalIncluded

public static void setDefaultIsNormalIncluded(boolean allowNormal)