message handler interface More...

#include <message_interface.hh>

Inheritance diagram for NuguCapability::IMessageHandler:

Collaboration diagram for NuguCapability::IMessageHandler:

Public Member Functions
virtual void	candidatesListed (const std::string &context_template, const std::string &payload)=0
	The result of send candidates process. More...

virtual void	getMessageFailed (const std::string &payload)=0
	The failed result of get message process. More...

virtual void	getMessageSucceeded (const std::string &payload)=0
	The succeed result of get message process. More...

virtual void	sendMessageFailed (const std::string &payload)=0
	The failed result of send message process. More...

virtual void	sendMessageSucceeded (const std::string &payload)=0
	The succeed result of send message process. More...

Public Member Functions inherited from NuguClientKit::ICapabilityInterface
virtual void	addEventResultCallback (const std::string &ename, EventResultCallback callback)=0
	Add event result callback for error handling. More...

virtual void	cancelDirective (NuguDirective *ndir)=0
	Receive a directive cancellation from the Directive sequencer. More...

virtual void	deInitialize ()=0
	Deinitialize the current object.

virtual std::string	getName ()=0
	Get the capability name of the current object. More...

virtual bool	getProperties (const std::string &property, std::list< std::string > &values)=0
	It is possible to share own property values among objects. More...

virtual bool	getProperty (const std::string &property, std::string &value)=0
	It is possible to share own property value among objects. More...

virtual std::string	getVersion ()=0
	Get the capability version of the current object. More...

virtual void	initialize ()=0
	Initialize the current object.

virtual void	notifyEventResponse (const std::string &msg_id, const std::string &data, bool success)=0
	Notify event response info. More...

virtual void	notifyEventResult (const std::string &event_desc)=0
	Notify event result. More...

virtual void	preprocessDirective (NuguDirective *ndir)=0
	Receive a directive preprocessing request from Directive sequencer. More...

virtual void	processDirective (NuguDirective *ndir)=0
	Receive a directive processing request from Directive sequencer. More...

virtual bool	receiveCommand (const std::string &from, const std::string &command, const std::string &param)=0
	Process command from other objects. More...

virtual void	receiveCommandAll (const std::string &command, const std::string &param)=0
	Process command received from capability manager. More...

virtual void	removeEventResultCallback (const std::string &ename)=0
	Remove event result callback. More...

virtual void	restore ()=0
	Restore previous suspended action.

virtual void	setCancelPolicy (bool cancel_previous_dialog, DirectiveCancelPolicy &&cancel_policy={ true })=0
	Set directive cancel policy. More...

virtual void	setCapabilityListener (ICapabilityListener *clistener)=0
	Set the listener object. More...

virtual void	setNuguCoreContainer (INuguCoreContainer *core_container)=0
	Set INuguCoreContainer for using functions in NuguCore. More...

virtual void	setSuspendPolicy (SuspendPolicy policy=SuspendPolicy::STOP)=0
	Set capability suspend policy. More...

virtual void	suspend ()=0
	Suspend current action.

virtual void	updateCompactContext (NJson::Value &ctx)=0
	Update the compact context information of the capability agent. More...

virtual void	updateInfoForContext (NJson::Value &ctx)=0
	Update the current context information of the capability agent. More...

Additional Inherited Members
Public Types inherited from NuguClientKit::ICapabilityInterface
using	EventResultCallback = std::function< void(const std::string &, const std::string &, const std::string &, int, int)>
	Event result callback for error handling. More...

enum class	SuspendPolicy { STOP , PAUSE }
	Capability suspend policy. More...

Detailed Description

message handler interface

See also: IMessageListener

Member Function Documentation

◆ candidatesListed()

virtual void NuguCapability::IMessageHandler::candidatesListed	(	const std::string &	context_template,
		const std::string &	payload
	)

pure virtual

The result of send candidates process.

Parameters

[in]	context_template	template information in context
[in]	payload	event's payload

◆ sendMessageSucceeded()

virtual void NuguCapability::IMessageHandler::sendMessageSucceeded ( const std::string & payload )

pure virtual

The succeed result of send message process.

Parameters

[in] payload event's payload

◆ sendMessageFailed()

virtual void NuguCapability::IMessageHandler::sendMessageFailed ( const std::string & payload )

pure virtual

The failed result of send message process.

Parameters

[in] payload event's payload

◆ getMessageSucceeded()

virtual void NuguCapability::IMessageHandler::getMessageSucceeded ( const std::string & payload )

pure virtual

The succeed result of get message process.

Parameters

[in] payload event's payload

◆ getMessageFailed()

virtual void NuguCapability::IMessageHandler::getMessageFailed ( const std::string & payload )

pure virtual

The failed result of get message process.

Parameters

[in] payload event's payload

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

message_interface.hh

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ candidatesListed()

◆ sendMessageSucceeded()

◆ sendMessageFailed()

◆ getMessageSucceeded()

◆ getMessageFailed()