CapabilityResources.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_CAPABILITYRESOURCES_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_CAPABILITYRESOURCES_H_

#include <vector>
#include <string>
#include <tuple>

#include <AVSCommon/AVS/AlexaAssetId.h>
#include <AVSCommon/SDKInterfaces/LocaleAssetsManagerInterface.h>
#include <AVSCommon/Utils/Optional.h>

namespace alexaClientSDK {
namespace avsCommon {
namespace avs {

class CapabilityResources {
public:
    CapabilityResources();

    bool addFriendlyNameWithAssetId(const resources::AlexaAssetId& assetId);

    bool addFriendlyNameWithText(
        const std::string& text,
        const sdkInterfaces::LocaleAssetsManagerInterface::Locale& locale);

    bool isValid() const;

    std::string toJson() const;

private:
    struct FriendlyName {
        std::string value;

        utils::Optional<sdkInterfaces::LocaleAssetsManagerInterface::Locale> locale;

        bool operator==(const FriendlyName& rhs) const;
    };

    bool m_isValid;

    std::vector<FriendlyName> m_items;
};

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

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_CAPABILITYRESOURCES_H_