Public Member Functions | List of all members
AdhocCommandProvider Class Reference

#include <adhoccommandprovider.h>

Public Member Functions

virtual ~AdhocCommandProvider ()
virtual void handleAdhocCommand (const std::string &command, Tag *tag, const JID &from, const std::string &id)=0

Detailed Description

A virtual interface for an Ad-hoc Command Provider according to XEP-0050.

Derived classes can be registered as Command Providers with the Adhoc object.

Jakob Schroeter

Definition at line 35 of file adhoccommandprovider.h.

Constructor & Destructor Documentation

virtual ~AdhocCommandProvider ( )

Virtual destructor.

Definition at line 41 of file adhoccommandprovider.h.

Member Function Documentation

virtual void handleAdhocCommand ( const std::string &  command,
Tag tag,
const JID from,
const std::string &  id 
pure virtual

This function is called when an Ad-hoc Command needs to be handled. The callee is responsible for the whole command execution, i.e. session handling etc.

commandThe name of the command to be executed.
tagThe complete command tag.
fromThe sender of the command request.
idThe command's id. An opaque string which should be used only as the id of the iq result or error stanza.

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