NuguCapability::ITextHandler Class Reference

text handler interface More...

#include <text_interface.hh>

Inheritance diagram for NuguCapability::ITextHandler:

Collaboration diagram for NuguCapability::ITextHandler:

Public Member Functions
virtual std::string	requestTextInput (const std::string &text, const std::string &token="", const std::string &source="", bool include_dialog_attribute=true)=0
	Request NUGU services based on text input. More...
virtual void	setAttribute (TextAttribute &&attribute)=0
	Set attribute about response. 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

text handler interface

See also

ITextListener

Member Function Documentation

requestTextInput()

virtual std::string NuguCapability::ITextHandler::requestTextInput ( const std::string &  text, const std::string &  token = "", const std::string &  source = "", bool  include_dialog_attribute = true  )

pure virtual

Request NUGU services based on text input.

Parameters

[in]	text	text command
[in]	token	received token
[in]	source	source that triggered the text input
[in]	include_dialog_attribute	whether including dialog attribute

Returns

dialog request id if a NUGU service request succeeds with user text, otherwise empty string

setAttribute()

virtual void NuguCapability::ITextHandler::setAttribute ( TextAttribute &&  attribute )

pure virtual

Set attribute about response.

Parameters

[in]

attribute

attribute object

---

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

• text_interface.hh