ModeControllerAttributeBuilderInterface.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_MODECONTROLLERATTRIBUTEBUILDERINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_MODECONTROLLER_MODECONTROLLERATTRIBUTEBUILDERINTERFACE_H_

#include <AVSCommon/AVS/CapabilityResources.h>
#include <AVSCommon/AVS/CapabilitySemantics/CapabilitySemantics.h>
#include <AVSCommon/Utils/Optional.h>

#include "ModeControllerAttributes.h"

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

class ModeControllerAttributeBuilderInterface {
public:
    virtual ~ModeControllerAttributeBuilderInterface() = default;

    virtual ModeControllerAttributeBuilderInterface& withCapabilityResources(
        const avsCommon::avs::CapabilityResources& capabilityResources) = 0;

    virtual ModeControllerAttributeBuilderInterface& addMode(
        const std::string& mode,
        const ModeResources& modeResources) = 0;

    virtual ModeControllerAttributeBuilderInterface& setOrdered(bool ordered) = 0;

    virtual ModeControllerAttributeBuilderInterface& withSemantics(
        const avsCommon::avs::capabilitySemantics::CapabilitySemantics& semantics) = 0;

    virtual utils::Optional<ModeControllerAttributes> build() = 0;
};

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

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_MODECONTROLLER_MODECONTROLLERATTRIBUTEBUILDERINTERFACE_H_