Shaker/Avalonia/SukiUI/Toasts/ISukiToastManager.cs

using System;

namespace SukiUI.Toasts
{
    public interface ISukiToastManager
    {
        /// <summary>
        /// Raised whenever a toast is queued.
        /// </summary>
        event SukiToastManagerEventHandler OnToastQueued;
        
        /// <summary>
        /// Raised whenever a toast is dismissed.
        /// </summary>
        event SukiToastManagerEventHandler OnToastDismissed;
        
        /// <summary>
        /// Raised whenever all toasts are dismissed at once.
        /// </summary>
        event EventHandler OnAllToastsDismissed;
        
        /// <summary>
        /// Queues a given toast for display.
        /// </summary>
        void Queue(ISukiToast toast);
        
        /// <summary>
        /// Dismisses a given toast from the stack, if it is still present.
        /// </summary>
        void Dismiss(ISukiToast toast);

        /// <summary>
        /// Dismisses a specific number of toasts from the stack.
        /// </summary>
        void Dismiss(int count);

        /// <summary>
        /// Ensures that the toast stack doesn't exceed the specified maximum.
        /// If it does, it will dismiss the oldest toasts down to the maximum.
        /// </summary>
        /// <param name="maxAllowed"></param>
        void EnsureMaximum(int maxAllowed);
        
        /// <summary>
        /// Dismisses all toasts from the stack immediately.
        /// </summary>
        void DismissAll();
        
        /// <summary>
        /// Checks to see if a <see cref="ISukiToast"/> has already been dismissed from the stack.
        /// </summary>
        bool IsDismissed(ISukiToast toast);
    }
}