#include <stanza.h>
Public Member Functions | |
Stanza (const Tag *tag) | |
Stanza (const std::string &name, const std::string &cdata="", const std::string &xmllang="default", bool incoming=false) | |
virtual | ~Stanza () |
virtual StanzaSubType | subtype () const |
virtual const JID & | from () const |
virtual const JID & | to () const |
virtual const std::string & | id () const |
virtual const std::string & | xmlns () const |
virtual Presence | presence () const |
virtual int | priority () const |
virtual const std::string | status (const std::string &lang="default") const |
virtual const std::string | body (const std::string &lang="default") const |
virtual const std::string | subject (const std::string &lang="default") const |
virtual const std::string | errorText (const std::string &lang="default") const |
virtual StanzaError | error () const |
Tag * | errorAppCondition () |
virtual const std::string & | thread () const |
void | setThread (const std::string &thread) |
const std::string & | xmlLang () const |
void | finalize () |
void | addExtension (StanzaExtension *se) |
const StanzaExtensionList & | extensions () const |
Static Public Member Functions | |
static Stanza * | createIqStanza (const JID &to, const std::string &id, StanzaSubType subtype=StanzaIqGet, const std::string &xmlns="", Tag *tag=0) |
static Stanza * | createPresenceStanza (const JID &to, const std::string &msg="", Presence status=PresenceAvailable, const std::string &xmllang="") |
static Stanza * | createMessageStanza (const JID &to, const std::string &body, StanzaSubType subtype=StanzaMessageChat, const std::string &subject="", const std::string &thread="", const std::string &xmllang="") |
static Stanza * | createSubscriptionStanza (const JID &to, const std::string &msg="", StanzaSubType subtype=StanzaS10nSubscribe, const std::string &xmllang="") |
You can create a new Stanza from an existing Tag (or another stanza).
Definition at line 39 of file stanza.h.
Creates a new Stanza from a deep copy of the given Tag.
Definition at line 32 of file stanza.cpp.
Stanza | ( | const std::string & | name, | |
const std::string & | cdata = "" , |
|||
const std::string & | xmllang = "default" , |
|||
bool | incoming = false | |||
) |
Creates a new Stanza with given name and optional CData.
name | The name of the root tag. | |
cdata | Initial XML character data for the tag. | |
xmllang | The value of the xmllang attribute. The stanza's primary language. | |
incoming | Indicates whether tag names, attributes, attribute values, and cdata shall be escaped (false, default) or not (true). |
Definition at line 24 of file stanza.cpp.
~Stanza | ( | ) | [virtual] |
Virtual destructor.
Definition at line 48 of file stanza.cpp.
virtual StanzaSubType subtype | ( | ) | const [inline, virtual] |
virtual const JID& from | ( | ) | const [inline, virtual] |
virtual const JID& to | ( | ) | const [inline, virtual] |
virtual const std::string& id | ( | ) | const [inline, virtual] |
virtual const std::string& xmlns | ( | ) | const [inline, virtual] |
virtual Presence presence | ( | ) | const [inline, virtual] |
virtual int priority | ( | ) | const [inline, virtual] |
Returns the remote entity resource's presence priority if the stanza is a presence stanza. If the stanza is not a presence stanza or if no priority information was included, a value below -128 is returned, which is an illegal value for the priority. Legal range is between -128 and +127.
virtual const std::string status | ( | const std::string & | lang = "default" |
) | const [inline, virtual] |
Returns the status text of a presence stanza for the given language if available. If the requested language is not available, the default status 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 body will be returned, if any. |
virtual const std::string body | ( | const std::string & | lang = "default" |
) | const [inline, virtual] |
Returns the body of a message stanza for the given language if available. If the requested language is not available, the default body (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 body will be returned, if any. |
virtual const std::string subject | ( | const std::string & | lang = "default" |
) | const [inline, virtual] |
Returns the subject of a message stanza for the given language if available. If the requested language is not available, the default subject (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 subject will be returned, if any. |
virtual const std::string errorText | ( | const std::string & | lang = "default" |
) | const [inline, virtual] |
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 subject will be returned, if any. |
virtual StanzaError error | ( | ) | const [inline, virtual] |
Tag* errorAppCondition | ( | ) | [inline] |
virtual const std::string& thread | ( | ) | const [inline, virtual] |
void setThread | ( | const std::string & | thread | ) | [inline] |
const std::string& xmlLang | ( | ) | const [inline] |
void finalize | ( | ) | [inline] |
void addExtension | ( | StanzaExtension * | se | ) |
Use this function to add a StanzaExtension to this Stanza.
se | The StanzaExtension to add. |
Definition at line 301 of file stanza.cpp.
const StanzaExtensionList& extensions | ( | ) | const [inline] |
Stanza * createIqStanza | ( | const JID & | to, | |
const std::string & | id, | |||
StanzaSubType | subtype = StanzaIqGet , |
|||
const std::string & | xmlns = "" , |
|||
Tag * | tag = 0 | |||
) | [static] |
Creates a new IQ stanza.
to | The receiver of the stanza. | |
id | An ID for the stanza. Best is to use ClientBase::getID() as input. | |
subtype | The IQ type. Only StanzaIq* types are valid. | |
xmlns | If this is non-empty, a child element named 'query' will be included, with this value as value of the 'xmlns' attribute. | |
tag | If this if not NULL, and xmlns is not empty, this Tag will be included as child tag of the 'query' element. |
Definition at line 307 of file stanza.cpp.
Stanza * createPresenceStanza | ( | const JID & | to, | |
const std::string & | msg = "" , |
|||
Presence | status = PresenceAvailable , |
|||
const std::string & | xmllang = "" | |||
) | [static] |
Creates a new presence stanza. to
can be an empty JID. This makes the created stanza a broadcast stanza sent to all contacts in the roster.
to | The receiver of the stanza. | |
msg | An optional message. | |
status | The status. | |
xmllang | The status message's language. |
Definition at line 343 of file stanza.cpp.
Stanza * createMessageStanza | ( | const JID & | to, | |
const std::string & | body, | |||
StanzaSubType | subtype = StanzaMessageChat , |
|||
const std::string & | subject = "" , |
|||
const std::string & | thread = "" , |
|||
const std::string & | xmllang = "" | |||
) | [static] |
Creates a new message stanza.
to | The receiver of the message. | |
body | The message's body. | |
subtype | The message type. Only StanzaMessage* types are valid. | |
subject | The message's subject. | |
thread | The message's conversation thread id. | |
xmllang | The message's language. |
Definition at line 382 of file stanza.cpp.
Stanza * createSubscriptionStanza | ( | const JID & | to, | |
const std::string & | msg = "" , |
|||
StanzaSubType | subtype = StanzaS10nSubscribe , |
|||
const std::string & | xmllang = "" | |||
) | [static] |
Creates a new subscription stanza.
to | The recipient of the subscription stanza. | |
msg | An optional message. | |
subtype | The subscription type. Only StanzaS10n* types are vaild. | |
xmllang | The message's language. |
Definition at line 427 of file stanza.cpp.