IoTGateway/Output/Waher.Output/IOutputNode.cs at master · PeterWaher/IoTGateway · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
using System.Threading.Tasks;
using Waher.Things;
using Waher.Things.DisplayableParameters;

namespace Waher.Output
{
	/// <summary>
	/// Base Interface for all output nodes.
	/// </summary>
	public interface IOutputNode : INode
	{
		/// <summary>
		/// ID of node.
		/// </summary>
		new string NodeId { get; set; }

		/// <summary>
		/// Gets the parent of the node.
		/// </summary>
		/// <returns>Parent instance.</returns>
		/// <exception cref="System.Exception">If parent is not found.</exception>
		Task<INode> GetParent();

		/// <summary>
		/// Logs an error message on the node.
		/// </summary>
		/// <param name="Body">Message body.</param>
		Task LogErrorAsync(string Body);

		/// <summary>
		/// Logs an error message on the node.
		/// </summary>
		/// <param name="EventId">Optional Event ID.</param>
		/// <param name="Body">Message body.</param>
		Task LogErrorAsync(string EventId, string Body);

		/// <summary>
		/// Logs an warning message on the node.
		/// </summary>
		/// <param name="Body">Message body.</param>
		Task LogWarningAsync(string Body);

		/// <summary>
		/// Logs an warning message on the node.
		/// </summary>
		/// <param name="EventId">Optional Event ID.</param>
		/// <param name="Body">Message body.</param>
		Task LogWarningAsync(string EventId, string Body);

		/// <summary>
		/// Logs an informational message on the node.
		/// </summary>
		/// <param name="Body">Message body.</param>
		Task LogInformationAsync(string Body);

		/// <summary>
		/// Logs an informational message on the node.
		/// </summary>
		/// <param name="EventId">Optional Event ID.</param>
		/// <param name="Body">Message body.</param>
		Task LogInformationAsync(string EventId, string Body);

		/// <summary>
		/// Logs a message on the node.
		/// </summary>
		/// <param name="Type">Type of message.</param>
		/// <param name="Body">Message body.</param>
		Task LogMessageAsync(MessageType Type, string Body);

		/// <summary>
		/// Logs a message on the node.
		/// </summary>
		/// <param name="Type">Type of message.</param>
		/// <param name="EventId">Optional Event ID.</param>
		/// <param name="Body">Message body.</param>
		Task LogMessageAsync(MessageType Type, string EventId, string Body);

		/// <summary>
		/// Removes error messages with an empty event ID from the node.
		/// </summary>
		Task<bool> RemoveErrorAsync();

		/// <summary>
		/// Removes error messages with a given event ID from the node.
		/// </summary>
		/// <param name="EventId">Optional Event ID.</param>
		Task<bool> RemoveErrorAsync(string EventId);

		/// <summary>
		/// Removes warning messages with an empty event ID from the node.
		/// </summary>
		Task<bool> RemoveWarningAsync();

		/// <summary>
		/// Removes warning messages with a given event ID from the node.
		/// </summary>
		/// <param name="EventId">Optional Event ID.</param>
		Task<bool> RemoveWarningAsync(string EventId);

		/// <summary>
		/// Removes warning messages with an empty event ID from the node.
		/// </summary>
		Task<bool> RemoveInformationAsync();

		/// <summary>
		/// Removes an informational message on the node.
		/// </summary>
		/// <param name="EventId">Optional Event ID.</param>
		Task<bool> RemoveInformationAsync(string EventId);

		/// <summary>
		/// Removes messages with empty event IDs from the node.
		/// </summary>
		/// <param name="Type">Type of message.</param>
		Task<bool> RemoveMessageAsync(MessageType Type);

		/// <summary>
		/// Logs a message on the node.
		/// </summary>
		/// <param name="Type">Type of message.</param>
		/// <param name="EventId">Optional Event ID.</param>
		Task<bool> RemoveMessageAsync(MessageType Type, string EventId);
	}
}