ModeControllerInterface.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 ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_MODECONTROLLER_MODECONTROLLERINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_MODECONTROLLER_MODECONTROLLERINTERFACE_H_

#include <AVSCommon/AVS/AlexaResponseType.h>
#include <AVSCommon/SDKInterfaces/AlexaStateChangeCauseType.h>
#include <AVSCommon/SDKInterfaces/ModeController/ModeControllerObserverInterface.h>
#include <AVSCommon/Utils/Optional.h>

namespace alexaClientSDK {
namespace avsCommon {
namespace sdkInterfaces {
namespace modeController {

class ModeControllerInterface {
public:
    using ModeState = avsCommon::sdkInterfaces::modeController::ModeControllerObserverInterface::ModeState;

    virtual ~ModeControllerInterface() = default;

    using ModeControllerConfiguration = std::vector<std::string>;

    virtual ModeControllerConfiguration getConfiguration() = 0;

    virtual std::pair<avsCommon::avs::AlexaResponseType, std::string> setMode(
        const std::string& mode,
        AlexaStateChangeCauseType cause) = 0;

    virtual std::pair<avsCommon::avs::AlexaResponseType, std::string> adjustMode(
        int modeDelta,
        AlexaStateChangeCauseType cause) = 0;

    virtual std::pair<avsCommon::avs::AlexaResponseType, utils::Optional<ModeState>> getMode() = 0;

    virtual bool addObserver(std::shared_ptr<ModeControllerObserverInterface> observer) = 0;

    virtual void removeObserver(const std::shared_ptr<ModeControllerObserverInterface>& observer) = 0;
};

}  // namespace modeController
}  // namespace sdkInterfaces
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_MODECONTROLLER_MODECONTROLLERINTERFACE_H_