AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
StateProviderInterface.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_STATEPROVIDERINTERFACE_H_
17 #define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_STATEPROVIDERINTERFACE_H_
18 
20 
23 
24 namespace alexaClientSDK {
25 namespace avsCommon {
26 namespace sdkInterfaces {
27 
33 public:
37  virtual ~StateProviderInterface() = default;
38 
53  virtual void provideState(
54  const avs::NamespaceAndName& stateProviderName,
55  const ContextRequestToken stateRequestToken);
56 
72  virtual void provideState(const avs::CapabilityTag& stateProviderName, const ContextRequestToken stateRequestToken);
73 
81  virtual bool canStateBeRetrieved();
82 
89  virtual bool hasReportableStateProperties();
90 
97  virtual bool shouldQueryState();
98 };
99 
101  const avs::NamespaceAndName& stateProviderName,
102  const ContextRequestToken stateRequestToken) {
104  utils::logger::LogEntry("ContextRequesterInterface", __func__).d("reason", "methodDeprecated"));
105 }
106 
108  const avs::CapabilityTag& stateProviderName,
109  const ContextRequestToken stateRequestToken) {
110  provideState(avs::NamespaceAndName(stateProviderName), stateRequestToken);
111 }
112 
114  return true;
115 }
116 
118  return false;
119 }
120 
122  return true;
123 }
124 
125 } // namespace sdkInterfaces
126 } // namespace avsCommon
127 } // namespace alexaClientSDK
128 
129 #endif // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_STATEPROVIDERINTERFACE_H_
alexaClientSDK::avsCommon::sdkInterfaces::StateProviderInterface::~StateProviderInterface
virtual ~StateProviderInterface()=default
alexaClientSDK::avsCommon::sdkInterfaces::ContextRequestToken
unsigned int ContextRequestToken
Alias for the token used to identify a context request.
Definition: ContextRequestToken.h:23
alexaClientSDK::avsCommon::sdkInterfaces::StateProviderInterface
Definition: StateProviderInterface.h:32
alexaClientSDK::avsCommon::sdkInterfaces::StateProviderInterface::shouldQueryState
virtual bool shouldQueryState()
Definition: StateProviderInterface.h:121
alexaClientSDK::avsCommon::utils::logger::LogEntry
LogEntry is used to compile the log entry text to log via Logger.
Definition: LogEntry.h:32
ContextRequestToken.h
alexaClientSDK::avsCommon::sdkInterfaces::StateProviderInterface::hasReportableStateProperties
virtual bool hasReportableStateProperties()
Definition: StateProviderInterface.h:117
alexaClientSDK::avsCommon::sdkInterfaces::StateProviderInterface::canStateBeRetrieved
virtual bool canStateBeRetrieved()
Definition: StateProviderInterface.h:113
alexaClientSDK::avsCommon::sdkInterfaces::StateProviderInterface::provideState
virtual void provideState(const avs::NamespaceAndName &stateProviderName, const ContextRequestToken stateRequestToken)
Definition: StateProviderInterface.h:100
alexaClientSDK
Whether or not curl logs should be emitted.
Definition: AVSConnectionManager.h:36
alexaClientSDK::avsCommon::utils::logger::acsdkError
void acsdkError(const LogEntry &entry)
Definition: LoggerUtils.cpp:80
alexaClientSDK::avsCommon::avs::NamespaceAndName
Definition: NamespaceAndName.h:32
NamespaceAndName.h
CapabilityTag.h
alexaClientSDK::avsCommon::avs::CapabilityTag
Definition: CapabilityTag.h:32

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