org.jivesoftware.smackx.receipts

Class DeliveryReceipt

java.lang.Object

org.jivesoftware.smackx.receipts.DeliveryReceipt

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

public class DeliveryReceipt
extends Object
implements ExtensionElement

Represents a message delivery receipt entry as specified by Message Delivery Receipts.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeliveryReceipt.Provider This Provider parses and returns DeliveryReceipt packets.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT
static String	NAMESPACE

Constructor Summary

Constructors

Constructor and Description
DeliveryReceipt(String id)

Method Summary

Modifier and Type	Method and Description
static DeliveryReceipt	from(Message message) Get the DeliveryReceipt extension of the message, if any.
String	getElementName() Returns the root element name.
static DeliveryReceipt	getFrom(Message p) Deprecated. use from(Message) instead
String	getId() Get the id of the message that has been delivered.
String	getNamespace() Returns the root element XML namespace.
XmlStringBuilder	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

Field Detail

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

ELEMENT

public static final String ELEMENT

See Also:

Constant Field Values

Constructor Detail

DeliveryReceipt

public DeliveryReceipt(String id)

Method Detail

getId

public String getId()

Get the id of the message that has been delivered.

Returns:

id of the delivered message or null.

getElementName

public String getElementName()

Description copied from interface: NamedElement

Returns the root element name.

Specified by:

getElementName in interface NamedElement

Returns:

the element name.

getNamespace

public String getNamespace()

Description copied from interface: ExtensionElement

Returns the root element XML namespace.

Specified by:

getNamespace in interface ExtensionElement

Returns:

the namespace.

toXML

public XmlStringBuilder 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.

getFrom

@Deprecated
public static DeliveryReceipt getFrom(Message p)

Deprecated. use from(Message) instead

Get the DeliveryReceipt extension of the packet, if any.

Parameters:

p - the packet

Returns:

the DeliveryReceipt extension or null

from

public static DeliveryReceipt from(Message message)

Get the DeliveryReceipt extension of the message, if any.

Parameters:

message - the message.

Returns:

the DeliveryReceipt extension or null