Package org.jivesoftware.smackx.receipts

Class DeliveryReceiptRequest

  • 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 DeliveryReceiptRequest
extends java.lang.Object
implements org.jivesoftware.smack.packet.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 java.lang.String ELEMENT  
      static java.lang.String NAMESPACE  
      static javax.xml.namespace.QName QNAME  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static java.lang.String addTo​(org.jivesoftware.smack.packet.Message message)
      Add a delivery receipt request to an outgoing packet.
      static void addTo​(org.jivesoftware.smack.packet.MessageBuilder messageBuilder)
      Add a delivery receipt request to an outgoing packet.
      static DeliveryReceiptRequest from​(org.jivesoftware.smack.packet.Stanza packet)
      Get the DeliveryReceiptRequest extension of the packet, if any.
      java.lang.String getElementName()  
      static DeliveryReceiptRequest getFrom​(org.jivesoftware.smack.packet.Stanza p)
      Deprecated.
      use from(Stanza) instead
      java.lang.String getNamespace()  
      java.lang.String toXML​(org.jivesoftware.smack.packet.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.FullyQualifiedElement

        getLanguage, getQName

    • Field Detail

      • QNAME

        public static final javax.xml.namespace.QName QNAME

    • Constructor Detail

      • DeliveryReceiptRequest

        public DeliveryReceiptRequest()

    • Method Detail

      • getElementName

        public java.lang.String getElementName()
        Specified by:
        getElementName in interface org.jivesoftware.smack.packet.NamedElement

      • getNamespace

        public java.lang.String getNamespace()
        Specified by:
        getNamespace in interface org.jivesoftware.smack.packet.FullyQualifiedElement

      • toXML

        public java.lang.String toXML​(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace)
        Specified by:
        toXML in interface org.jivesoftware.smack.packet.Element

      • addTo

        public static java.lang.String addTo​(org.jivesoftware.smack.packet.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​(org.jivesoftware.smack.packet.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