NotificationsCapabilityAgent.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 ACSDKNOTIFICATIONS_NOTIFICATIONSCAPABILITYAGENT_H_
#define ACSDKNOTIFICATIONS_NOTIFICATIONSCAPABILITYAGENT_H_

#include <memory>
#include <unordered_set>

#include <acsdkManufactory/Annotated.h>
#include <acsdkNotificationsInterfaces/NotificationsNotifierInterface.h>
#include <acsdkNotificationsInterfaces/NotificationsObserverInterface.h>
#include <acsdkNotificationsInterfaces/NotificationRendererInterface.h>
#include <acsdkNotificationsInterfaces/NotificationRendererObserverInterface.h>
#include <acsdkNotificationsInterfaces/NotificationsStorageInterface.h>
#include <acsdkShutdownManagerInterfaces/ShutdownNotifierInterface.h>
#include <AVSCommon/AVS/CapabilityAgent.h>
#include <AVSCommon/AVS/CapabilityConfiguration.h>
#include <AVSCommon/SDKInterfaces/Audio/AudioFactoryInterface.h>
#include <AVSCommon/SDKInterfaces/Audio/NotificationsAudioFactoryInterface.h>
#include <AVSCommon/SDKInterfaces/Endpoints/DefaultEndpointAnnotation.h>
#include <AVSCommon/SDKInterfaces/Endpoints/EndpointCapabilitiesRegistrarInterface.h>
#include <AVSCommon/SDKInterfaces/CapabilityConfigurationInterface.h>
#include <AVSCommon/SDKInterfaces/ContextManagerInterface.h>
#include <AVSCommon/Utils/Metrics/MetricRecorderInterface.h>
#include <AVSCommon/Utils/RequiresShutdown.h>
#include <AVSCommon/Utils/Threading/Executor.h>
#include <RegistrationManager/CustomerDataHandler.h>

#include "acsdkNotifications/NotificationIndicator.h"
#include "acsdkNotifications/NotificationsCapabilityAgentState.h"

namespace alexaClientSDK {
namespace acsdkNotifications {

class NotificationsCapabilityAgent
        : public acsdkNotificationsInterfaces::NotificationRendererObserverInterface
        , public avsCommon::avs::CapabilityAgent
        , public avsCommon::sdkInterfaces::CapabilityConfigurationInterface
        , public avsCommon::utils::RequiresShutdown
        , public registrationManager::CustomerDataHandler
        , public std::enable_shared_from_this<NotificationsCapabilityAgent> {
public:
    static std::shared_ptr<NotificationsCapabilityAgent> createNotificationsCapabilityAgent(
        const std::shared_ptr<acsdkNotificationsInterfaces::NotificationsStorageInterface>& notificationsStorage,
        const std::shared_ptr<acsdkNotificationsInterfaces::NotificationRendererInterface>& renderer,
        const std::shared_ptr<avsCommon::sdkInterfaces::ContextManagerInterface>& contextManager,
        const std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface>& exceptionSender,
        const std::shared_ptr<avsCommon::sdkInterfaces::audio::AudioFactoryInterface>& audioFactory,
        const std::shared_ptr<registrationManager::CustomerDataManagerInterface>& dataManager,
        const std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownNotifierInterface>& shutdownNotifier,
        acsdkManufactory::Annotated<
            avsCommon::sdkInterfaces::endpoints::DefaultEndpointAnnotation,
            avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterface> endpointCapabilitiesRegistrar,
        const std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface>& metricRecorder);

    static std::shared_ptr<NotificationsCapabilityAgent> create(
        std::shared_ptr<acsdkNotificationsInterfaces::NotificationsStorageInterface> notificationsStorage,
        std::shared_ptr<acsdkNotificationsInterfaces::NotificationRendererInterface> renderer,
        std::shared_ptr<avsCommon::sdkInterfaces::ContextManagerInterface> contextManager,
        std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface> exceptionSender,
        std::shared_ptr<avsCommon::sdkInterfaces::audio::NotificationsAudioFactoryInterface> notificationsAudioFactory,
        std::shared_ptr<registrationManager::CustomerDataManagerInterface> dataManager,
        std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> metricRecorder = nullptr);

    ~NotificationsCapabilityAgent() override;

    std::shared_ptr<acsdkNotificationsInterfaces::NotificationsNotifierInterface> getNotificationsNotifierInterface();

    void handleDirectiveImmediately(std::shared_ptr<avsCommon::avs::AVSDirective> directive) override;
    void preHandleDirective(std::shared_ptr<DirectiveInfo> info) override;
    void handleDirective(std::shared_ptr<DirectiveInfo> info) override;
    void cancelDirective(std::shared_ptr<DirectiveInfo> info) override;
    avsCommon::avs::DirectiveHandlerConfiguration getConfiguration() const override;

    void provideState(const avsCommon::avs::NamespaceAndName& stateProviderName, unsigned int stateRequestToken)
        override;


    void onNotificationRenderingFinished() override;

    void clearData() override;

    std::unordered_set<std::shared_ptr<avsCommon::avs::CapabilityConfiguration>> getCapabilityConfigurations() override;

private:
    NotificationsCapabilityAgent(
        std::shared_ptr<acsdkNotificationsInterfaces::NotificationsStorageInterface> notificationsStorage,
        std::shared_ptr<acsdkNotificationsInterfaces::NotificationRendererInterface> renderer,
        std::shared_ptr<avsCommon::sdkInterfaces::ContextManagerInterface> contextManager,
        std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface> exceptionSender,
        std::shared_ptr<avsCommon::sdkInterfaces::audio::NotificationsAudioFactoryInterface> notificationsAudioFactory,
        std::shared_ptr<registrationManager::CustomerDataManagerInterface> dataManager,
        std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> metricRecorder);

    bool init();

    bool parseDirectivePayload(std::shared_ptr<DirectiveInfo> info, rapidjson::Document* document);

    void handleSetIndicatorDirective(std::shared_ptr<DirectiveInfo> info);

    void handleClearIndicatorDirective(std::shared_ptr<DirectiveInfo> info);

    void doShutdown() override;

    void setHandlingCompleted(std::shared_ptr<DirectiveInfo> info);


    void executeRenderNotification(const NotificationIndicator& notificationIndicator);

    void executePossibleIndicatorStateChange(const avsCommon::avs::IndicatorState& nextIndicatorState);

    void executeSetState(NotificationsCapabilityAgentState newState);

    void executeProvideState(bool sendToken = false, unsigned int stateRequestToken = 0);

    void notifyObserversOfIndicatorState(avsCommon::avs::IndicatorState state);

    void notifyObserversOfNotificationReceived();

    void executeInit();

    void executeOnPlayFinished();


    void executeStartQueueNotEmpty();

    void executeSetIndicator(
        const NotificationIndicator& nextNotificationIndicator,
        std::shared_ptr<DirectiveInfo> info);

    void executeClearIndicator(std::shared_ptr<DirectiveInfo> info);

    void executePlayFinishedZeroQueued();

    void executePlayFinishedOneQueued();

    void executePlayFinishedMultipleQueued();

    void executeShutdown();


    std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> m_metricRecorder;

    std::shared_ptr<acsdkNotificationsInterfaces::NotificationsStorageInterface> m_notificationsStorage;

    std::shared_ptr<avsCommon::sdkInterfaces::ContextManagerInterface> m_contextManager;

    std::shared_ptr<acsdkNotificationsInterfaces::NotificationRendererInterface> m_renderer;

    std::shared_ptr<avsCommon::sdkInterfaces::audio::NotificationsAudioFactoryInterface> m_notificationsAudioFactory;

    std::string m_currentAssetId;

    bool m_isEnabled;

    std::shared_ptr<acsdkNotificationsInterfaces::NotificationsNotifierInterface> m_notifier;

    NotificationsCapabilityAgentState m_currentState;

    std::unordered_set<std::shared_ptr<avsCommon::avs::CapabilityConfiguration>> m_capabilityConfigurations;

    avsCommon::utils::threading::Executor m_executor;

    std::condition_variable m_shutdownTrigger;

    std::mutex m_shutdownMutex;
};

}  // namespace acsdkNotifications
}  // namespace alexaClientSDK

#endif  // ACSDKNOTIFICATIONS_NOTIFICATIONSCAPABILITYAGENT_H_