Nickname Class Reference

An implementation of User Nickname (XEP-0172) as a StanzaExtension. More...

#include <nickname.h>

Inherits StanzaExtension.

Inheritance diagram for Nickname:

[legend]List of all members.

Public Member Functions
	Nickname (const Tag *tag)
	Nickname (const std::string &nick)
virtual	~Nickname ()
const std::string	nick () const
virtual const std::string &	filterString () const
virtual StanzaExtension *	newInstance (const Tag *tag) const
Tag *	tag () const

---

Detailed Description

An implementation of User Nickname (XEP-0172) as a StanzaExtension.

XEP version: 1.0

Author:

Jakob Schroeter <js@camaya.net>

Since:

1.0

Definition at line 33 of file nickname.h.

---

Constructor & Destructor Documentation

Nickname (  const Tag *  tag  )

Constructs a new object from the given Tag. Parameters: tag  A Tag to parse. Definition at line 19 of file nickname.cpp.

Nickname (  const std::string &  nick  )  [inline]

Constructs a new Nickname object. Parameters: nick  The nickname to include. Definition at line 47 of file nickname.h.

virtual ~Nickname (   )  [inline, virtual]

Virtual destructor. Definition at line 54 of file nickname.h.

---

Member Function Documentation

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. Definition at line 26 of file nickname.cpp.

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. Definition at line 66 of file nickname.h.

const std::string nick (   )  const [inline]

Returns the extension's saved nickname. Returns: The nickname. Definition at line 60 of file nickname.h.

Tag * tag (   )  const [virtual]

Returns a Tag representation of the extension. Returns: A Tag representation of the extension. Implements StanzaExtension. Definition at line 34 of file nickname.cpp.

---

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

• nickname.h
• nickname.cpp

---