StockSharp

1
namespace StockSharp.Alerts
2
{
3
	using System;
4
	using System.Threading;
5
	using System.Threading.Tasks;
6

7
	using StockSharp.Logging;
8

9
	/// <summary>
10
	/// Defines an alert notification service.
11
	/// </summary>
12
	public interface IAlertNotificationService : ILogSource
13
	{
14
		/// <summary>
15
		/// Add alert at the output.
16
		/// </summary>
17
		/// <param name="type">Alert type.</param>
18
		/// <param name="externalId">External ID.</param>
19
		/// <param name="caption">Signal header.</param>
20
		/// <param name="message">Alert text.</param>
21
		/// <param name="time">Creation time.</param>
22
		/// <param name="cancellationToken"><see cref="CancellationToken"/>.</param>
23
		/// <returns><see cref="ValueTask"/>.</returns>
24
		ValueTask NotifyAsync(AlertNotifications type, long? externalId, string caption, string message, DateTimeOffset time, CancellationToken cancellationToken);
25
	}
26

27
	/// <summary>
28
	/// Desktop popup notification service.
29
	/// </summary>
30
	public interface IDesktopPopupService : ILogSource
31
	{
32
		/// <summary>
33
		/// Show desktop popup.
34
		/// </summary>
35
		/// <param name="caption">Signal header.</param>
36
		/// <param name="message">Alert text.</param>
37
		/// <param name="iconKey">Icon to show with notification.</param>
38
		/// <param name="cancellationToken"><see cref="CancellationToken"/>.</param>
39
		/// <returns><see cref="ValueTask"/>Task result is true if user has clicked the notification.</returns>
40
		ValueTask<bool> NotifyAsync(string caption, string message, string iconKey, CancellationToken cancellationToken);
41
	}
42
}
43