Package org.jivesoftware.smackx.chat_markers

Class ChatMarkersManager

java.lang.Object

org.jivesoftware.smack.Manager

org.jivesoftware.smackx.chat_markers.ChatMarkersManager

public final class ChatMarkersManager
extends Manager

Chat Markers Manager class (XEP-0333).

See Also:

XEP-0333: Chat Markers

Method Summary

Modifier and Type	Method	Description
boolean	addIncomingChatMarkerMessageListener(ChatMarkersListener listener)	Register a ChatMarkersListener.
static ChatMarkersManager	getInstanceFor(XMPPConnection connection)	Get the singleton instance of ChatMarkersManager.
boolean	isSupportedByServer()	Returns true if Chat Markers is supported by the server.
boolean	removeIncomingChatMarkerMessageListener(ChatMarkersListener listener)	Unregister a ChatMarkersListener.

Methods inherited from class org.jivesoftware.smack.Manager

connection, getAuthenticatedConnectionOrThrow, schedule, schedule, scheduleBlocking

Methods inherited from class java.lang.Object

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

Method Detail

getInstanceFor

public static ChatMarkersManager getInstanceFor(XMPPConnection connection)

Get the singleton instance of ChatMarkersManager.

Parameters:

connection - the connection used to get the ChatMarkersManager instance.

Returns:

the instance of ChatMarkersManager

isSupportedByServer

public boolean isSupportedByServer()
                            throws SmackException.NoResponseException,
                                   XMPPException.XMPPErrorException,
                                   SmackException.NotConnectedException,
                                   InterruptedException

Returns true if Chat Markers is supported by the server.

Returns:

true if Chat Markers is supported by the server.

Throws:

SmackException.NotConnectedException - if the connection is not connected.

XMPPException.XMPPErrorException - in case an error response was received.

SmackException.NoResponseException - if no response was received.

InterruptedException - if the connection is interrupted.

addIncomingChatMarkerMessageListener

public boolean addIncomingChatMarkerMessageListener(ChatMarkersListener listener)

Register a ChatMarkersListener. That listener will be informed about new incoming markable messages.

Parameters:

listener - ChatMarkersListener

Returns:

true, if the listener was not registered before

removeIncomingChatMarkerMessageListener

public boolean removeIncomingChatMarkerMessageListener(ChatMarkersListener listener)

Unregister a ChatMarkersListener.

Parameters:

listener - ChatMarkersListener

Returns:

true, if the listener was registered before