AlexaClientSDK  1.23.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 
80  virtual bool canStateBeRetrieved();
81 
88  virtual bool hasReportableStateProperties();
89 };
90 
92  const avs::NamespaceAndName& stateProviderName,
93  const ContextRequestToken stateRequestToken) {
95  utils::logger::LogEntry("ContextRequesterInterface", __func__).d("reason", "methodDeprecated"));
96 }
97 
99  const avs::CapabilityTag& stateProviderName,
100  const ContextRequestToken stateRequestToken) {
101  provideState(avs::NamespaceAndName(stateProviderName), stateRequestToken);
102 }
103 
105  return true;
106 }
107 
109  return false;
110 }
111 
112 } // namespace sdkInterfaces
113 } // namespace avsCommon
114 } // namespace alexaClientSDK
115 
116 #endif // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_STATEPROVIDERINTERFACE_H_
virtual void provideState(const avs::NamespaceAndName &stateProviderName, const ContextRequestToken stateRequestToken)
Definition: StateProviderInterface.h:91
Definition: NamespaceAndName.h:32
Definition: CapabilityTag.h:32
unsigned int ContextRequestToken
Alias for the token used to identify a context request.
Definition: ContextRequestToken.h:23
virtual bool hasReportableStateProperties()
Definition: StateProviderInterface.h:108
Whether or not curl logs should be emitted.
Definition: AVSConnectionManager.h:36
void acsdkError(const LogEntry &entry)
Definition: LoggerUtils.cpp:80
virtual bool canStateBeRetrieved()
Definition: StateProviderInterface.h:104
LogEntry is used to compile the log entry text to log via Logger.
Definition: LogEntry.h:32

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