AlexaKeypadControllerInterface.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

#ifndef ACSDKALEXAKEYPADCONTROLLERINTERFACES_ALEXAKEYPADCONTROLLERINTERFACE_H_
#define ACSDKALEXAKEYPADCONTROLLERINTERFACES_ALEXAKEYPADCONTROLLERINTERFACE_H_

#include <set>
#include <string>

#include <AVSCommon/Utils/Optional.h>

#include "acsdkAlexaKeypadControllerInterfaces/Keystroke.h"

namespace alexaClientSDK {
namespace acsdkAlexaKeypadControllerInterfaces {

class AlexaKeypadControllerInterface {
public:
    struct Response {
        enum class Type {
            SUCCESS,

            NO_INFORMATION_AVAILABLE,

            INVALID_SELECTION,

            KEYSTROKE_NOT_SUPPORTED,

            INTERNAL_ERROR
        };

        Response() : type{Type::SUCCESS} {};

        Type type;

        std::string errorMessage;
    };

    virtual ~AlexaKeypadControllerInterface() = default;

    virtual Response handleKeystroke(Keystroke keystroke) = 0;

    virtual std::set<Keystroke> getSupportedKeys() = 0;
};

}  // namespace acsdkAlexaKeypadControllerInterfaces
}  // namespace alexaClientSDK

#endif  // ACSDKALEXAKEYPADCONTROLLERINTERFACES_ALEXAKEYPADCONTROLLERINTERFACE_H_