LocaleAssetsManagerInterface.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_LOCALEASSETSMANAGERINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_LOCALEASSETSMANAGERINTERFACE_H_

#include <map>
#include <set>
#include <string>
#include <vector>

#include <AVSCommon/SDKInterfaces/CapabilityConfigurationChangeObserverInterface.h>
#include <AVSCommon/SDKInterfaces/Endpoints/EndpointRegistrationManagerInterface.h>
#include <AVSCommon/SDKInterfaces/LocaleAssetsObserverInterface.h>

namespace alexaClientSDK {
namespace avsCommon {
namespace sdkInterfaces {

class LocaleAssetsManagerInterface : public CapabilityConfigurationChangeObserverInterface {
public:
    using Locale = std::string;

    using LanguageTag = std::string;

    using WakeWords = std::set<std::string>;

    using WakeWordsSets = std::set<WakeWords>;

    using Locales = std::vector<Locale>;

    using LocaleCombinations = std::set<Locales>;

    virtual bool changeAssets(const Locales& locales, const WakeWords& wakeWords) = 0;

    virtual void cancelOngoingChange() = 0;

    virtual std::set<Locale> getSupportedLocales() const = 0;

    virtual LocaleCombinations getSupportedLocaleCombinations() const = 0;

    virtual Locale getDefaultLocale() const = 0;

    virtual Locales getDefaultLocales() const;

    virtual WakeWordsSets getDefaultSupportedWakeWords() const = 0;

    virtual std::map<LanguageTag, WakeWordsSets> getLanguageSpecificWakeWords() const = 0;

    virtual std::map<Locale, WakeWordsSets> getLocaleSpecificWakeWords() const = 0;

    virtual WakeWordsSets getSupportedWakeWords(const Locale& locale) const = 0;

    virtual void addLocaleAssetsObserver(const std::shared_ptr<LocaleAssetsObserverInterface>& observer) = 0;

    virtual void removeLocaleAssetsObserver(const std::shared_ptr<LocaleAssetsObserverInterface>& observer) = 0;

    virtual void setEndpointRegistrationManager(
        const std::shared_ptr<endpoints::EndpointRegistrationManagerInterface>& manager) = 0;

    virtual ~LocaleAssetsManagerInterface() = default;
};

inline LocaleAssetsManagerInterface::Locales LocaleAssetsManagerInterface::getDefaultLocales() const {
    return {getDefaultLocale()};
}

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

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_LOCALEASSETSMANAGERINTERFACE_H_