NuguCapability::IPhoneCallHandler Class Reference

phone call handler interface More...

#include <phone_call_interface.hh>

Inheritance diagram for NuguCapability::IPhoneCallHandler:

Collaboration diagram for NuguCapability::IPhoneCallHandler:

Public Member Functions
virtual void	callArrived (const std::string &payload)=0
	Notify when call is arrived. More...
virtual void	callEnded (const std::string &payload)=0
	Notify when call is ended. More...
virtual void	callEstablished (const std::string &payload)=0
	Notify when call is established. More...
virtual void	candidatesListed (const std::string &context_template, const std::string &payload)=0
	The result of send candidates process. More...
virtual void	makeCallFailed (const std::string &payload)=0
	The failed result of make call process. More...
virtual void	makeCallSucceeded (const std::string &payload)=0
	The succeeded result of make call process. More...
virtual void	setNumberBlockable (bool flag)=0
	Set whether numbers can be blocked. 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

phone call handler interface

See also

IPhoneCallListener

Member Function Documentation

candidatesListed()

virtual void NuguCapability::IPhoneCallHandler::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

callArrived()

virtual void NuguCapability::IPhoneCallHandler::callArrived ( const std::string &  payload )

pure virtual

Notify when call is arrived.

Parameters

[in]

payload

event's payload

callEnded()

virtual void NuguCapability::IPhoneCallHandler::callEnded ( const std::string &  payload )

pure virtual

Notify when call is ended.

Parameters

[in]

payload

event's payload

callEstablished()

virtual void NuguCapability::IPhoneCallHandler::callEstablished ( const std::string &  payload )

pure virtual

Notify when call is established.

Parameters

[in]

payload

event's payload

makeCallSucceeded()

virtual void NuguCapability::IPhoneCallHandler::makeCallSucceeded ( const std::string &  payload )

pure virtual

The succeeded result of make call process.

Parameters

[in]

payload

event's payload

makeCallFailed()

virtual void NuguCapability::IPhoneCallHandler::makeCallFailed ( const std::string &  payload )

pure virtual

The failed result of make call process.

Parameters

[in]

payload

event's payload

setNumberBlockable()

virtual void NuguCapability::IPhoneCallHandler::setNumberBlockable ( bool  flag )

pure virtual

Set whether numbers can be blocked.

Parameters

[in]

flag

true if can block number, otherwise false.

---

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

• phone_call_interface.hh