stoatchat/javascript-client-sdk
1
0
Fork 0
mirror of https://github.com/stoatchat/javascript-client-sdk.git synced 2026-07-21 04:25:27 -04:00
Code Issues 9 Packages Projects Releases 6 Wiki Activity
Files
3edcc2c96d95348fc8a6ecefe7159f1e48a4fda1
javascript-client-sdk/classes/websocket_client.WebSocketClient.html
T

426 lines
20 KiB
HTML
Raw Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>WebSocketClient | revolt.js</title>
<meta name="description" content="Documentation for revolt.js">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">revolt.js</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">revolt.js</a>
</li>
<li>
<a href="../modules/websocket_client.html">websocket/client</a>
</li>
<li>
<a href="websocket_client.WebSocketClient.html">WebSocketClient</a>
</li>
</ul>
<h1>Class WebSocketClient</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">WebSocketClient</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="websocket_client.WebSocketClient.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="websocket_client.WebSocketClient.html#client" class="tsd-kind-icon">client</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="websocket_client.WebSocketClient.html#connected" class="tsd-kind-icon">connected</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="websocket_client.WebSocketClient.html#heartbeat" class="tsd-kind-icon">heartbeat</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="websocket_client.WebSocketClient.html#ping" class="tsd-kind-icon">ping</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="websocket_client.WebSocketClient.html#ready" class="tsd-kind-icon">ready</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="websocket_client.WebSocketClient.html#ws" class="tsd-kind-icon">ws</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="websocket_client.WebSocketClient.html#connect" class="tsd-kind-icon">connect</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="websocket_client.WebSocketClient.html#disconnect" class="tsd-kind-icon">disconnect</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="websocket_client.WebSocketClient.html#send" class="tsd-kind-icon">send</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Web<wbr>Socket<wbr>Client<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><a href="Client.Client-1.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="websocket_client.WebSocketClient.html" class="tsd-signature-type" data-tsd-kind="Class">WebSocketClient</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/a146fa4/src/websocket/client.ts#L23">src/websocket/client.ts:23</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>client: <a href="Client.Client-1.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="websocket_client.WebSocketClient.html" class="tsd-signature-type" data-tsd-kind="Class">WebSocketClient</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="client" class="tsd-anchor"></a>
<h3>client</h3>
<div class="tsd-signature tsd-kind-icon">client<span class="tsd-signature-symbol">:</span> <a href="Client.Client-1.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/a146fa4/src/websocket/client.ts#L14">src/websocket/client.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="connected" class="tsd-anchor"></a>
<h3>connected</h3>
<div class="tsd-signature tsd-kind-icon">connected<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/a146fa4/src/websocket/client.ts#L18">src/websocket/client.ts:18</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="heartbeat" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> heartbeat</h3>
<div class="tsd-signature tsd-kind-icon">heartbeat<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/a146fa4/src/websocket/client.ts#L17">src/websocket/client.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="ping" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ping</h3>
<div class="tsd-signature tsd-kind-icon">ping<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/a146fa4/src/websocket/client.ts#L21">src/websocket/client.ts:21</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="ready" class="tsd-anchor"></a>
<h3>ready</h3>
<div class="tsd-signature tsd-kind-icon">ready<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/a146fa4/src/websocket/client.ts#L19">src/websocket/client.ts:19</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="ws" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ws</h3>
<div class="tsd-signature tsd-kind-icon">ws<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">WebSocket</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/a146fa4/src/websocket/client.ts#L15">src/websocket/client.ts:15</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="connect" class="tsd-anchor"></a>
<h3>connect</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">connect<span class="tsd-signature-symbol">(</span>disallowReconnect<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/a146fa4/src/websocket/client.ts#L66">src/websocket/client.ts:66</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Connect the WebSocket</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> disallowReconnect: <span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<p>Whether to disallow reconnection</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="disconnect" class="tsd-anchor"></a>
<h3>disconnect</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">disconnect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/a146fa4/src/websocket/client.ts#L33">src/websocket/client.ts:33</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Disconnect the WebSocket and disable heartbeats.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="send" class="tsd-anchor"></a>
<h3>send</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">send<span class="tsd-signature-symbol">(</span>notification<span class="tsd-signature-symbol">: </span><a href="../modules/websocket_notifications.html#ServerboundNotification" class="tsd-signature-type" data-tsd-kind="Type alias">ServerboundNotification</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/a146fa4/src/websocket/client.ts#L50">src/websocket/client.ts:50</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Send a notification</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>notification: <a href="../modules/websocket_notifications.html#ServerboundNotification" class="tsd-signature-type" data-tsd-kind="Type alias">ServerboundNotification</a></h5>
<div class="tsd-comment tsd-typography">
<p>Serverbound notification</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/Client.html">Client</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/config.html">config</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/globals.html">globals</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/index.html">index</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/maps_Bots.html">maps/<wbr>Bots</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/maps_Channels.html">maps/<wbr>Channels</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/maps_Collection.html">maps/<wbr>Collection</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/maps_Emojis.html">maps/<wbr>Emojis</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/maps_Members.html">maps/<wbr>Members</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/maps_Messages.html">maps/<wbr>Messages</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/maps_Servers.html">maps/<wbr>Servers</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/maps_Users.html">maps/<wbr>Users</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/permissions_calculator.html">permissions/calculator</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/permissions_definitions.html">permissions/definitions</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/util_Unreads.html">util/<wbr>Unreads</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/util_null.html">util/null</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/websocket_client.html">websocket/client</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/websocket_notifications.html">websocket/notifications</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-module">
<a href="websocket_client.WebSocketClient.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Client</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="websocket_client.WebSocketClient.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="websocket_client.WebSocketClient.html#client" class="tsd-kind-icon">client</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="websocket_client.WebSocketClient.html#connected" class="tsd-kind-icon">connected</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="websocket_client.WebSocketClient.html#heartbeat" class="tsd-kind-icon">heartbeat</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="websocket_client.WebSocketClient.html#ping" class="tsd-kind-icon">ping</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="websocket_client.WebSocketClient.html#ready" class="tsd-kind-icon">ready</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="websocket_client.WebSocketClient.html#ws" class="tsd-kind-icon">ws</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="websocket_client.WebSocketClient.html#connect" class="tsd-kind-icon">connect</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="websocket_client.WebSocketClient.html#disconnect" class="tsd-kind-icon">disconnect</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="websocket_client.WebSocketClient.html#send" class="tsd-kind-icon">send</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink