From ba1feaa55d7e6b67eaa078a925f7942883b46eaa Mon Sep 17 00:00:00 2001 From: Tobias Klika Date: Mon, 13 Jan 2014 23:04:27 +0100 Subject: [PATCH] update inline docs --- UptimeSharp/Components/Alert.cs | 8 ++++++-- UptimeSharp/Components/Monitor.cs | 6 ++++++ 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/UptimeSharp/Components/Alert.cs b/UptimeSharp/Components/Alert.cs index 8ddd4f8..19fed43 100644 --- a/UptimeSharp/Components/Alert.cs +++ b/UptimeSharp/Components/Alert.cs @@ -16,6 +16,7 @@ namespace UptimeSharp /// Retrieve specified alert contacts by supplying IDs for them. /// The cancellation token. /// + /// public async Task> GetAlerts(string[] alertIDs = null, CancellationToken cancellationToken = default(CancellationToken)) { AlertResponse response = await Request("getAlertContacts", cancellationToken, new Dictionary() @@ -33,6 +34,7 @@ namespace UptimeSharp /// The alertID. /// The cancellation token. /// + /// public async Task GetAlert(string alertID, CancellationToken cancellationToken = default(CancellationToken)) { List alerts = await GetAlerts(new string[] { alertID }, cancellationToken); @@ -49,7 +51,7 @@ namespace UptimeSharp /// The value. /// The cancellation token. /// - /// AlertType.SMS and AlertType.Twitter are not supported by the UptimeRobot API + /// public async Task AddAlert(AlertType type, string value, CancellationToken cancellationToken = default(CancellationToken)) { if (type == AlertType.SMS || type == AlertType.Twitter) @@ -74,6 +76,7 @@ namespace UptimeSharp /// The alert. /// The cancellation token. /// + /// public async Task AddAlert(Alert alert, CancellationToken cancellationToken = default(CancellationToken)) { return await AddAlert(alert.Type, alert.Value, cancellationToken); @@ -86,7 +89,7 @@ namespace UptimeSharp /// The alert ID. /// The cancellation token. /// - /// Can't delete main alert + /// public async Task DeleteAlert(string alertID, CancellationToken cancellationToken = default(CancellationToken)) { if (alertID.StartsWith("0")) @@ -109,6 +112,7 @@ namespace UptimeSharp /// The alert. /// The cancellation token. /// + /// public async Task DeleteAlert(Alert alert, CancellationToken cancellationToken = default(CancellationToken)) { return await DeleteAlert(alert.ID, cancellationToken); diff --git a/UptimeSharp/Components/Monitor.cs b/UptimeSharp/Components/Monitor.cs index a71f41a..5499445 100644 --- a/UptimeSharp/Components/Monitor.cs +++ b/UptimeSharp/Components/Monitor.cs @@ -23,6 +23,7 @@ namespace UptimeSharp /// /// Monitor List /// + /// public async Task> GetMonitors( int[] monitorIDs = null, float[] customUptimeRatio = null, @@ -55,6 +56,7 @@ namespace UptimeSharp /// /// The Monitor /// + /// public async Task GetMonitor( int monitorId, float[] customUptimeRatio = null, @@ -75,6 +77,7 @@ namespace UptimeSharp /// /// Success state /// + /// public async Task DeleteMonitor(int monitorId, CancellationToken cancellationToken = default(CancellationToken)) { DefaultResponse response = await Request("getMonitors", cancellationToken, new Dictionary() @@ -93,6 +96,7 @@ namespace UptimeSharp /// /// Success state /// + /// public async Task DeleteMonitor(Models.Monitor monitor, CancellationToken cancellationToken = default(CancellationToken)) { return await DeleteMonitor(monitor.ID, cancellationToken); @@ -116,6 +120,7 @@ namespace UptimeSharp /// /// Success state /// + /// public async Task AddMonitor( string name, string uri, @@ -156,6 +161,7 @@ namespace UptimeSharp /// /// Success state /// + /// public async Task ModifyMonitor(Models.Monitor monitor, CancellationToken cancellationToken = default(CancellationToken)) { List alerts = null;