org.jivesoftware.smackx.carbons

Class CarbonManager

java.lang.Object

org.jivesoftware.smack.Manager

org.jivesoftware.smackx.carbons.CarbonManager

public class CarbonManager
extends org.jivesoftware.smack.Manager

Stanza(/Packet) extension for XEP-0280: Message Carbons. This class implements the manager for registering CarbonExtension support, enabling and disabling message carbons. You should call enableCarbons() before sending your first undirected presence.

Method Summary

Modifier and Type	Method and Description
void	disableCarbons() Helper method to disable carbons.
static void	disableCarbons(org.jivesoftware.smack.packet.Message msg) Deprecated. use CarbonExtension.Private.addTo(Message)
void	enableCarbons() Helper method to enable carbons.
boolean	getCarbonsEnabled() Check if carbons are enabled on this connection.
static CarbonManager	getInstanceFor(org.jivesoftware.smack.XMPPConnection connection) Obtain the CarbonManager responsible for a connection.
boolean	isSupportedByServer() Returns true if XMPP Carbons are supported by the server.
void	sendCarbonsEnabled(boolean new_state) Notify server to change the carbons state.
void	setCarbonsEnabled(boolean new_state) Notify server to change the carbons state.

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 CarbonManager getInstanceFor(org.jivesoftware.smack.XMPPConnection connection)

Obtain the CarbonManager responsible for a connection.

Parameters:

connection - the connection object.

Returns:

a CarbonManager instance

isSupportedByServer

public boolean isSupportedByServer()
                            throws org.jivesoftware.smack.SmackException.NoResponseException,
                                   org.jivesoftware.smack.XMPPException.XMPPErrorException,
                                   org.jivesoftware.smack.SmackException.NotConnectedException

Returns true if XMPP Carbons are supported by the server.

Returns:

true if supported

Throws:

org.jivesoftware.smack.SmackException.NotConnectedException

org.jivesoftware.smack.XMPPException.XMPPErrorException

org.jivesoftware.smack.SmackException.NoResponseException

sendCarbonsEnabled

public void sendCarbonsEnabled(boolean new_state)
                        throws org.jivesoftware.smack.SmackException.NotConnectedException

Notify server to change the carbons state. This method returns immediately and changes the variable when the reply arrives. You should first check for support using isSupportedByServer().

Parameters:

new_state - whether carbons should be enabled or disabled

Throws:

org.jivesoftware.smack.SmackException.NotConnectedException

setCarbonsEnabled

public void setCarbonsEnabled(boolean new_state)
                       throws org.jivesoftware.smack.SmackException.NoResponseException,
                              org.jivesoftware.smack.XMPPException.XMPPErrorException,
                              org.jivesoftware.smack.SmackException.NotConnectedException

Notify server to change the carbons state. This method blocks some time until the server replies to the IQ and returns true on success. You should first check for support using isSupportedByServer().

Parameters:

new_state - whether carbons should be enabled or disabled

Throws:

org.jivesoftware.smack.XMPPException.XMPPErrorException

org.jivesoftware.smack.SmackException.NoResponseException

org.jivesoftware.smack.SmackException.NotConnectedException

enableCarbons

public void enableCarbons()
                   throws org.jivesoftware.smack.XMPPException,
                          org.jivesoftware.smack.SmackException

Helper method to enable carbons.

Throws:

org.jivesoftware.smack.XMPPException

org.jivesoftware.smack.SmackException - if there was no response from the server.

disableCarbons

public void disableCarbons()
                    throws org.jivesoftware.smack.XMPPException,
                           org.jivesoftware.smack.SmackException

Helper method to disable carbons.

Throws:

org.jivesoftware.smack.XMPPException

org.jivesoftware.smack.SmackException - if there was no response from the server.

getCarbonsEnabled

public boolean getCarbonsEnabled()

Check if carbons are enabled on this connection.

disableCarbons

@Deprecated
public static void disableCarbons(org.jivesoftware.smack.packet.Message msg)

Deprecated. use CarbonExtension.Private.addTo(Message)

Mark a message as "private", so it will not be carbon-copied.

Parameters:

msg - Message object to mark private