Skip to content

Commit 46ae7e3

Browse files
committed
update
1 parent bb5ec8c commit 46ae7e3

File tree

273 files changed

+75
-6
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

273 files changed

+75
-6
lines changed

develop/api/NotifyTypes/NotifyTypesOverview.md

+1-1

develop/api/index.md

+2-2

develop/toc.yml

+18-2
Original file line numberDiff line numberDiff line change
@@ -485,11 +485,27 @@
485485
topicUid: ClassLibraryMonitorsStoppingAStoppedMonitor
486486
- name: Examples
487487
topicUid: ClassLibraryExamples
488-
- name: Api documentation
488+
- name: API documentation
489489
topicUid: ApiDocumentation
490490
items:
491491
- name: Namespaces
492-
topicUid: Skyline.DataMiner.Scripting.SLProtocol
492+
items:
493+
- name: Skyline.DataMiner.Scripting
494+
topicUid: Skyline.DataMiner.Scripting
495+
- name: Skyline.DataMiner.Automation
496+
topicUid: Skyline.DataMiner.Automation
497+
- name: Skyline.DataMiner.Library.Common
498+
topicUid: Skyline.DataMiner.Library.Common
499+
- name: Skyline.DataMiner.Library.Automation
500+
topicUid: Skyline.DataMiner.Library.Automation
501+
- name: Skyline.DataMiner.Library.Protocol
502+
topicUid: Skyline.DataMiner.Library.Protocol
503+
- name: Skyline.DataMiner.Net
504+
topicUid: Skyline.DataMiner.Net
505+
- name: Interop.SLDms
506+
topicUid: Interop.SLDms
507+
- name: Tamir.SharpSsh
508+
topicUid: Tamir.SharpSsh
493509
- name: Notify types
494510
items:
495511
- name: NT notify types

src/DataMiner/SLManagedAutomation/Engine.cs

+5
Original file line numberDiff line numberDiff line change
@@ -269,6 +269,11 @@ public virtual void ClearScriptOutput(string key)
269269
/// <param name="key">The key.</param>
270270
/// <returns>The created dummy.</returns>
271271
/// <exception cref="DataMinerException">The specified element was not found.</exception>
272+
/// <example>
273+
/// <code>
274+
/// ScriptDummy extradummy1 = engine.CreateExtraDummy(366,22, "myDummy");
275+
/// </code>
276+
/// </example>
272277
public ScriptDummy CreateExtraDummy(int dataMinerID, int elementID, string key) { return null; }
273278

274279
/// <summary>

src/DataMiner/SLManagedAutomation/IEngine.cs

+5
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,11 @@ public interface IEngine
107107
/// <param name="key">The key.</param>
108108
/// <returns>The created dummy.</returns>
109109
/// <exception cref="DataMinerException">The specified element was not found.</exception>
110+
/// <example>
111+
/// <code>
112+
/// ScriptDummy extradummy1 = engine.CreateExtraDummy(366,22, "myDummy");
113+
/// </code>
114+
/// </example>
110115
ScriptDummy CreateExtraDummy(int dataMinerID, int elementID, string key);
111116

112117
/// <summary>

src/DataMiner/SLManagedAutomation/MailReportOptions.cs

+44-1
Original file line numberDiff line numberDiff line change
@@ -90,13 +90,30 @@ public void IncludeFilteredView(string viewName, string protocolName, string pro
9090
/// </exception>
9191
public void IncludeFilteredView(string viewName, string protocolName, string protocolVersion, params string[] @params) { }
9292

93-
93+
/// <summary>
94+
/// Adds the specified reservation GUID.
95+
/// </summary>
96+
/// <param name="reservationGuid">The reservation GUID.</param>
97+
/// <example>
98+
/// <code>
99+
/// MailReportOptions reportOptions = engine.PrepareMailReport("myTemplate");
100+
///
101+
/// reportOptions.IncludeReservationGuid(new Guid("{12776948-CF8E-4A5D-AC2B-A9D1AB0D8A68}"));
102+
/// </code>
103+
/// </example>
94104
public void IncludeReservationGuid(ValueType reservationGuid) { }
95105

96106
/// <summary>
97107
/// Adds a view to be included in the report.
98108
/// </summary>
99109
/// <param name="viewName">The name of the view.</param>
110+
/// <example>
111+
/// <code>
112+
/// MailReportOptions reportOptions = engine.PrepareMailReport("myTemplate");
113+
///
114+
/// reportOptions.IncludeView("myView");
115+
/// </code>
116+
/// </example>
100117
public void IncludeView(string viewName) { }
101118

102119
/// <summary>
@@ -110,6 +127,22 @@ public void IncludeView(string viewName, params MailReportParameter[] @params) {
110127
/// Sets the mail options.
111128
/// </summary>
112129
/// <param name="mailOptions">The mail options.</param>
130+
/// <example>
131+
/// <code>
132+
/// MailReportOptions reportOptions = engine.PrepareMailReport("myTemplate");
133+
///
134+
/// string title = "Load Overview";
135+
/// string message = "Information about last day's load";
136+
///
137+
/// EmailOptions emailOptions = new EmailOptions();
138+
/// emailOptions.Title = title;
139+
/// emailOptions.Message = message;
140+
/// emailOptions.TO = "user.demuynck@domain.com";
141+
/// emailOptions.SendAsPlainText = true;
142+
///
143+
/// reportOptions.SetMailOptions(emailOptions);
144+
/// </code>
145+
/// </example>
113146
public void SetMailOptions(EmailOptions mailOptions) { }
114147

115148
/// <summary>
@@ -118,6 +151,16 @@ public void SetMailOptions(EmailOptions mailOptions) { }
118151
/// <param name="message">The message.</param>
119152
/// <param name="title">The title.</param>
120153
/// <param name="to">The recipients.</param>
154+
/// <example>
155+
/// <code>
156+
/// MailReportOptions reportOptions = engine.PrepareMailReport("myTemplate");
157+
///
158+
/// string title = "Load Overview";
159+
/// string message = "Information about last day's load";
160+
/// string to = "user@domain.com";
161+
/// reportOptions.SetMailOptions(message, title, to);
162+
/// </code>
163+
/// </example>
121164
public void SetMailOptions(string message, string title, string to) { }
122165
}
123166
}

0 commit comments

Comments
 (0)