ContextManagerInterface.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_CONTEXTMANAGERINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_CONTEXTMANAGERINTERFACE_H_

#include <chrono>
#include <memory>
#include <string>

#include "AVSCommon/AVS/CapabilityTag.h"
#include "AVSCommon/AVS/StateRefreshPolicy.h"
#include "AVSCommon/SDKInterfaces/AlexaStateChangeCauseType.h"
#include "AVSCommon/SDKInterfaces/ContextManagerObserverInterface.h"
#include "AVSCommon/SDKInterfaces/ContextRequesterInterface.h"
#include "AVSCommon/SDKInterfaces/StateProviderInterface.h"

namespace alexaClientSDK {
namespace avsCommon {
namespace sdkInterfaces {

enum class SetStateResult {
    SUCCESS,

    STATE_PROVIDER_NOT_REGISTERED,

    STATE_TOKEN_OUTDATED
};

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

    virtual void setStateProvider(
        const avs::CapabilityTag& capabilityIdentifier,
        std::shared_ptr<StateProviderInterface> stateProvider) = 0;

    virtual void addStateProvider(
        const avsCommon::avs::CapabilityTag& capabilityIdentifier,
        std::shared_ptr<avsCommon::sdkInterfaces::StateProviderInterface> stateProvider) = 0;

    virtual void removeStateProvider(const avs::CapabilityTag& capabilityIdentifier) = 0;

    virtual SetStateResult setState(
        const avs::CapabilityTag& capabilityIdentifier,
        const std::string& jsonState,
        const avs::StateRefreshPolicy& refreshPolicy,
        const ContextRequestToken stateRequestToken = 0) = 0;

    virtual void reportStateChange(
        const avs::CapabilityTag& capabilityIdentifier,
        const avs::CapabilityState& capabilityState,
        AlexaStateChangeCauseType cause) = 0;

    virtual void provideStateResponse(
        const avs::CapabilityTag& capabilityIdentifier,
        const avs::CapabilityState& capabilityState,
        ContextRequestToken stateRequestToken) = 0;

    virtual void provideStateUnavailableResponse(
        const avs::CapabilityTag& capabilityIdentifier,
        ContextRequestToken stateRequestToken,
        bool isEndpointUnreachable) = 0;

    virtual ContextRequestToken getContext(
        std::shared_ptr<ContextRequesterInterface> contextRequester,
        const std::string& endpointId = "",
        const std::chrono::milliseconds& timeout = std::chrono::seconds(2)) = 0;

    virtual ContextRequestToken getContextWithoutReportableStateProperties(
        std::shared_ptr<ContextRequesterInterface> contextRequester,
        const std::string& endpointId = "",
        const std::chrono::milliseconds& timeout = std::chrono::seconds(2)) = 0;

    virtual void addContextManagerObserver(std::shared_ptr<ContextManagerObserverInterface> observer) = 0;

    virtual void removeContextManagerObserver(const std::shared_ptr<ContextManagerObserverInterface>& observer) = 0;
};

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

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_CONTEXTMANAGERINTERFACE_H_