pulsar/ObservatoryFramework/EventArgs.cs

using System.Text.Json.Nodes;

namespace Observatory.Framework;

/// <summary>
/// Provides data for Elite Dangerous journal events.
/// </summary>
public class JournalEventArgs(string journalEventType, JsonObject journalEvent) : EventArgs
{
    /// <summary>
    /// <para>Type of journal entry that triggered event.</para>
    /// </summary>
    public string JournalEventType = journalEventType;

    /// <summary>
    /// <para>Elite Dangerous journal event, deserialized into a .NET object of the type specified by JournalEventArgs.journalType.</para>
    /// <para>Unhandled json values within a journal entry type will be contained in member property:<br/>Dictionary&lt;string, object&gt; AdditionalProperties.</para>
    /// </summary>
    public JsonObject JournalEvent = journalEvent;
}

/// <summary>
/// Provides values used as arguments for Observatory notification events.
/// </summary>
public class NotificationArgs
{
    /// <summary>
    /// Text typically displayed as header content.
    /// </summary>
    public string Title;

    /// <summary>
    /// SSML representation of Title text.<br/>
    /// This value is optional, if omitted the value of <c>NotificationArgs.Title</c> will be used for voice synthesis without markup.
    /// </summary>
    public string TitleSsml;

    /// <summary>
    /// Text typically displayed as body content.
    /// </summary>
    public string Detail;

    /// <summary>
    /// SSML representation of Detail text.<br/>
    /// This value is optional, if omitted the value of <c>NotificationArgs.Detail</c> will be used for voice synthesis without markup.
    /// </summary>
    public string DetailSsml;

    /// <summary>
    /// Specify window timeout in ms (overrides Core setting). Specify 0 timeout to persist until removed via IObservatoryCore.CancelNotification. Default -1 (use Core setting).
    /// </summary>
    public int Timeout = -1;

    /// <summary>
    /// Specify window X position as a percentage from upper left corner (overrides Core setting). Default -1.0 (use Core setting).
    /// </summary>
    public double XPos = -1.0;

    /// <summary>
    /// Specify window Y position as a percentage from upper left corner (overrides Core setting). Default -1.0 (use Core setting).
    /// </summary>
    public double YPos = -1.0;

    /// <summary>
    /// Specifies the desired renderings of the notification. Defaults to <see cref="NotificationRendering.All"/>.
    /// </summary>
    public NotificationRendering Rendering = NotificationRendering.All;

    /// <summary>
    /// Specifies if some part of the notification should be suppressed. Not supported by all notifiers. Defaults to <see cref="NotificationSuppression.None"/>.
    /// </summary>
    public NotificationSuppression Suppression = NotificationSuppression.None;

    /// <summary>
    /// The plugin sending this notification.
    /// </summary>
    public string Sender = "";

    /// <summary>
    /// Additional notification detailed (generally not rendered by voice or popup; potentially used by aggregating/logging plugins).
    /// </summary>
    public string ExtendedDetails;

    /// <summary>
    /// A value which allows grouping of notifications together. For example, values &gt;= 0 &lt;= 1000 could be system body IDs, -1 is the system, anything else is arbitrary.
    /// </summary>
    public int? CoalescingId;
}

/// <summary>
/// Defines constants for suppression of title or detail announcement in a notification.
/// </summary>
[Flags]
public enum NotificationSuppression
{
    /// <summary>
    /// No suppression.
    /// </summary>
    None = 0,

    /// <summary>
    /// Suppress title.
    /// </summary>
    Title = 1,

    /// <summary>
    /// Suppress detail.
    /// </summary>
    Detail = 2,
}

/// <summary>
/// Defines constants for controlling notification routing to plugins or native notification handlers.
/// </summary>
[Flags]
public enum NotificationRendering
{
    /// <summary>
    /// Send notification to native visual popup notificaiton handler.
    /// </summary>
    NativeVisual = 1,

    /// <summary>
    /// Send notification to native speech notification handler.
    /// </summary>
    NativeVocal = 2,

    /// <summary>
    /// Send notification to all installed notifier plugins.
    /// </summary>
    PluginNotifier = 4,

    /// <summary>
    /// Send notification to all available handlers.
    /// </summary>
    All = (NativeVisual | NativeVocal | PluginNotifier)
}

/// <summary>
/// Flags indicating current state of journal monitoring.
/// </summary>
[Flags]
public enum LogMonitorState : uint
{
    /// <summary>
    /// Monitoring is stopped.
    /// </summary>
    Idle = 0,

    /// <summary>
    /// Real-time monitoring is active.
    /// </summary>
    Realtime = 1,

    /// <summary>
    /// Batch read of historical journals is in progress.
    /// </summary>
    BatchProcessing = 2,

    /// <summary>
    /// Initial read of recent journals to establish current player state is in progress .
    /// </summary>
    Init = 4
}

/// <summary>
/// Provides information about a LogMonitor state transition.
/// </summary>
public class LogMonitorStateChangedEventArgs : EventArgs
{
    /// <summary>
    /// The previous LogMonitor state.
    /// </summary>
    public LogMonitorState PreviousState;

    /// <summary>
    /// The new, current LogMonitor state.
    /// </summary>
    public LogMonitorState NewState;

    /// <summary>
    /// Determins if the given state is a batch read of any form.
    /// </summary>
    /// <param name="state">The state to evaluate</param>
    /// <returns>A boolean; True iff the state provided represents a batch-mode read.</returns>
    public static bool IsBatchRead(LogMonitorState state)
    {
        return state.HasFlag(LogMonitorState.BatchProcessing) || state.HasFlag(LogMonitorState.Init);
    }
}