An implementation of Message Receipts (XEP-0184) as a StanzaExtension. More...
#include <receipt.h>
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.
- Since:
- 1.0
Member Enumeration Documentation
| enum ReceiptType |
Constructor & Destructor Documentation
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] |
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.
| 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.
| ReceiptType rcpt | ( | ) | const [inline] |
| 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:
