CapabilityConfiguration.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_AVS_INCLUDE_AVSCOMMON_AVS_CAPABILITYCONFIGURATION_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_CAPABILITYCONFIGURATION_H_

#include <map>
#include <string>
#include <unordered_map>
#include <vector>

#include <AVSCommon/Utils/Optional.h>

namespace alexaClientSDK {
namespace avsCommon {
namespace avs {

static const auto CAPABILITY_INTERFACE_TYPE_KEY = "type";
static const auto CAPABILITY_INTERFACE_NAME_KEY = "interface";
static const auto CAPABILITY_INTERFACE_VERSION_KEY = "version";
static const auto CAPABILITY_INTERFACE_CONFIGURATIONS_KEY = "configurations";

struct CapabilityConfiguration {
    static constexpr const char* ALEXA_INTERFACE_TYPE = "AlexaInterface";

    using AdditionalConfigurations = std::map<std::string, std::string>;

    struct Properties {
        bool isRetrievable;
        bool isProactivelyReported;
        std::vector<std::string> supportedList;
        avsCommon::utils::Optional<bool> isNonControllable;

        Properties(
            bool isRetrievableIn = false,
            bool isProactivelyReportedIn = false,
            const std::vector<std::string>& supportedListIn = std::vector<std::string>(),
            const avsCommon::utils::Optional<bool>& isNonControllableIn = avsCommon::utils::Optional<bool>());
    };

    CapabilityConfiguration() = default;

    CapabilityConfiguration(const std::unordered_map<std::string, std::string>& capabilityConfigurationIn);

    CapabilityConfiguration(
        const std::string& typeIn,
        const std::string& interfaceNameIn,
        const std::string& versionIn,
        const avsCommon::utils::Optional<std::string>& instanceNameIn = avsCommon::utils::Optional<std::string>(),
        const avsCommon::utils::Optional<Properties>& propertiesIn = avsCommon::utils::Optional<Properties>(),
        const AdditionalConfigurations& additionalConfigurationsIn = AdditionalConfigurations());

    std::string type;
    std::string interfaceName;
    std::string version;
    avsCommon::utils::Optional<std::string> instanceName;
    avsCommon::utils::Optional<Properties> properties;
    AdditionalConfigurations additionalConfigurations;
};

bool operator==(const CapabilityConfiguration::Properties& lhs, const CapabilityConfiguration::Properties& rhs);

bool operator!=(const CapabilityConfiguration::Properties& lhs, const CapabilityConfiguration::Properties& rhs);

bool operator==(const CapabilityConfiguration& lhs, const CapabilityConfiguration& rhs);

bool operator!=(const CapabilityConfiguration& lhs, const CapabilityConfiguration& rhs);

bool operator==(
    const std::shared_ptr<CapabilityConfiguration>& lhs,
    const std::shared_ptr<CapabilityConfiguration>& rhs);

bool operator!=(
    const std::shared_ptr<CapabilityConfiguration>& lhs,
    const std::shared_ptr<CapabilityConfiguration>& rhs);

}  // namespace avs
}  // namespace avsCommon
}  // namespace alexaClientSDK

namespace std {

template <>
struct hash<alexaClientSDK::avsCommon::avs::CapabilityConfiguration> {
    size_t operator()(const alexaClientSDK::avsCommon::avs::CapabilityConfiguration& in) const;
};

template <>
struct hash<std::shared_ptr<alexaClientSDK::avsCommon::avs::CapabilityConfiguration>> {
    size_t operator()(const std::shared_ptr<alexaClientSDK::avsCommon::avs::CapabilityConfiguration>& in) const;
};

}  // namespace std

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_CAPABILITYCONFIGURATION_H_