NotificationsStorageInterface.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 ACSDKNOTIFICATIONSINTERFACES_NOTIFICATIONSSTORAGEINTERFACE_H_
#define ACSDKNOTIFICATIONSINTERFACES_NOTIFICATIONSSTORAGEINTERFACE_H_

#include <AVSCommon/AVS/IndicatorState.h>
#include <acsdkNotifications/NotificationIndicator.h>

namespace alexaClientSDK {
namespace acsdkNotificationsInterfaces {

class NotificationsStorageInterface {
public:
    using IndicatorState = avsCommon::avs::IndicatorState;

    virtual ~NotificationsStorageInterface() = default;

    virtual bool createDatabase() = 0;

    virtual bool open() = 0;

    virtual void close() = 0;

    virtual bool enqueue(const acsdkNotifications::NotificationIndicator& notificationIndicator) = 0;

    virtual bool dequeue() = 0;

    virtual bool peek(acsdkNotifications::NotificationIndicator* notificationIndicator) = 0;

    virtual bool setIndicatorState(IndicatorState state) = 0;

    virtual bool getIndicatorState(IndicatorState* state) = 0;

    virtual bool checkForEmptyQueue(bool* empty) = 0;

    virtual bool clearNotificationIndicators() = 0;

    virtual bool getQueueSize(int* size) = 0;
};

}  // namespace acsdkNotificationsInterfaces
}  // namespace alexaClientSDK

#endif  // ACSDKNOTIFICATIONSINTERFACES_NOTIFICATIONSSTORAGEINTERFACE_H_