display handler interface More...

#include <display_interface.hh>

Inheritance diagram for NuguCapability::IDisplayHandler:

Collaboration diagram for NuguCapability::IDisplayHandler:

Public Member Functions
virtual void	controlTemplate (const std::string &id, TemplateControlType control_type)
	Control templates which are composed by history control. More...

virtual void	displayCleared (const std::string &id)
	The user reports that the display is cleared. More...

virtual void	displayRendered (const std::string &id, const DisplayContextInfo &context_info=DisplayContextInfo {})
	The user reports that the display was rendered. More...

virtual void	elementSelected (const std::string &id, const std::string &item_token, const std::string &postback="")
	The user informs the selected item of the list and reports the token information of the item. More...

virtual void	informControlResult (const std::string &id, ControlType type, ControlDirection direction, bool result)
	The user informs the control result. More...

virtual void	refreshRenderingTimer (const std::string &id)
	Refresh display rendering hold timer. More...

virtual void	removeDisplayListener (IDisplayListener *listener)
	Remove the IDisplayListener object.

virtual void	setDisplayListener (IDisplayListener *listener)
	Set the IDisplayListener object. More...

virtual void	stopRenderingTimer (const std::string &id)
	Stop display rendering hold timer. More...

virtual void	triggerChild (const std::string &ps_id, const std::string &data)
	Send TriggerChild event for receiving child template. 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

display handler interface

See also: IDisplayListener

Member Function Documentation

◆ displayRendered()

virtual void NuguCapability::IDisplayHandler::displayRendered	(	const std::string &	id,
		const DisplayContextInfo &	context_info = `DisplayContextInfo {}`
	)

virtual

The user reports that the display was rendered.

Parameters

[in]	id	display template id
[in]	context_info	display context information

◆ displayCleared()

virtual void NuguCapability::IDisplayHandler::displayCleared ( const std::string & id )

virtual

The user reports that the display is cleared.

Parameters

[in] id display template id

◆ elementSelected()

virtual void NuguCapability::IDisplayHandler::elementSelected	(	const std::string &	id,
		const std::string &	item_token,
		const std::string &	postback = `""`
	)

virtual

The user informs the selected item of the list and reports the token information of the item.

Parameters

[in]	id	display template id
[in]	item_token	parsed token from metadata
[in]	postback	postback data if the item is selectable

◆ triggerChild()

virtual void NuguCapability::IDisplayHandler::triggerChild	(	const std::string &	ps_id,
		const std::string &	data
	)

virtual

Send TriggerChild event for receiving child template.

Parameters

[in]	ps_id	target play service id
[in]	data	any JSON data

◆ controlTemplate()

virtual void NuguCapability::IDisplayHandler::controlTemplate	(	const std::string &	id,
		TemplateControlType	control_type
	)

virtual

Control templates which are composed by history control.

Parameters

[in]	id	display template id
[in]	control_type	TemplateControlType

◆ informControlResult()

virtual void NuguCapability::IDisplayHandler::informControlResult	(	const std::string &	id,
		ControlType	type,
		ControlDirection	direction,
		bool	result
	)

virtual

The user informs the control result.

Parameters

[in]	id	display template id
[in]	type	control type
[in]	direction	control direction
[in]	result	ControlFocus/ControlScroll processing result

◆ setDisplayListener()

virtual void NuguCapability::IDisplayHandler::setDisplayListener ( IDisplayListener * listener )

virtual

Set the IDisplayListener object.

Parameters

[in] listener listener object

◆ stopRenderingTimer()

virtual void NuguCapability::IDisplayHandler::stopRenderingTimer ( const std::string & id )

virtual

Stop display rendering hold timer.

Parameters

[in] id display template id

◆ refreshRenderingTimer()

virtual void NuguCapability::IDisplayHandler::refreshRenderingTimer ( const std::string & id )

virtual

Refresh display rendering hold timer.

Parameters

[in] id display template id

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

display_interface.hh

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ displayRendered()

◆ displayCleared()

◆ elementSelected()

◆ triggerChild()

◆ controlTemplate()

◆ informControlResult()

◆ setDisplayListener()

◆ stopRenderingTimer()

◆ refreshRenderingTimer()