Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@kuon
kuon committed Feb 12, 2020
1 parent 62d735c commit 03a4145
Show file tree
Hide file tree
Showing 137 changed files with 1,149 additions and 888 deletions.
8 changes: 7 additions & 1 deletion docs/alltypes/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>alltypes - java-phoenix-channel</title>
<title>alltypes - phoenix-channel</title>
<link rel="stylesheet" href="../style.css">
</HEAD>
<BODY>
Expand All @@ -10,16 +10,22 @@ <h3>All Types</h3>
<tbody>
<tr>
<h5><a href="../ch.kuon.phoenix/-channel/index.html">ch.kuon.phoenix.Channel</a></h5>
<p>Phoenix channel client</p>
</tr>
<tr>
<h5><a href="../ch.kuon.phoenix/-ex-timer/index.html">ch.kuon.phoenix.ExTimer</a></h5>
<p>Exponential backoff timer</p>
</tr>
<tr>
<h5><a href="../ch.kuon.phoenix/-library-test/index.html">ch.kuon.phoenix.LibraryTest</a></h5>
</tr>
<tr>
<h5><a href="../ch.kuon.phoenix/-presence/index.html">ch.kuon.phoenix.Presence</a></h5>
<p>Listen for presence changes</p>
</tr>
<tr>
<h5><a href="../ch.kuon.phoenix/-socket/index.html">ch.kuon.phoenix.Socket</a></h5>
<p>Socket main constructor.</p>
</tr>
</tbody>
</table>
Expand Down
4 changes: 2 additions & 2 deletions docs/ch.kuon.phoenix/-channel/-event/-c-l-o-s-e.html
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>Channel.Event.CLOSE - java-phoenix-channel</title>
<title>Channel.Event.CLOSE - phoenix-channel</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../../index.html">java-phoenix-channel</a>&nbsp;/&nbsp;<a href="../../index.html">ch.kuon.phoenix</a>&nbsp;/&nbsp;<a href="../index.html">Channel</a>&nbsp;/&nbsp;<a href="index.html">Event</a>&nbsp;/&nbsp;<a href="./-c-l-o-s-e.html">CLOSE</a><br/>
<a href="../../../index.html">phoenix-channel</a>&nbsp;/&nbsp;<a href="../../index.html">ch.kuon.phoenix</a>&nbsp;/&nbsp;<a href="../index.html">Channel</a>&nbsp;/&nbsp;<a href="index.html">Event</a>&nbsp;/&nbsp;<a href="./-c-l-o-s-e.html">CLOSE</a><br/>
<br/>
<h1>CLOSE</h1>
<a name="ch.kuon.phoenix.Channel.Event.CLOSE"></a>
Expand Down
4 changes: 2 additions & 2 deletions docs/ch.kuon.phoenix/-channel/-event/-e-r-r-o-r.html
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>Channel.Event.ERROR - java-phoenix-channel</title>
<title>Channel.Event.ERROR - phoenix-channel</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../../index.html">java-phoenix-channel</a>&nbsp;/&nbsp;<a href="../../index.html">ch.kuon.phoenix</a>&nbsp;/&nbsp;<a href="../index.html">Channel</a>&nbsp;/&nbsp;<a href="index.html">Event</a>&nbsp;/&nbsp;<a href="./-e-r-r-o-r.html">ERROR</a><br/>
<a href="../../../index.html">phoenix-channel</a>&nbsp;/&nbsp;<a href="../../index.html">ch.kuon.phoenix</a>&nbsp;/&nbsp;<a href="../index.html">Channel</a>&nbsp;/&nbsp;<a href="index.html">Event</a>&nbsp;/&nbsp;<a href="./-e-r-r-o-r.html">ERROR</a><br/>
<br/>
<h1>ERROR</h1>
<a name="ch.kuon.phoenix.Channel.Event.ERROR"></a>
Expand Down
4 changes: 2 additions & 2 deletions docs/ch.kuon.phoenix/-channel/-event/-j-o-i-n.html
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>Channel.Event.JOIN - java-phoenix-channel</title>
<title>Channel.Event.JOIN - phoenix-channel</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../../index.html">java-phoenix-channel</a>&nbsp;/&nbsp;<a href="../../index.html">ch.kuon.phoenix</a>&nbsp;/&nbsp;<a href="../index.html">Channel</a>&nbsp;/&nbsp;<a href="index.html">Event</a>&nbsp;/&nbsp;<a href="./-j-o-i-n.html">JOIN</a><br/>
<a href="../../../index.html">phoenix-channel</a>&nbsp;/&nbsp;<a href="../../index.html">ch.kuon.phoenix</a>&nbsp;/&nbsp;<a href="../index.html">Channel</a>&nbsp;/&nbsp;<a href="index.html">Event</a>&nbsp;/&nbsp;<a href="./-j-o-i-n.html">JOIN</a><br/>
<br/>
<h1>JOIN</h1>
<a name="ch.kuon.phoenix.Channel.Event.JOIN"></a>
Expand Down
4 changes: 2 additions & 2 deletions docs/ch.kuon.phoenix/-channel/-event/-l-e-a-v-e.html
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>Channel.Event.LEAVE - java-phoenix-channel</title>
<title>Channel.Event.LEAVE - phoenix-channel</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../../index.html">java-phoenix-channel</a>&nbsp;/&nbsp;<a href="../../index.html">ch.kuon.phoenix</a>&nbsp;/&nbsp;<a href="../index.html">Channel</a>&nbsp;/&nbsp;<a href="index.html">Event</a>&nbsp;/&nbsp;<a href="./-l-e-a-v-e.html">LEAVE</a><br/>
<a href="../../../index.html">phoenix-channel</a>&nbsp;/&nbsp;<a href="../../index.html">ch.kuon.phoenix</a>&nbsp;/&nbsp;<a href="../index.html">Channel</a>&nbsp;/&nbsp;<a href="index.html">Event</a>&nbsp;/&nbsp;<a href="./-l-e-a-v-e.html">LEAVE</a><br/>
<br/>
<h1>LEAVE</h1>
<a name="ch.kuon.phoenix.Channel.Event.LEAVE"></a>
Expand Down
4 changes: 2 additions & 2 deletions docs/ch.kuon.phoenix/-channel/-event/-r-e-p-l-y.html
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>Channel.Event.REPLY - java-phoenix-channel</title>
<title>Channel.Event.REPLY - phoenix-channel</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../../index.html">java-phoenix-channel</a>&nbsp;/&nbsp;<a href="../../index.html">ch.kuon.phoenix</a>&nbsp;/&nbsp;<a href="../index.html">Channel</a>&nbsp;/&nbsp;<a href="index.html">Event</a>&nbsp;/&nbsp;<a href="./-r-e-p-l-y.html">REPLY</a><br/>
<a href="../../../index.html">phoenix-channel</a>&nbsp;/&nbsp;<a href="../../index.html">ch.kuon.phoenix</a>&nbsp;/&nbsp;<a href="../index.html">Channel</a>&nbsp;/&nbsp;<a href="index.html">Event</a>&nbsp;/&nbsp;<a href="./-r-e-p-l-y.html">REPLY</a><br/>
<br/>
<h1>REPLY</h1>
<a name="ch.kuon.phoenix.Channel.Event.REPLY"></a>
Expand Down
4 changes: 2 additions & 2 deletions docs/ch.kuon.phoenix/-channel/-event/event.html
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>Channel.Event.event - java-phoenix-channel</title>
<title>Channel.Event.event - phoenix-channel</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../../index.html">java-phoenix-channel</a>&nbsp;/&nbsp;<a href="../../index.html">ch.kuon.phoenix</a>&nbsp;/&nbsp;<a href="../index.html">Channel</a>&nbsp;/&nbsp;<a href="index.html">Event</a>&nbsp;/&nbsp;<a href="./event.html">event</a><br/>
<a href="../../../index.html">phoenix-channel</a>&nbsp;/&nbsp;<a href="../../index.html">ch.kuon.phoenix</a>&nbsp;/&nbsp;<a href="../index.html">Channel</a>&nbsp;/&nbsp;<a href="index.html">Event</a>&nbsp;/&nbsp;<a href="./event.html">event</a><br/>
<br/>
<h1>event</h1>
<a name="ch.kuon.phoenix.Channel.Event$event"></a>
Expand Down
5 changes: 3 additions & 2 deletions docs/ch.kuon.phoenix/-channel/-event/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>Channel.Event - java-phoenix-channel</title>
<title>Channel.Event - phoenix-channel</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../../index.html">java-phoenix-channel</a>&nbsp;/&nbsp;<a href="../../index.html">ch.kuon.phoenix</a>&nbsp;/&nbsp;<a href="../index.html">Channel</a>&nbsp;/&nbsp;<a href="./index.html">Event</a><br/>
<a href="../../../index.html">phoenix-channel</a>&nbsp;/&nbsp;<a href="../../index.html">ch.kuon.phoenix</a>&nbsp;/&nbsp;<a href="../index.html">Channel</a>&nbsp;/&nbsp;<a href="./index.html">Event</a><br/>
<br/>
<h1>Event</h1>
<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">Event</span></code>
<p>Channel built in events</p>
<h3>Enum Values</h3>
<table>
<tbody>
Expand Down
14 changes: 0 additions & 14 deletions docs/ch.kuon.phoenix/-channel/-init-.html
View file

This file was deleted.

4 changes: 2 additions & 2 deletions docs/ch.kuon.phoenix/-channel/-life-cycle-events.html
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>Channel.LifeCycleEvents - java-phoenix-channel</title>
<title>Channel.LifeCycleEvents - phoenix-channel</title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">java-phoenix-channel</a>&nbsp;/&nbsp;<a href="../index.html">ch.kuon.phoenix</a>&nbsp;/&nbsp;<a href="index.html">Channel</a>&nbsp;/&nbsp;<a href="./-life-cycle-events.html">LifeCycleEvents</a><br/>
<a href="../../index.html">phoenix-channel</a>&nbsp;/&nbsp;<a href="../index.html">ch.kuon.phoenix</a>&nbsp;/&nbsp;<a href="index.html">Channel</a>&nbsp;/&nbsp;<a href="./-life-cycle-events.html">LifeCycleEvents</a><br/>
<br/>
<h1>LifeCycleEvents</h1>
<a name="ch.kuon.phoenix.Channel.Companion$LifeCycleEvents"></a>
Expand Down
7 changes: 5 additions & 2 deletions docs/ch.kuon.phoenix/-channel/-message/-init-.html
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>Channel.Message.<init> - java-phoenix-channel</title>
<title>Channel.Message.<init> - phoenix-channel</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../../index.html">java-phoenix-channel</a>&nbsp;/&nbsp;<a href="../../index.html">ch.kuon.phoenix</a>&nbsp;/&nbsp;<a href="../index.html">Channel</a>&nbsp;/&nbsp;<a href="index.html">Message</a>&nbsp;/&nbsp;<a href="./-init-.html">&lt;init&gt;</a><br/>
<a href="../../../index.html">phoenix-channel</a>&nbsp;/&nbsp;<a href="../../index.html">ch.kuon.phoenix</a>&nbsp;/&nbsp;<a href="../index.html">Channel</a>&nbsp;/&nbsp;<a href="index.html">Message</a>&nbsp;/&nbsp;<a href="./-init-.html">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</h1>
<a name="ch.kuon.phoenix.Channel.Message$&lt;init&gt;()"></a>
<code><span class="identifier">Message</span><span class="symbol">(</span><span class="symbol">)</span></code>
<p>Channel messages</p>
<p>Usually this class should not be created directly. It is
used as a wrapper around response in <a href="../on.html">Channel.on</a> callback.</p>
</BODY>
</HTML>
16 changes: 0 additions & 16 deletions docs/ch.kuon.phoenix/-channel/-message/build.html
View file

This file was deleted.

14 changes: 0 additions & 14 deletions docs/ch.kuon.phoenix/-channel/-message/error.html
View file

This file was deleted.

7 changes: 5 additions & 2 deletions docs/ch.kuon.phoenix/-channel/-message/get-error.html
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>Channel.Message.getError - java-phoenix-channel</title>
<title>Channel.Message.getError - phoenix-channel</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../../index.html">java-phoenix-channel</a>&nbsp;/&nbsp;<a href="../../index.html">ch.kuon.phoenix</a>&nbsp;/&nbsp;<a href="../index.html">Channel</a>&nbsp;/&nbsp;<a href="index.html">Message</a>&nbsp;/&nbsp;<a href="./get-error.html">getError</a><br/>
<a href="../../../index.html">phoenix-channel</a>&nbsp;/&nbsp;<a href="../../index.html">ch.kuon.phoenix</a>&nbsp;/&nbsp;<a href="../index.html">Channel</a>&nbsp;/&nbsp;<a href="index.html">Message</a>&nbsp;/&nbsp;<a href="./get-error.html">getError</a><br/>
<br/>
<h1>getError</h1>
<a name="ch.kuon.phoenix.Channel.Message$getError()"></a>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getError</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code>
<p>Returns the error reason.</p>
<p>If this message is not an error, this will throw an exception
so be sure to check <a href="is-error.html">Message.isError</a> first.</p>
</BODY>
</HTML>
46 changes: 10 additions & 36 deletions docs/ch.kuon.phoenix/-channel/-message/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>Channel.Message - java-phoenix-channel</title>
<title>Channel.Message - phoenix-channel</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../../index.html">java-phoenix-channel</a>&nbsp;/&nbsp;<a href="../../index.html">ch.kuon.phoenix</a>&nbsp;/&nbsp;<a href="../index.html">Channel</a>&nbsp;/&nbsp;<a href="./index.html">Message</a><br/>
<a href="../../../index.html">phoenix-channel</a>&nbsp;/&nbsp;<a href="../../index.html">ch.kuon.phoenix</a>&nbsp;/&nbsp;<a href="../index.html">Channel</a>&nbsp;/&nbsp;<a href="./index.html">Message</a><br/>
<br/>
<h1>Message</h1>
<code><span class="keyword">abstract</span> <span class="keyword">class </span><span class="identifier">Message</span></code>
<p>Channel messages</p>
<p>Usually this class should not be created directly. It is
used as a wrapper around response in <a href="../on.html">Channel.on</a> callback.</p>
<h3>Constructors</h3>
<table>
<tbody>
Expand All @@ -17,6 +20,7 @@ <h3>Constructors</h3>
<h4><a href="-init-.html">&lt;init&gt;</a></h4>
</td>
<td>
<p>Channel messages</p>
<code><span class="identifier">Message</span><span class="symbol">(</span><span class="symbol">)</span></code></td>
</tr>
</tbody>
Expand All @@ -29,13 +33,15 @@ <h3>Properties</h3>
<h4><a href="response.html">response</a></h4>
</td>
<td>
<p>Response data from the server</p>
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">response</span><span class="symbol">: </span><span class="identifier">JSONObject</span></code></td>
</tr>
<tr>
<td>
<h4><a href="status.html">status</a></h4>
</td>
<td>
<p>Status of the response as sent by the server.</p>
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">status</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code></td>
</tr>
</tbody>
Expand All @@ -48,50 +54,18 @@ <h3>Functions</h3>
<h4><a href="get-error.html">getError</a></h4>
</td>
<td>
<p>Returns the error reason.</p>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getError</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code></td>
</tr>
<tr>
<td>
<h4><a href="is-error.html">isError</a></h4>
</td>
<td>
<p>Returns the error state of the message</p>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">isError</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a></code></td>
</tr>
</tbody>
</table>
<h3>Companion Object Functions</h3>
<table>
<tbody>
<tr>
<td>
<h4><a href="build.html">build</a></h4>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">build</span><span class="symbol">(</span><span class="identifier" id="ch.kuon.phoenix.Channel.Message.Companion$build(kotlin.String, org.json.JSONObject)/status">status</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="ch.kuon.phoenix.Channel.Message.Companion$build(kotlin.String, org.json.JSONObject)/response">response</span><span class="symbol">:</span>&nbsp;<span class="identifier">JSONObject</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Message</span></code><br/>
<code><span class="keyword">fun </span><span class="identifier">build</span><span class="symbol">(</span><span class="identifier" id="ch.kuon.phoenix.Channel.Message.Companion$build(org.json.JSONObject)/payload">payload</span><span class="symbol">:</span>&nbsp;<span class="identifier">JSONObject</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Message</span></code></td>
</tr>
<tr>
<td>
<h4><a href="error.html">error</a></h4>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">error</span><span class="symbol">(</span><span class="identifier" id="ch.kuon.phoenix.Channel.Message.Companion$error(kotlin.String)/error">error</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Message</span></code></td>
</tr>
<tr>
<td>
<h4><a href="leave.html">leave</a></h4>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">leave</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Message</span></code></td>
</tr>
<tr>
<td>
<h4><a href="none.html">none</a></h4>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">none</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Message</span></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>
Loading

0 comments on commit 03a4145

Please sign in to comment.