alexaClientSDK::acsdkAlexaKeypadControllerInterfaces Namespace Reference

Classes
class	AlexaKeypadControllerInterface

Enumerations
enum	Keystroke {   Keystroke::UP, Keystroke::DOWN, Keystroke::LEFT, Keystroke::RIGHT,   Keystroke::SELECT, Keystroke::PAGE_UP, Keystroke::PAGE_DOWN, Keystroke::PAGE_LEFT,   Keystroke::PAGE_RIGHT, Keystroke::INFO, Keystroke::MORE, Keystroke::BACK }

Functions
std::string	keystrokeToString (Keystroke keystroke)
avsCommon::utils::Optional< Keystroke >	stringToKeystroke (const std::string &keystrokeString)

Enumeration Type Documentation

Keystroke

enum alexaClientSDK::acsdkAlexaKeypadControllerInterfaces::Keystroke

strong

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

Enumerator
UP	Move up one unit.
DOWN	Move down one unit.
LEFT	Move left one unit.
RIGHT	Move right one unit.
SELECT	Select the element or item that has focus.
PAGE_UP	Scroll in the up direction.
PAGE_DOWN	Scroll in the down direction.
PAGE_LEFT	Scroll in the left direction.
PAGE_RIGHT	Scroll in the right direction.
INFO	Jump to an additional detail page.
MORE	Display more information about the onscreen elment that has focus. For example, show content that's offscreen
BACK	Simulate the behavior of the back button on the remote control. For example, navigate back to the previous screen.

Function Documentation

keystrokeToString()

std::string alexaClientSDK::acsdkAlexaKeypadControllerInterfaces::keystrokeToString

(

Keystroke

keystroke

)

Convert a Keystroke enum to its corresponding string value. Note that any keystroke that does not map to Keystroke enum value will return an empty string.

Parameters

keystroke

The keystroke value to convert.

Returns

The corresponding string value for keystroke. Returns an empty string if keystroke does not map to a Keystroke enum.

stringToKeystroke()

avsCommon::utils::Optional<Keystroke> alexaClientSDK::acsdkAlexaKeypadControllerInterfaces::stringToKeystroke

(

const std::string &

keystrokeString

)

Convert a string to a corresponding Keystroke enum value. Note that any keystrokeString that does not map to Keystroke enum value will return an Optional object with no value.

Parameters

keystrokeString

The keystroke string to convert.

Returns

An Optional object, with the value as the corresponding Keystroke enum value for keystrokeString if there is a match. Otherwise, return an Optional object with no value.