96 lines
2.2 KiB
C
96 lines
2.2 KiB
C
|
/*
|
||
|
|
Copyright (c) 2007-2009 by Jakob Schroeter <js@camaya.net>
|
||
|
|
This file is part of the gloox library. http://camaya.net/gloox
|
||
|
|
|
||
|
|
This software is distributed under a license. The full license
|
||
|
|
agreement can be found in the file LICENSE in this distribution.
|
||
|
|
This software may not be copied, modified, sold or distributed
|
||
|
|
other than expressed in the named license agreement.
|
||
|
|
|
||
|
|
This software is distributed without any warranty.
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef RECEIPT_H__
|
||
|
|
#define RECEIPT_H__
|
||
|
|
|
||
|
|
#include "gloox.h"
|
||
|
|
#include "stanzaextension.h"
|
||
|
|
|
||
|
|
#include <string>
|
||
|
|
|
||
|
|
namespace gloox
|
||
|
|
{
|
||
|
|
|
||
|
|
class Tag;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief An implementation of Message Receipts (XEP-0184) as a StanzaExtension.
|
||
|
|
*
|
||
|
|
* @author Jakob Schroeter <js@camaya.net>
|
||
|
|
* @since 1.0
|
||
|
|
*/
|
||
|
|
class GLOOX_API Receipt : public StanzaExtension
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
/**
|
||
|
|
* Contains valid receipt types (XEP-0184).
|
||
|
|
*/
|
||
|
|
enum ReceiptType
|
||
|
|
{
|
||
|
|
Request, /**< Requests a receipt. */
|
||
|
|
Received, /**< The receipt. */
|
||
|
|
Invalid /**< Invalid type. */
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Constructs a new object from the given Tag.
|
||
|
|
* @param tag A Tag to parse.
|
||
|
|
*/
|
||
|
|
Receipt( const Tag* tag );
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Constructs a new object of the given type.
|
||
|
|
* @param rcpt The receipt type.
|
||
|
|
*/
|
||
|
|
Receipt( ReceiptType rcpt )
|
||
|
|
: StanzaExtension( ExtReceipt ), m_rcpt( rcpt )
|
||
|
|
{}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Virtual destructor.
|
||
|
|
*/
|
||
|
|
virtual ~Receipt() {}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the object's state.
|
||
|
|
* @return The object's state.
|
||
|
|
*/
|
||
|
|
ReceiptType rcpt() const { return m_rcpt; }
|
||
|
|
|
||
|
|
// reimplemented from StanzaExtension
|
||
|
|
virtual const std::string& filterString() const;
|
||
|
|
|
||
|
|
// reimplemented from StanzaExtension
|
||
|
|
virtual StanzaExtension* newInstance( const Tag* tag ) const
|
||
|
|
{
|
||
|
|
return new Receipt( tag );
|
||
|
|
}
|
||
|
|
|
||
|
|
// reimplemented from StanzaExtension
|
||
|
|
Tag* tag() const;
|
||
|
|
|
||
|
|
// reimplemented from StanzaExtension
|
||
|
|
virtual StanzaExtension* clone() const
|
||
|
|
{
|
||
|
|
return new Receipt( *this );
|
||
|
|
}
|
||
|
|
|
||
|
|
private:
|
||
|
|
ReceiptType m_rcpt;
|
||
|
|
|
||
|
|
};
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
#endif // RECEIPT_H__
|