bump version and update docs

This commit is contained in:
2013-08-28 00:59:10 +02:00
parent c00dd42d08
commit 60a4d6cdc7
4 changed files with 21 additions and 19 deletions
+4 -3
View File
@@ -190,13 +190,13 @@ List<Alert> items = _client.GetAlerts();
Retrieve alerts by IDs:
```csharp
List<Alert> items = _client.GetAlerts(new int[]{ 12897, 98711 });
List<Alert> items = _client.GetAlerts(new string[]{ "12897", "98711" });
```
Retrieve a specific alert:
```csharp
Alert item = _client.GetAlert(12897);
Alert item = _client.GetAlert("12897");
```
Adds an alert _(Due to UptimeRobot API limitations SMS and Twitter alert contact types are not supported yet)_:
@@ -215,7 +215,7 @@ bool isSuccess = _client.AddAlert(myAlert);
Deletes an alert:
```csharp
bool isSuccess = _client.DeleteAlert(12897);
bool isSuccess = _client.DeleteAlert("12897");
```
Deletes an alert from instance:
@@ -229,6 +229,7 @@ bool isSuccess = _client.DeleteAlert(myAlert);
## Release History
- 2013-08-28 v0.2.0 Request Validation
- 2013-08-26 v0.1.1 Adding a Port monitor works now
- 2013-08-25 v0.1.0 Monitor and Alert APIs
+13 -12
View File
@@ -87,6 +87,7 @@ localhost | Ping
<h2>Release History</h2>
<ul>
<li>2013-08-28 v0.2.0 Request Validation</li>
<li>2013-08-26 v0.1.1 Adding a Port monitor works now</li>
<li>2013-08-25 v0.1.0 Monitor and Alert APIs</li>
</ul>
@@ -133,20 +134,20 @@ Monitor item = _client.GetMonitor(12891);</code></pre>
<br></p>
</div>
<div data-part="add">
<h2>Add</h2>
<p>Adds/creates a new monitor.</p>
<pre class="language-clike"><code>bool AddMonitor(
string name,
string uri,
Type type = Type.HTTP,
string name,
string uri,
Type type = Type.HTTP,
Subtype subtype = Subtype.Unknown,
int? port = null,
string keywordValue = null,
int? port = null,
string keywordValue = null,
KeywordType keywordType = KeywordType.Unknown,
int[] alerts = null,
int[] alerts = null,
string HTTPUsername = null,
string HTTPPassword = null
)</code></pre>
@@ -194,26 +195,26 @@ bool isSuccess = _client.ModifyMonitor(myMonitor);</code></pre>
<p>Retrieve all alerts:</p>
<pre class="language-clike"><code>List&lt;Alert&gt; items = _client.GetAlerts();</code></pre>
<p>Retrieve alerts by IDs:</p>
<pre class="language-clike"><code>List&lt;Alert&gt; items = _client.GetAlerts(new int[]{ 12897, 98711 });</code></pre>
<pre class="language-clike"><code>List&lt;Alert&gt; items = _client.GetAlerts(new string[]{ "12897", "98711" });</code></pre>
<p>Retrieve a specific alert:</p>
<pre class="language-clike"><code>Alert item = _client.GetAlert(12897);</code></pre>
<pre class="language-clike"><code>Alert item = _client.GetAlert("12897");</code></pre>
<p>Adds an alert <em>(Due to UptimeRobot API limitations SMS and Twitter alert contact types are not supported yet)</em>:</p>
<pre class="language-clike"><code>bool isSuccess = _client.AddAlert(AlertType.Email, &quot;uptimesharp@outlook.com&quot;);</code></pre>
<p>Adds an alert from instance:</p>
<pre class="language-clike"><code>// Alert myAlert = ...
bool isSuccess = _client.AddAlert(myAlert);</code></pre>
<p>Deletes an alert:</p>
<pre class="language-clike"><code>bool isSuccess = _client.DeleteAlert(12897);</code></pre>
<pre class="language-clike"><code>bool isSuccess = _client.DeleteAlert("12897");</code></pre>
<p>Deletes an alert from instance:</p>
<pre class="language-clike"><code>// Alert myAlert = ...
bool isSuccess = _client.DeleteAlert(myAlert);</code></pre>
</div>
<div data-part="delete">
<h2>Delete</h2>
<p>Delete a monitor by ID:</p>
<pre class="language-clike"><code>bool isSuccess = _client.DeleteMonitor(12891);</code></pre>
<pre class="language-clike"><code>bool isSuccess = _client.DeleteMonitor("12891");</code></pre>
<p>Delete a monitor by a Monitor instance:</p>
<pre class="language-clike"><code>// Monitor myMonitor = ...
bool isSuccess = _client.DeleteMonitor(myMonitor);</code></pre>
+2 -2
View File
@@ -1,6 +1,6 @@
{
"name": "wingsforlife",
"version": "0.1.0",
"name": "uptimesharp",
"version": "0.2.0",
"devDependencies": {
"grunt": "~0.4.1",
"grunt-contrib-uglify": "~0.1.2",
+2 -2
View File
@@ -2,7 +2,7 @@
<package >
<metadata>
<id>UptimeSharp</id>
<version>0.1.1</version>
<version>0.2.0</version>
<title>UptimeSharp</title>
<authors>Tobias Klika</authors>
<owners>Tobias Klika</owners>
@@ -37,4 +37,4 @@
<files>
<file src="UptimeSharp\bin\Release\UptimeSharp.dll" target="lib/net40" />
</files>
</package>
</package>