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 |
Detailed Description
A stanza error abstraction implemented as a StanzaExtension.
- Since:
- 1.0
Constructor & Destructor Documentation
| Error | ( | StanzaErrorType | type, |
| StanzaError | error, | ||
| Tag * | appError = 0 |
||
| ) | [inline] |
Member Function Documentation
| const Tag* appError | ( | ) | const [inline] |
| virtual StanzaExtension* clone | ( | ) | const [inline, virtual] |
Returns an identical copy of the current StanzaExtension.
- 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.
- Returns:
- The extension's filter string.
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 ); }
- Returns:
- The derived extension's new instance.
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.
- 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.
- Parameters:
-
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.
- Returns:
- The text of an error stanza.
| StanzaErrorType type | ( | ) | const [inline] |
The documentation for this class was generated from the following files:
