gloox 1.0
|
A stanza error abstraction implemented as a StanzaExtension. More...
#include <error.h>
Public Member Functions | |
Error (const Tag *tag=0) | |
Error (StanzaErrorType type, StanzaError error, Tag *appError=0) | |
virtual | ~Error () |
StanzaErrorType | type () const |
StanzaError | error () const |
const Tag * | appError () const |
const std::string & | text (const std::string &lang=EmptyString) const |
void | setText (const std::string &text, const std::string &lang=EmptyString) |
virtual const std::string & | filterString () const |
virtual StanzaExtension * | newInstance (const Tag *tag) const |
virtual Tag * | tag () const |
virtual StanzaExtension * | clone () const |
A stanza error abstraction implemented as a StanzaExtension.
Error | ( | StanzaErrorType | type, |
StanzaError | error, | ||
Tag * | appError = 0 |
||
) | [inline] |
const Tag* appError | ( | ) | const [inline] |
virtual StanzaExtension* clone | ( | ) | const [inline, virtual] |
Returns an identical copy of the current StanzaExtension.
Implements StanzaExtension.
StanzaError error | ( | ) | const [inline] |
const std::string & filterString | ( | ) | const [virtual] |
Returns an XPath expression that describes a path to child elements of a stanza that an extension handles.
Implements StanzaExtension.
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 ); }
Implements StanzaExtension.
void setText | ( | const std::string & | text, |
const std::string & | lang = EmptyString |
||
) | [inline] |
Tag * tag | ( | ) | const [virtual] |
Returns a Tag representation of the extension.
Implements StanzaExtension.
const std::string & text | ( | const std::string & | lang = EmptyString | ) | const |
Returns the text of a error stanza for the given language if available. If the requested language is not available, the default text (without a xml:lang attribute) will be returned.
lang | The language identifier for the desired language. It must conform to section 2.12 of the XML specification and RFC 3066. If empty, the default text will be returned, if any. |
StanzaErrorType type | ( | ) | const [inline] |