alexaClientSDK::acsdkAlexaKeypadControllerInterfaces::AlexaKeypadControllerInterface Class Reference

#include <AlexaKeypadControllerInterface.h>

Inheritance diagram for alexaClientSDK::acsdkAlexaKeypadControllerInterfaces::AlexaKeypadControllerInterface:

Classes
struct	Response

Public Member Functions
virtual	~AlexaKeypadControllerInterface ()=default
virtual Response	handleKeystroke (Keystroke keystroke)=0
virtual std::set< Keystroke >	getSupportedKeys ()=0

Detailed Description

The AlexaKeypadControllerInterface carries out keypad controller actions such as moving up, down, left, right or scrolling through voice-control.

An implementation of the AlexaKeypadControllerInterface. Sends information to device for sendKeystroke results.

Note

Implementations of this interface must be thread-safe.

Constructor & Destructor Documentation

~AlexaKeypadControllerInterface()

virtual alexaClientSDK::acsdkAlexaKeypadControllerInterfaces::AlexaKeypadControllerInterface::~AlexaKeypadControllerInterface ( )

virtualdefault

Virtual destructor to assure proper cleanup of derived types.

Member Function Documentation

getSupportedKeys()

virtual std::set<Keystroke> alexaClientSDK::acsdkAlexaKeypadControllerInterfaces::AlexaKeypadControllerInterface::getSupportedKeys ( )

pure virtual

Returns all supported keystrokes the device is expected to understand.

Returns

A Keystroke set object that contains supported key stroke properties. e.g. UP, DOWN, LEFT, RIGHT, SELECT

Implemented in alexaClientSDK::sampleApplications::common::EndpointAlexaKeypadControllerHandler.

handleKeystroke()

virtual Response alexaClientSDK::acsdkAlexaKeypadControllerInterfaces::AlexaKeypadControllerInterface::handleKeystroke ( Keystroke  keystroke )

pure virtual

Execute keystroke operation on the device

Parameters

keystroke

The Keystroke value user asked for

Returns

A Response to indicate whether keystroke event was successfully executed or encountered an error while executing.

Implemented in alexaClientSDK::sampleApplications::common::EndpointAlexaKeypadControllerHandler.

---

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

• /workplace/avs-device-sdk/capabilities/AlexaKeypadController/acsdkAlexaKeypadControllerInterfaces/include/acsdkAlexaKeypadControllerInterfaces/AlexaKeypadControllerInterface.h