alexaClientSDK::sampleApplications::common::EndpointAlexaKeypadControllerHandler Class Reference

#include <EndpointAlexaKeypadControllerHandler.h>

Inheritance diagram for alexaClientSDK::sampleApplications::common::EndpointAlexaKeypadControllerHandler:

Collaboration diagram for alexaClientSDK::sampleApplications::common::EndpointAlexaKeypadControllerHandler:

Public Member Functions
AlexaKeypadControllerInterface methods
acsdkAlexaKeypadControllerInterfaces::AlexaKeypadControllerInterface::Response	handleKeystroke (acsdkAlexaKeypadControllerInterfaces::Keystroke keystroke) override
std::set< acsdkAlexaKeypadControllerInterfaces::Keystroke >	getSupportedKeys () override
Public Member Functions inherited from alexaClientSDK::acsdkAlexaKeypadControllerInterfaces::AlexaKeypadControllerInterface
virtual	~AlexaKeypadControllerInterface ()=default

Static Public Member Functions
static std::shared_ptr< EndpointAlexaKeypadControllerHandler >	create (const std::string &endpointName)

Detailed Description

Sample implementation of an AlexaKeypadControllerInterface.

Member Function Documentation

create()

static std::shared_ptr<EndpointAlexaKeypadControllerHandler> alexaClientSDK::sampleApplications::common::EndpointAlexaKeypadControllerHandler::create ( const std::string &  endpointName )

static

Create a AlexaKeypadControllerHandler object.

Parameters

endpointName

The name of the endpoint.

Returns

A pointer to a new AlexaKeypadControllerHandler object if it succeeds; otherwise, nullptr.

getSupportedKeys()

std::set<acsdkAlexaKeypadControllerInterfaces::Keystroke> alexaClientSDK::sampleApplications::common::EndpointAlexaKeypadControllerHandler::getSupportedKeys ( )

overridevirtual

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

Implements alexaClientSDK::acsdkAlexaKeypadControllerInterfaces::AlexaKeypadControllerInterface.

handleKeystroke()

acsdkAlexaKeypadControllerInterfaces::AlexaKeypadControllerInterface::Response alexaClientSDK::sampleApplications::common::EndpointAlexaKeypadControllerHandler::handleKeystroke ( acsdkAlexaKeypadControllerInterfaces::Keystroke  keystroke )

overridevirtual

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.

Implements alexaClientSDK::acsdkAlexaKeypadControllerInterfaces::AlexaKeypadControllerInterface.

---

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

• /workplace/avs-device-sdk/SampleApplications/Common/Endpoint/include/acsdk/Sample/Endpoint/EndpointAlexaKeypadControllerHandler.h