gloox 1.0
Public Member Functions

AdhocHandler Class Reference

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

#include <adhochandler.h>

List of all members.

Public Member Functions

virtual ~AdhocHandler ()
virtual void handleAdhocSupport (const JID &remote, bool support)=0
virtual void handleAdhocCommands (const JID &remote, const StringMap &commands)=0
virtual void handleAdhocError (const JID &remote, const Error *error)=0
virtual void handleAdhocExecutionResult (const JID &remote, const Adhoc::Command &command)=0

Detailed Description

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

Derived classes can be registered with the Adhoc object to receive notifications about Adhoc Commands remote entities support.

Author:
Jakob Schroeter <js@camaya.net>
Since:
0.9

Definition at line 32 of file adhochandler.h.


Constructor & Destructor Documentation

virtual ~AdhocHandler ( ) [inline, virtual]

Virtual destructor.

Definition at line 38 of file adhochandler.h.


Member Function Documentation

virtual void handleAdhocCommands ( const JID remote,
const StringMap commands 
) [pure virtual]

This function is called in response to a call to Adhoc::getCommands() and delivers a list of supported commands.

Parameters:
remoteThe queried remote entity's JID.
commandsA map of supported commands and their human-readable name. The map may be empty.
virtual void handleAdhocError ( const JID remote,
const Error error 
) [pure virtual]

This function is called in response to a call to Adhoc::getCommands() or Adhoc::checkSupport() or Adhoc::execute() in case the respective request returned an error.

Parameters:
remoteThe queried remote entity's JID.
errorThe error condition. May be 0.
virtual void handleAdhocExecutionResult ( const JID remote,
const Adhoc::Command command 
) [pure virtual]

This function is called in response to a remote command execution.

Parameters:
remoteThe remote entity's JID.
commandThe command being executed.
virtual void handleAdhocSupport ( const JID remote,
bool  support 
) [pure virtual]

This function is called in response to a call to Adhoc::checkSupport().

Parameters:
remoteThe queried remote entity's JID.
supportWhether the remote entity supports Adhoc Commands.

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