NuguCapability::ITextListener Class Reference

text listener interface More...

#include <text_interface.hh>

Inheritance diagram for NuguCapability::ITextListener:

Collaboration diagram for NuguCapability::ITextListener:

Public Member Functions
virtual bool	handleTextCommand (const std::string &text, const std::string &token)=0
	Handle text command and return whether consumed. More...
virtual void	onComplete (const std::string &dialog_id)=0
	When server processing for text input requests is completed. More...
virtual void	onError (TextError error, const std::string &dialog_id)=0
	An error occurred during requesting text input. More...
virtual void	onState (TextState state, const std::string &dialog_id)=0
	TextState changed. More...
Public Member Functions inherited from NuguClientKit::ICapabilityListener
virtual ICapabilityInterface *	getCapabilityHandler ()
	Get capability interface object. More...
virtual void	setCapabilityHandler (ICapabilityInterface *handler)
	Set capability interface object. More...

Detailed Description

text listener interface

See also

ITextHandler

Member Function Documentation

onState()

virtual void NuguCapability::ITextListener::onState ( TextState  state, const std::string &  dialog_id  )

pure virtual

TextState changed.

Parameters

[in]	state	text state
[in]	dialog_id	dialog request id

See also

ITextHandler::requestTextInput()

onComplete()

virtual void NuguCapability::ITextListener::onComplete ( const std::string &  dialog_id )

pure virtual

When server processing for text input requests is completed.

Parameters

[in]

dialog_id

dialog request id

onError()

virtual void NuguCapability::ITextListener::onError ( TextError  error, const std::string &  dialog_id  )

pure virtual

An error occurred during requesting text input.

Parameters

[in]	error	text error
[in]	dialog_id	dialog request id

handleTextCommand()

virtual bool NuguCapability::ITextListener::handleTextCommand ( const std::string &  text, const std::string &  token  )

pure virtual

Handle text command and return whether consumed.

Parameters

[in]	text	text command
[in]	token	received token

Returns

whether text command is consumed or not. If it return true, the event about failure of sending text input is sent to server.

---

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

• text_interface.hh