Package org.jivesoftware.smackx.receipts

Class DeliveryReceiptRequest

java.lang.Object

org.jivesoftware.smackx.receipts.DeliveryReceiptRequest

All Implemented Interfaces:

Element, ExtensionElement, NamedElement, XmlElement, XmlLangElement

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	Description
static class	DeliveryReceiptRequest.Provider	This Provider parses and returns DeliveryReceiptRequest packets.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
DeliveryReceiptRequest()

Method Summary

Modifier and Type	Method	Description
static String	addTo(Message message)	Add a delivery receipt request to an outgoing packet.
static void	addTo(MessageBuilder messageBuilder)	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(XmlEnvironment enclosingNamespace)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jivesoftware.smack.packet.Element

toXML, toXML

Methods inherited from interface org.jivesoftware.smack.packet.XmlElement

getLanguage, getQName

Field Detail

ELEMENT

public static final String ELEMENT

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

QNAME

public static final QName QNAME

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: XmlElement

Returns the root element XML namespace.

Specified by:

getNamespace in interface XmlElement

Returns:

the namespace.

toXML

public String toXML(XmlEnvironment enclosingNamespace)

Specified by:

toXML in interface Element

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

addTo

public static void addTo(MessageBuilder messageBuilder)

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:

messageBuilder - Message object to add a request to