DelayedDelivery Class Reference

This is an implementation of XEP-0203 (Delayed Delivery). More...

#include <delayeddelivery.h>

Inheritance diagram for DelayedDelivery:

Inheritance graph
[legend]
Collaboration diagram for DelayedDelivery:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 DelayedDelivery (const JID &from, const std::string stamp, const std::string &reason)
 DelayedDelivery (Tag *tag)
virtual ~DelayedDelivery ()
const std::string & stamp () const
void setStamp (const std::string &stamp)
const JIDfrom () const
void setFrom (const JID &from)
const std::string & reason () const
void setReason (const std::string &reason)
GLOOX_DEPRECATED void setBody (const std::string &reason)
virtual Tagtag () const


Detailed Description

This is an implementation of XEP-0203 (Delayed Delivery).

XEP Version: 0.1

Author:
Jakob Schroeter <js@camaya.net>
Since:
0.9

Definition at line 34 of file delayeddelivery.h.


Constructor & Destructor Documentation

DelayedDelivery ( const JID from,
const std::string  stamp,
const std::string &  reason 
)

Constructs a new object and fills it according to the parameters.

Parameters:
from The JID of the original sender or the entity that delayed the sending.
stamp The datetime stamp of the original send.
reason A natural language reason for the delay.

Definition at line 21 of file delayeddelivery.cpp.

DelayedDelivery ( Tag tag  ) 

Constructs a new object from the given Tag.

Parameters:
tag The Tag to parse.

Definition at line 29 of file delayeddelivery.cpp.

~DelayedDelivery (  )  [virtual]

Virtual Destructor.

Definition at line 42 of file delayeddelivery.cpp.


Member Function Documentation

const std::string& stamp (  )  const [inline]

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.

Returns:
The original datetime.

Definition at line 63 of file delayeddelivery.h.

void setStamp ( const std::string &  stamp  )  [inline]

Sets the original datetime.

Parameters:
stamp The original datetime.

Definition at line 69 of file delayeddelivery.h.

const JID& from (  )  const [inline]

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.

Returns:
The JID.

Definition at line 78 of file delayeddelivery.h.

void setFrom ( const JID from  )  [inline]

Sets the JID of the origianl sender or the entity that delayed the sending.

Parameters:
from The JID.

Definition at line 84 of file delayeddelivery.h.

const std::string& reason (  )  const [inline]

Returns a natural language reason fro the delay.

Returns:
A natural language reason fro the delay.

Definition at line 90 of file delayeddelivery.h.

void setReason ( const std::string &  reason  )  [inline]

Sets the reason for the delay.

Parameters:
reason The reason for the delay.

Definition at line 96 of file delayeddelivery.h.

GLOOX_DEPRECATED void setBody ( const std::string &  reason  )  [inline]

Sets the reason for the delay.

Parameters:
reason The reason for the delay.
Deprecated:
Use setReason() instead.

Definition at line 103 of file delayeddelivery.h.

Tag * tag (  )  const [virtual]

Returns a Tag representation of the extension.

Returns:
A Tag representation of the extension.

Implements StanzaExtension.

Definition at line 46 of file delayeddelivery.cpp.


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

Generated on Sun Apr 27 11:08:21 2008 for gloox by  doxygen 1.5.5