Class CarbonExtension
- java.lang.Object
-
- org.jivesoftware.smackx.carbons.packet.CarbonExtension
-
- All Implemented Interfaces:
org.jivesoftware.smack.packet.Element
,org.jivesoftware.smack.packet.ExtensionElement
,org.jivesoftware.smack.packet.FullyQualifiedElement
,org.jivesoftware.smack.packet.NamedElement
,org.jivesoftware.smack.packet.XmlLangElement
public class CarbonExtension extends java.lang.Object implements org.jivesoftware.smack.packet.ExtensionElement
Stanza extension for XEP-0280: Message Carbons. The extension XEP-0280 is meant to synchronize a message flow to multiple presences of a user.It accomplishes this by wrapping a
Forwarded
stanza in a sent or received element
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CarbonExtension.Direction
Defines the direction of aCarbonExtension
message.static class
CarbonExtension.Private
Stanza extension indicating that a message may not be carbon-copied.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
NAMESPACE
-
Constructor Summary
Constructors Constructor Description CarbonExtension(CarbonExtension.Direction dir, org.jivesoftware.smackx.forward.packet.Forwarded<org.jivesoftware.smack.packet.Message> fwd)
Construct a Carbon message extension.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static CarbonExtension
from(org.jivesoftware.smack.packet.Message msg)
Obtain a Carbon from a message, if available.CarbonExtension.Direction
getDirection()
Get the direction (sent or received) of the carbon.java.lang.String
getElementName()
org.jivesoftware.smackx.forward.packet.Forwarded<org.jivesoftware.smack.packet.Message>
getForwarded()
Get the forwarded packet.static CarbonExtension
getFrom(org.jivesoftware.smack.packet.Message msg)
Deprecated.usefrom(Message)
insteadjava.lang.String
getNamespace()
org.jivesoftware.smack.util.XmlStringBuilder
toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace)
-
-
-
Field Detail
-
NAMESPACE
public static final java.lang.String NAMESPACE
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CarbonExtension
public CarbonExtension(CarbonExtension.Direction dir, org.jivesoftware.smackx.forward.packet.Forwarded<org.jivesoftware.smack.packet.Message> fwd)
Construct a Carbon message extension.- Parameters:
dir
- Determines if the carbon is being sent/receivedfwd
- The forwarded message.
-
-
Method Detail
-
getDirection
public CarbonExtension.Direction getDirection()
Get the direction (sent or received) of the carbon.- Returns:
- the
CarbonExtension.Direction
of the carbon.
-
getForwarded
public org.jivesoftware.smackx.forward.packet.Forwarded<org.jivesoftware.smack.packet.Message> getForwarded()
Get the forwarded packet.- Returns:
- the
Forwarded
message contained in this Carbon.
-
getElementName
public java.lang.String getElementName()
- Specified by:
getElementName
in interfaceorg.jivesoftware.smack.packet.NamedElement
-
getNamespace
public java.lang.String getNamespace()
- Specified by:
getNamespace
in interfaceorg.jivesoftware.smack.packet.FullyQualifiedElement
-
toXML
public org.jivesoftware.smack.util.XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace)
- Specified by:
toXML
in interfaceorg.jivesoftware.smack.packet.Element
-
getFrom
@Deprecated public static CarbonExtension getFrom(org.jivesoftware.smack.packet.Message msg)
Deprecated.usefrom(Message)
insteadObtain a Carbon from a message, if available.Only
Message
instances can contain a Carbon extensions.- Parameters:
msg
- Message object to check for carbons- Returns:
- a Carbon if available, null otherwise.
-
from
public static CarbonExtension from(org.jivesoftware.smack.packet.Message msg)
Obtain a Carbon from a message, if available.Only
Message
instances can contain a Carbon extensions.- Parameters:
msg
- Message object to check for carbons- Returns:
- a Carbon if available, null otherwise.
-
-