NuguCapability::IDisplayListener Class Reference

display listener interface More...

#include <display_interface.hh>

Inheritance diagram for NuguCapability::IDisplayListener:

Collaboration diagram for NuguCapability::IDisplayListener:

Public Member Functions
virtual bool	clearDisplay (const std::string &id, bool unconditionally, bool has_next)=0
	The SDK will ask you to delete the rendered display on the display according to the service context maintenance policy. More...
virtual void	controlDisplay (const std::string &id, ControlType type, ControlDirection direction)=0
	Request to control the display with type and direction. More...
virtual void	renderDisplay (const std::string &id, const std::string &type, const std::string &json_payload, const std::string &dialog_id)=0
	Request rendering by passing metadata so that the device with the display can draw on the screen. More...
virtual void	updateDisplay (const std::string &id, const std::string &json_payload)=0
	Request to update the current display. 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

display listener interface

See also

IDisplayHandler

Member Function Documentation

renderDisplay()

virtual void NuguCapability::IDisplayListener::renderDisplay ( const std::string &  id, const std::string &  type, const std::string &  json_payload, const std::string &  dialog_id  )

pure virtual

Request rendering by passing metadata so that the device with the display can draw on the screen.

Parameters

[in]	id	display template id
[in]	type	display template type
[in]	json_payload	template in json format for display
[in]	dialog_id	dialog request id

clearDisplay()

virtual bool NuguCapability::IDisplayListener::clearDisplay ( const std::string &  id, bool  unconditionally, bool  has_next  )

pure virtual

The SDK will ask you to delete the rendered display on the display according to the service context maintenance policy.

Parameters

[in]	id	display template id
[in]	unconditionally	whether clear display unconditionally or not
[in]	has_next	whether has next display to render

Returns

true if display is cleared

controlDisplay()

virtual void NuguCapability::IDisplayListener::controlDisplay ( const std::string &  id, ControlType  type, ControlDirection  direction  )

pure virtual

Request to control the display with type and direction.

Parameters

[in]	id	display template id
[in]	type	control type
[in]	direction	control direction

updateDisplay()

virtual void NuguCapability::IDisplayListener::updateDisplay ( const std::string &  id, const std::string &  json_payload  )

pure virtual

Request to update the current display.

Parameters

[in]	id	display template id
[in]	json_payload	template in json format for display

---

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

• display_interface.hh