mirror of
https://github.com/9ParsonsB/Pulsar.git
synced 2025-04-05 17:39:39 -04:00
701f6f0b1c
Plugins authors can now optionally specify what ways their notifications are rendered (subject, of course, to user preferences/settings). The default is to render notifications in all available channels. Examples: - Show native pop-up window only (ie. no voice/plugin notifiers) - Disallow other plugin notifiers This does not support selection of notifier plugins. Furthermore, persistent notification updates were not previously being forwarded to anything but the native popup notifier. Now plugins and native voice are also supported (subject to user preferences) and respect the new rendering controls added here. There is currently no concept of closing notifications for the native voice or plugin-based notifiers.
73 lines
3.0 KiB
C#
73 lines
3.0 KiB
C#
using System;
|
|
|
|
namespace Observatory.Framework
|
|
{
|
|
/// <summary>
|
|
/// Provides data for Elite Dangerous journal events.
|
|
/// </summary>
|
|
public class JournalEventArgs : EventArgs
|
|
{
|
|
/// <summary>
|
|
/// <para>Type of journal entry that triggered event.</para>
|
|
/// <para>Will be a class from the Observatory.Framework.Files.Journal namespace derived from JournalBase, or JournalBase itself in the case of an unhandled journal event type.</para>
|
|
/// </summary>
|
|
public Type journalType;
|
|
/// <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<string, object> AdditionalProperties.</para>
|
|
/// </summary>
|
|
public object 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.
|
|
/// </summary>
|
|
public NotificationRendering Rendering = NotificationRendering.All;
|
|
}
|
|
|
|
[Flags]
|
|
public enum NotificationRendering
|
|
{
|
|
// These need to be multiples of 2 as they're used via masking.
|
|
NativeVisual = 1,
|
|
NativeVocal = 2,
|
|
PluginNotifier = 4,
|
|
All = (NativeVisual | NativeVocal | PluginNotifier)
|
|
}
|
|
}
|