Receipt Class Reference

An implementation of Message Receipts (XEP-0184) as a StanzaExtension. More...

#include <receipt.h>

Inherits StanzaExtension.

Inheritance diagram for Receipt:

[legend]List of all members.

Public Types
enum	ReceiptType { Request, Received, Invalid }
Public Member Functions
	Receipt (const Tag *tag)
	Receipt (ReceiptType rcpt)
virtual	~Receipt ()
ReceiptType	rcpt () const
virtual const std::string &	filterString () const
virtual StanzaExtension *	newInstance (const Tag *tag) const
Tag *	tag () const
virtual StanzaExtension *	clone () const

---

Detailed Description

An implementation of Message Receipts (XEP-0184) as a StanzaExtension.

Author:

Jakob Schroeter <js@camaya.net>

Since:

1.0

Definition at line 32 of file receipt.h.

---

Member Enumeration Documentation

enum ReceiptType

Contains valid receipt types (XEP-0184). Enumeration values: Request  Requests a receipt. Received  The receipt. Invalid  Invalid type. Definition at line 38 of file receipt.h.

---

Constructor & Destructor Documentation

Receipt (  const Tag *  tag  )

Constructs a new object from the given Tag. Parameters: tag  A Tag to parse. Definition at line 31 of file receipt.cpp.

Receipt (  ReceiptType  rcpt  )  [inline]

Constructs a new object of the given type. Parameters: rcpt  The receipt type. Definition at line 55 of file receipt.h.

virtual ~Receipt (   )  [inline, virtual]

Virtual destructor. Definition at line 62 of file receipt.h.

---

Member Function Documentation

virtual StanzaExtension* clone (   )  const [inline, virtual]

Returns an identical copy of the current StanzaExtension. Returns: An identical copy of the current StanzaExtension. Implements StanzaExtension. Definition at line 83 of file receipt.h.

const std::string & filterString (   )  const [virtual]

Returns an XPath expression that describes a path to child elements of a stanza that an extension handles. Returns: The extension's filter string. Implements StanzaExtension. Definition at line 37 of file receipt.cpp.

virtual StanzaExtension* newInstance (  const Tag *  tag  )  const [inline, virtual]

Returns a new Instance of the derived type. Usually, for a derived class FooExtension, the implementation of this function looks like: StanzaExtension* FooExtension::newInstance( const Tag* tag ) const { return new FooExtension( tag ); } Returns: The derived extension's new instance. Implements StanzaExtension. Definition at line 74 of file receipt.h.

ReceiptType rcpt (   )  const [inline]

Returns the object's state. Returns: The object's state. Definition at line 68 of file receipt.h.

Tag * tag (   )  const [virtual]

Returns a Tag representation of the extension. Returns: A Tag representation of the extension. Implements StanzaExtension. Definition at line 45 of file receipt.cpp.

---

The documentation for this class was generated from the following files:

• receipt.h
• receipt.cpp

---