StateProviderInterface.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_STATEPROVIDERINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_STATEPROVIDERINTERFACE_H_

#include "AVSCommon/SDKInterfaces/ContextRequestToken.h"

#include <AVSCommon/AVS/CapabilityTag.h>
#include <AVSCommon/AVS/NamespaceAndName.h>

namespace alexaClientSDK {
namespace avsCommon {
namespace sdkInterfaces {

class StateProviderInterface {
public:
    virtual ~StateProviderInterface() = default;

    virtual void provideState(
        const avs::NamespaceAndName& stateProviderName,
        const ContextRequestToken stateRequestToken);

    virtual void provideState(const avs::CapabilityTag& stateProviderName, const ContextRequestToken stateRequestToken);

    virtual bool canStateBeRetrieved();

    virtual bool hasReportableStateProperties();

    virtual bool shouldQueryState();
};

inline void StateProviderInterface::provideState(
    const avs::NamespaceAndName& stateProviderName,
    const ContextRequestToken stateRequestToken) {
    utils::logger::acsdkError(
        utils::logger::LogEntry("ContextRequesterInterface", __func__).d("reason", "methodDeprecated"));
}

inline void StateProviderInterface::provideState(
    const avs::CapabilityTag& stateProviderName,
    const ContextRequestToken stateRequestToken) {
    provideState(avs::NamespaceAndName(stateProviderName), stateRequestToken);
}

inline bool StateProviderInterface::canStateBeRetrieved() {
    return true;
}

inline bool StateProviderInterface::hasReportableStateProperties() {
    return false;
}

inline bool StateProviderInterface::shouldQueryState() {
    return true;
}

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

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_STATEPROVIDERINTERFACE_H_