gloox  1.0.27
Public Member Functions | List of all members
OOB Class Reference

#include <oob.h>

Inheritance diagram for OOB:
Inheritance graph

Public Member Functions

 OOB (const std::string &url, const std::string &description, bool iqext)
 OOB (const Tag *tag)
virtual ~OOB ()
const std::string & url () const
const std::string & desc () const
virtual const std::string & filterString () const
virtual StanzaExtensionnewInstance (const Tag *tag) const
Tagtag () const
virtual StanzaExtensionclone () const
- Public Member Functions inherited from StanzaExtension
 StanzaExtension (int type)
virtual ~StanzaExtension ()
virtual StanzaembeddedStanza () const
virtual TagembeddedTag () const
int extensionType () const

Detailed Description

This is an abstraction of a jabber:x:oob namespace element or a jabber:iq:oob namespace element as specified in XEP-0066.

XEP version: 1.5

Jakob Schröter

Definition at line 35 of file oob.h.

Constructor & Destructor Documentation

◆ OOB() [1/2]

OOB ( const std::string &  url,
const std::string &  description,
bool  iqext 

Constructs an OOB StanzaExtension from teh given URL and description.

urlThe out-of-band URL.
descriptionThe URL's optional description.
iqextWhether this object extends an IQ or a Presence/Message stanza (results in either jabber:iq:oob or jabber:x:oob namespaced element).

Definition at line 20 of file oob.cpp.

◆ OOB() [2/2]

OOB ( const Tag tag)

Constructs an OOB object from the given Tag. To be recognized properly, the Tag must have either a name of 'x' in the jabber:x:oob namespace, or a name of 'query' in the jabber:iq:oob namespace.

tagThe Tag to parse.

Definition at line 28 of file oob.cpp.

◆ ~OOB()

~OOB ( )

Virtual destructor.

Definition at line 49 of file oob.cpp.

Member Function Documentation

◆ clone()

virtual StanzaExtension* clone ( ) const

Returns an identical copy of the current StanzaExtension.

An identical copy of the current StanzaExtension.

Implements StanzaExtension.

Definition at line 85 of file oob.h.

◆ desc()

const std::string& desc ( ) const

Returns the URL's description.

The URL's description.

Definition at line 70 of file oob.h.

◆ filterString()

const std::string & filterString ( ) const

Returns an XPath expression that describes a path to child elements of a stanza that an extension handles.

The extension's filter string.

Implements StanzaExtension.

Definition at line 53 of file oob.cpp.

◆ newInstance()

virtual StanzaExtension* newInstance ( const Tag tag) const

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 );
Tag * tag() const
Definition: oob.cpp:62
The derived extension's new instance.

Implements StanzaExtension.

Definition at line 76 of file oob.h.

◆ tag()

Tag * tag ( ) const

Returns a Tag representation of the extension.

A Tag representation of the extension.

Implements StanzaExtension.

Definition at line 62 of file oob.cpp.

◆ url()

const std::string& url ( ) const

Returns the out-of-band URL.

The out-of-band URL.

Definition at line 64 of file oob.h.

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