From 31a9cfc92d91a1364cdf6bab66926cdaf71867bf Mon Sep 17 00:00:00 2001
From: F K <54195004+fredjk-gh@users.noreply.github.com>
Date: Tue, 23 Jan 2024 19:36:16 -0500
Subject: [PATCH] [Framework] Add 3 new properties to NotificationArgs to
 expand detail (#131)

The new properties are:

* string Sender: The name of the plugin sending the notification.
* string ExtendedDetails: Even more detail than Title and Detail convey. This value will not be spoken nor included in pop-up notifications. However, other notifier plugins may use this value.
* int ColescingId: An id which can be used to correlate multiple notifications together (ie. for sorting/grouping) without depending on arbitrary string values. I recommend reserving -1 for system, 0 .. 1000 for system bodies and anything else is arbitrary and can be agreed upon between Core and Plugin authors, as desired.

While the motivating use is a new notifier plugin I am authoring (my Aggregator plugin, see GitHub), I have tried to make this as general purpose as possible.

I have modified Explorer as an example of usage. After this is merged, I'll follow up with another PR to use this in Botanist as well (I have other changes pending for Botanist; see #120).

Comments welcomed!
---
 ObservatoryExplorer/Explorer.cs               |  7 ++++++-
 ObservatoryFramework/EventArgs.cs             | 12 ++++++++++++
 ObservatoryFramework/ObservatoryFramework.xml | 15 +++++++++++++++
 3 files changed, 33 insertions(+), 1 deletion(-)

diff --git a/ObservatoryExplorer/Explorer.cs b/ObservatoryExplorer/Explorer.cs
index 968fbc4..e66c918 100644
--- a/ObservatoryExplorer/Explorer.cs
+++ b/ObservatoryExplorer/Explorer.cs
@@ -240,6 +240,7 @@ namespace Observatory.Explorer
             if (results.Count > 0)
             {
                 StringBuilder notificationDetail = new();
+                StringBuilder notificationExtendedDetail = new();
                 foreach (var result in results)
                 {
                     var scanResult = new ExplorerUIResults()
@@ -251,6 +252,7 @@ namespace Observatory.Explorer
                     };
                     ObservatoryCore.AddGridItem(ExplorerWorker, scanResult);
                     notificationDetail.AppendLine(result.Description);
+                    notificationExtendedDetail.AppendLine(result.Detail);
                 }
 
                 string bodyAffix;
@@ -293,7 +295,10 @@ namespace Observatory.Explorer
                 {
                     Title = bodyLabel + bodyAffix,
                     TitleSsml = $"<speak version=\"1.0\" xmlns=\"http://www.w3.org/2001/10/synthesis\" xml:lang=\"en-US\"><voice name=\"\">{bodyLabel} {spokenAffix}</voice></speak>",
-                    Detail = notificationDetail.ToString()
+                    Detail = notificationDetail.ToString(),
+                    Sender = ExplorerWorker.ShortName,
+                    ExtendedDetails = notificationExtendedDetail.ToString(),
+                    CoalescingId = scanEvent.BodyID,
                 };
 
                 ObservatoryCore.SendNotification(args);
diff --git a/ObservatoryFramework/EventArgs.cs b/ObservatoryFramework/EventArgs.cs
index d2b1166..de638a8 100644
--- a/ObservatoryFramework/EventArgs.cs
+++ b/ObservatoryFramework/EventArgs.cs
@@ -62,6 +62,18 @@ namespace Observatory.Framework
         /// 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>
diff --git a/ObservatoryFramework/ObservatoryFramework.xml b/ObservatoryFramework/ObservatoryFramework.xml
index c65f353..63ab194 100644
--- a/ObservatoryFramework/ObservatoryFramework.xml
+++ b/ObservatoryFramework/ObservatoryFramework.xml
@@ -148,6 +148,21 @@
             Specifies if some part of the notification should be suppressed. Not supported by all notifiers. Defaults to <see cref="F:Observatory.Framework.NotificationSuppression.None"/>.
             </summary>
         </member>
+        <member name="F:Observatory.Framework.NotificationArgs.Sender">
+            <summary>
+            The plugin sending this notification.
+            </summary>
+        </member>
+        <member name="F:Observatory.Framework.NotificationArgs.ExtendedDetails">
+            <summary>
+            Additional notification detailed (generally not rendered by voice or popup; potentially used by aggregating/logging plugins).
+            </summary>
+        </member>
+        <member name="F:Observatory.Framework.NotificationArgs.CoalescingId">
+            <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>
+        </member>
         <member name="T:Observatory.Framework.NotificationSuppression">
             <summary>
             Defines constants for suppression of title or detail announcement in a notification.