org.jivesoftware.smackx.offline.packet

Class OfflineMessageInfo

java.lang.Object

org.jivesoftware.smackx.offline.packet.OfflineMessageInfo

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

public class OfflineMessageInfo
extends Object
implements ExtensionElement

OfflineMessageInfo is an extension included in the retrieved offline messages requested by the OfflineMessageManager. This extension includes a stamp that uniquely identifies the offline message. This stamp may be used for deleting the offline message. The stamp may be of the form UTC timestamps but it is not required to have that format.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OfflineMessageInfo.Provider

Constructor Summary

Constructors

Constructor and Description
OfflineMessageInfo()

Method Summary

Modifier and Type	Method and Description
String	getElementName() Returns the XML element name of the extension sub-packet root element.
String	getNamespace() Returns the XML namespace of the extension sub-packet root element.
String	getNode() Returns the stamp that uniquely identifies the offline message.
void	setNode(String node) Sets the stamp that uniquely identifies the offline message.
String	toXML(String enclosingNamespace) Returns the XML representation of this Element.

Methods inherited from class java.lang.Object

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

Constructor Detail

OfflineMessageInfo

public OfflineMessageInfo()

Method Detail

getElementName

public String getElementName()

Returns the XML element name of the extension sub-packet root element. Always returns "offline"

Specified by:

getElementName in interface NamedElement

Returns:

the XML element name of the stanza extension.

getNamespace

public String getNamespace()

Returns the XML namespace of the extension sub-packet root element. According the specification the namespace is always "http://jabber.org/protocol/offline"

Specified by:

getNamespace in interface ExtensionElement

Returns:

the XML namespace of the stanza extension.

getNode

public String getNode()

Returns the stamp that uniquely identifies the offline message. This stamp may be used for deleting the offline message. The stamp may be of the form UTC timestamps but it is not required to have that format.

Returns:

the stamp that uniquely identifies the offline message.

setNode

public void setNode(String node)

Sets the stamp that uniquely identifies the offline message. This stamp may be used for deleting the offline message. The stamp may be of the form UTC timestamps but it is not required to have that format.

Parameters:

node - the stamp that uniquely identifies the offline message.

toXML

public String toXML(String enclosingNamespace)

Description copied from interface: Element

Returns the XML representation of this Element. This method takes an optional argument for the enclosing namespace which may be null or the empty String if the value is not known.

Specified by:

toXML in interface Element

Parameters:

enclosingNamespace - the enclosing namespace or null.

Returns:

the stanza extension as XML.