alexaClientSDK::acsdkAlexaKeypadControllerInterfaces::AlexaKeypadControllerInterface::Response Struct Reference

#include <AlexaKeypadControllerInterface.h>

Public Types
enum	Type {   Type::SUCCESS, Type::NO_INFORMATION_AVAILABLE, Type::INVALID_SELECTION, Type::KEYSTROKE_NOT_SUPPORTED,   Type::INTERNAL_ERROR }

Public Member Functions
	Response ()

Public Attributes
Type	type
	Response type for KeypadController handler responses. More...
std::string	errorMessage

Detailed Description

Utility object used for reporting KeypadController response.

type should be SUCCESS if there are no errors while executing keypad controller operation. Otherwise, it should return the corresponding error response along with a log message errorMessage that would be logged in the cloud, for the purposes of aiding debugging.

Member Enumeration Documentation

Type

enum alexaClientSDK::acsdkAlexaKeypadControllerInterfaces::AlexaKeypadControllerInterface::Response::Type

strong

Enum for the different error types understood by the AlexaKeypadController capability agent.

Enumerator
SUCCESS	Device processed command successfully without any errors.
NO_INFORMATION_AVAILABLE	Indicates there is no additional information available when 'INFO' OR 'MORE' operation is invoked.
INVALID_SELECTION	Indicates the element cannot be selected when 'SELECT' operation is invoked.
KEYSTROKE_NOT_SUPPORTED	Indicates the keystroke operation is not supported on the device.
INTERNAL_ERROR	An error occurred that can't be described by one of the other error types. For example, a runtime exception occurred. We recommend that you always send a more specific error type, if possible.

Constructor & Destructor Documentation

Response()

alexaClientSDK::acsdkAlexaKeypadControllerInterfaces::AlexaKeypadControllerInterface::Response::Response ( )

inline

Default Constructor. Set the type to SUCCESS.

Member Data Documentation

errorMessage

std::string alexaClientSDK::acsdkAlexaKeypadControllerInterfaces::AlexaKeypadControllerInterface::Response::errorMessage

The error message for logging if the type is any other than SUCCESS, for the purposes of aiding debugging.

type

Type alexaClientSDK::acsdkAlexaKeypadControllerInterfaces::AlexaKeypadControllerInterface::Response::type

Response type for KeypadController handler responses.

---

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

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