AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
LocaleAssetsManagerInterface.h
Go to the documentation of this file.
1 /*
2  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License").
5  * You may not use this file except in compliance with the License.
6  * A copy of the License is located at
7  *
8  * http://aws.amazon.com/apache2.0/
9  *
10  * or in the "license" file accompanying this file. This file is distributed
11  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12  * express or implied. See the License for the specific language governing
13  * permissions and limitations under the License.
14  */
15 
16 #ifndef ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_LOCALEASSETSMANAGERINTERFACE_H_
17 #define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_LOCALEASSETSMANAGERINTERFACE_H_
18 
19 #include <map>
20 #include <set>
21 #include <string>
22 #include <vector>
23 
27 
28 namespace alexaClientSDK {
29 namespace avsCommon {
30 namespace sdkInterfaces {
31 
41 public:
46  using Locale = std::string;
47 
52  using LanguageTag = std::string;
53 
57  using WakeWords = std::set<std::string>;
58 
62  using WakeWordsSets = std::set<WakeWords>;
63 
68  using Locales = std::vector<Locale>;
69 
73  using LocaleCombinations = std::set<Locales>;
74 
82  virtual bool changeAssets(const Locales& locales, const WakeWords& wakeWords) = 0;
83 
90  virtual void cancelOngoingChange() = 0;
91 
97  virtual std::set<Locale> getSupportedLocales() const = 0;
98 
108 
116  virtual Locale getDefaultLocale() const = 0;
117 
123  virtual Locales getDefaultLocales() const;
124 
132  virtual WakeWordsSets getDefaultSupportedWakeWords() const = 0;
133 
141  virtual std::map<LanguageTag, WakeWordsSets> getLanguageSpecificWakeWords() const = 0;
142 
150  virtual std::map<Locale, WakeWordsSets> getLocaleSpecificWakeWords() const = 0;
151 
158  virtual WakeWordsSets getSupportedWakeWords(const Locale& locale) const = 0;
159 
165  virtual void addLocaleAssetsObserver(const std::shared_ptr<LocaleAssetsObserverInterface>& observer) = 0;
166 
172  virtual void removeLocaleAssetsObserver(const std::shared_ptr<LocaleAssetsObserverInterface>& observer) = 0;
173 
179  virtual void setEndpointRegistrationManager(
180  const std::shared_ptr<endpoints::EndpointRegistrationManagerInterface>& manager) = 0;
181 
185  virtual ~LocaleAssetsManagerInterface() = default;
186 };
187 
189  return {getDefaultLocale()};
190 }
191 
192 } // namespace sdkInterfaces
193 } // namespace avsCommon
194 } // namespace alexaClientSDK
195 
196 #endif // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_LOCALEASSETSMANAGERINTERFACE_H_
alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsManagerInterface::getDefaultLocale
virtual Locale getDefaultLocale() const =0
alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsManagerInterface::Locale
std::string Locale
Definition: LocaleAssetsManagerInterface.h:46
alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsManagerInterface::getDefaultSupportedWakeWords
virtual WakeWordsSets getDefaultSupportedWakeWords() const =0
alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsManagerInterface::getSupportedLocales
virtual std::set< Locale > getSupportedLocales() const =0
alexaClientSDK::avsCommon::sdkInterfaces::CapabilityConfigurationChangeObserverInterface
Definition: CapabilityConfigurationChangeObserverInterface.h:30
alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsManagerInterface::getLanguageSpecificWakeWords
virtual std::map< LanguageTag, WakeWordsSets > getLanguageSpecificWakeWords() const =0
alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsManagerInterface
Definition: LocaleAssetsManagerInterface.h:40
CapabilityConfigurationChangeObserverInterface.h
alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsManagerInterface::getDefaultLocales
virtual Locales getDefaultLocales() const
Definition: LocaleAssetsManagerInterface.h:188
alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsManagerInterface::setEndpointRegistrationManager
virtual void setEndpointRegistrationManager(const std::shared_ptr< endpoints::EndpointRegistrationManagerInterface > &manager)=0
alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsManagerInterface::changeAssets
virtual bool changeAssets(const Locales &locales, const WakeWords &wakeWords)=0
alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsManagerInterface::LanguageTag
std::string LanguageTag
Definition: LocaleAssetsManagerInterface.h:52
EndpointRegistrationManagerInterface.h
alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsManagerInterface::WakeWords
std::set< std::string > WakeWords
Definition: LocaleAssetsManagerInterface.h:57
alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsManagerInterface::getSupportedLocaleCombinations
virtual LocaleCombinations getSupportedLocaleCombinations() const =0
LocaleAssetsObserverInterface.h
alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsManagerInterface::Locales
std::vector< Locale > Locales
Definition: LocaleAssetsManagerInterface.h:68
alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsManagerInterface::~LocaleAssetsManagerInterface
virtual ~LocaleAssetsManagerInterface()=default
alexaClientSDK
Whether or not curl logs should be emitted.
Definition: AVSConnectionManager.h:36
alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsManagerInterface::LocaleCombinations
std::set< Locales > LocaleCombinations
Definition: LocaleAssetsManagerInterface.h:73
alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsManagerInterface::cancelOngoingChange
virtual void cancelOngoingChange()=0
alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsManagerInterface::WakeWordsSets
std::set< WakeWords > WakeWordsSets
Definition: LocaleAssetsManagerInterface.h:62
alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsManagerInterface::removeLocaleAssetsObserver
virtual void removeLocaleAssetsObserver(const std::shared_ptr< LocaleAssetsObserverInterface > &observer)=0
alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsManagerInterface::getLocaleSpecificWakeWords
virtual std::map< Locale, WakeWordsSets > getLocaleSpecificWakeWords() const =0
alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsManagerInterface::addLocaleAssetsObserver
virtual void addLocaleAssetsObserver(const std::shared_ptr< LocaleAssetsObserverInterface > &observer)=0
alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsManagerInterface::getSupportedWakeWords
virtual WakeWordsSets getSupportedWakeWords(const Locale &locale) const =0

AlexaClientSDK 1.26.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0