131 lines
3.7 KiB
C++
131 lines
3.7 KiB
C++
/*
|
|
Copyright (c) 2006-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 DELAYEDDELIVERY_H__
|
|
#define DELAYEDDELIVERY_H__
|
|
|
|
#include "gloox.h"
|
|
#include "jid.h"
|
|
#include "stanzaextension.h"
|
|
|
|
#include <string>
|
|
|
|
namespace gloox
|
|
{
|
|
|
|
class Tag;
|
|
|
|
/**
|
|
* @brief This is an implementation of XEP-0203 (Delayed Delivery).
|
|
*
|
|
* The class also implements the deprecated XEP-0091 (Delayed Delivery) in a read-only fashion.
|
|
* It understands both XEP formats for input, but any output will conform to XEP-0203.
|
|
*
|
|
* XEP Version: 0.1
|
|
* @author Jakob Schroeter <js@camaya.net>
|
|
* @since 0.9
|
|
*/
|
|
class GLOOX_API DelayedDelivery : public StanzaExtension
|
|
{
|
|
|
|
public:
|
|
/**
|
|
* Constructs a new object and fills it according to the parameters.
|
|
* @param from The JID of the original sender or the entity that delayed the sending.
|
|
* @param stamp The datetime stamp of the original send.
|
|
* @param reason An optional natural language reason for the delay.
|
|
*/
|
|
DelayedDelivery( const JID& from, const std::string stamp,
|
|
const std::string& reason = "" );
|
|
|
|
/**
|
|
* Constructs a new object from the given Tag.
|
|
* @param tag The Tag to parse.
|
|
*/
|
|
DelayedDelivery( const Tag* tag = 0 );
|
|
|
|
/**
|
|
* Virtual Destructor.
|
|
*/
|
|
virtual ~DelayedDelivery();
|
|
|
|
/**
|
|
* Returns the datetime when the stanza was originally sent.
|
|
* The format MUST adhere to the dateTime format specified in XEP-0082 and MUST
|
|
* be expressed in UTC.
|
|
* @return The original datetime.
|
|
*/
|
|
const std::string& stamp() const { return m_stamp; }
|
|
|
|
/**
|
|
* Sets the original datetime.
|
|
* @param stamp The original datetime.
|
|
*/
|
|
void setStamp( const std::string& stamp ) { m_stamp = stamp; }
|
|
|
|
/**
|
|
* Returns the JID of the original sender of the stanza or the entity that
|
|
* delayed the sending.
|
|
* The format MUST adhere to the dateTime format specified in XEP-0082 and MUST
|
|
* be expressed in UTC.
|
|
* @return The JID.
|
|
*/
|
|
const JID& from() const { return m_from; }
|
|
|
|
/**
|
|
* Sets the JID of the origianl sender or the entity that delayed the sending.
|
|
* @param from The JID.
|
|
*/
|
|
void setFrom( const JID& from ) { m_from = from; }
|
|
|
|
/**
|
|
* Returns a natural language reason for the delay.
|
|
* @return A natural language reason for the delay.
|
|
*/
|
|
const std::string& reason() const { return m_reason; }
|
|
|
|
/**
|
|
* Sets the reason for the delay.
|
|
* @param reason The reason for the delay.
|
|
*/
|
|
void setReason( const std::string& reason ) { m_reason = reason; }
|
|
|
|
// reimplemented from StanzaExtension
|
|
virtual const std::string& filterString() const;
|
|
|
|
// reimplemented from StanzaExtension
|
|
virtual StanzaExtension* newInstance( const Tag* tag ) const
|
|
{
|
|
return new DelayedDelivery( tag );
|
|
}
|
|
|
|
// reimplemented from StanzaExtension
|
|
virtual Tag* tag() const;
|
|
|
|
// reimplemented from StanzaExtension
|
|
virtual StanzaExtension* clone() const
|
|
{
|
|
return new DelayedDelivery( *this );
|
|
}
|
|
|
|
private:
|
|
JID m_from;
|
|
std::string m_stamp;
|
|
std::string m_reason;
|
|
bool m_valid;
|
|
};
|
|
|
|
}
|
|
|
|
#endif // DELAYEDDELIVERY_H__
|