org.jivesoftware.smackx.receipts

Class DeliveryReceiptRequest

java.lang.Object

org.jivesoftware.smackx.receipts.DeliveryReceiptRequest

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

public class DeliveryReceiptRequest
extends Object
implements ExtensionElement

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT

Constructor Summary

Constructors

Constructor and Description
DeliveryReceiptRequest()

Method Summary

Modifier and Type	Method and Description
static String	addTo(Message message) Add a delivery receipt request to an outgoing packet.
static DeliveryReceiptRequest	from(Stanza packet) Get the DeliveryReceiptRequest extension of the packet, if any.
String	getElementName() Returns the root element name.
static DeliveryReceiptRequest	getFrom(Stanza p) Deprecated. use from(Stanza) instead
String	getNamespace() Returns the root element XML namespace.
String	toXML() 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

ELEMENT

public static final String ELEMENT

See Also:

Constant Field Values

Constructor Detail

DeliveryReceiptRequest

public DeliveryReceiptRequest()

Method Detail

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 String toXML()

Description copied from interface: Element

Returns the XML representation of this Element.

Specified by:

toXML in interface Element

Returns:

the stanza(/packet) extension as XML.

getFrom

@Deprecated
public static DeliveryReceiptRequest getFrom(Stanza p)

Deprecated. use from(Stanza) instead

Get the DeliveryReceiptRequest extension of the packet, if any.

Parameters:

p - the packet

Returns:

the DeliveryReceiptRequest extension or null

from

public static DeliveryReceiptRequest from(Stanza packet)

Get the DeliveryReceiptRequest extension of the packet, if any.

Parameters:

packet - the packet

Returns:

the DeliveryReceiptRequest extension or null

addTo

public static String addTo(Message message)

Add a delivery receipt request to an outgoing packet. Only message packets may contain receipt requests as of XEP-0184, therefore only allow Message as the parameter type.

Parameters:

message - Message object to add a request to

Returns:

the Message ID which will be used as receipt ID