#include <adhoccommandprovider.h>

Public Member Functions
virtual	~AdhocCommandProvider ()

virtual void	handleAdhocCommand (const JID &from, const Adhoc::Command &command, const std::string &sessionID)=0

virtual bool	handleAdhocAccessRequest (const JID &from, const std::string &command)

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.

Author: Jakob Schröter js@ca.nosp@m.maya.nosp@m..net

Definition at line 36 of file adhoccommandprovider.h.

Constructor & Destructor Documentation

◆ ~AdhocCommandProvider()

virtual ~AdhocCommandProvider ( )

inlinevirtual

Virtual destructor.

Definition at line 42 of file adhoccommandprovider.h.

Member Function Documentation

◆ handleAdhocAccessRequest()

virtual bool handleAdhocAccessRequest	(	const JID &	from,
		const std::string &	command
	)

inlinevirtual

This function gets called for each registered command when a remote entity requests the list of available commands.

Parameters

from	The requesting entity.
command	The command's name.

Returns: True if the remote entity is allowed to see the command, false if not.

Note: The return value of this function does not influence the execution of a command. That is, you have to implement additional access control at execution stage.; This function should not block.

Definition at line 68 of file adhoccommandprovider.h.

◆ handleAdhocCommand()

virtual void handleAdhocCommand	(	const JID &	from,
		const Adhoc::Command &	command,
		const std::string &	sessionID
	)

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. To reply, use Adhoc::respond().