mirror of
https://github.com/stoatchat/javascript-client-sdk.git
synced 2026-07-25 08:25:23 -04:00
insertish
295 lines
15 KiB
HTML
295 lines
15 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>api/routes | 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="api_routes.html">api/routes</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Module api/routes</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<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>Type aliases</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="api_routes.html#RemoveChannelField" class="tsd-kind-icon">Remove<wbr>Channel<wbr>Field</a></li>
|
|
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="api_routes.html#RemoveMemberField" class="tsd-kind-icon">Remove<wbr>Member<wbr>Field</a></li>
|
|
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="api_routes.html#RemoveRoleField" class="tsd-kind-icon">Remove<wbr>Role<wbr>Field</a></li>
|
|
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="api_routes.html#RemoveServerField" class="tsd-kind-icon">Remove<wbr>Server<wbr>Field</a></li>
|
|
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="api_routes.html#RemoveUserField" class="tsd-kind-icon">Remove<wbr>User<wbr>Field</a></li>
|
|
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a href="api_routes.html#Route" class="tsd-kind-icon">Route</a></li>
|
|
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="api_routes.html#RouteMethod" class="tsd-kind-icon">Route<wbr>Method</a></li>
|
|
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="api_routes.html#RoutePath" class="tsd-kind-icon">Route<wbr>Path</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Type aliases</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a name="RemoveChannelField" class="tsd-anchor"></a>
|
|
<h3>Remove<wbr>Channel<wbr>Field</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Remove<wbr>Channel<wbr>Field<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"Icon"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Description"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/0c5f0b1/src/api/routes.ts#L11">src/api/routes.ts:11</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a name="RemoveMemberField" class="tsd-anchor"></a>
|
|
<h3>Remove<wbr>Member<wbr>Field</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Remove<wbr>Member<wbr>Field<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"Nickname"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Avatar"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/0c5f0b1/src/api/routes.ts#L13">src/api/routes.ts:13</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a name="RemoveRoleField" class="tsd-anchor"></a>
|
|
<h3>Remove<wbr>Role<wbr>Field</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Remove<wbr>Role<wbr>Field<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"Colour"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/0c5f0b1/src/api/routes.ts#L14">src/api/routes.ts:14</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a name="RemoveServerField" class="tsd-anchor"></a>
|
|
<h3>Remove<wbr>Server<wbr>Field</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Remove<wbr>Server<wbr>Field<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"Icon"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Banner"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Description"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/0c5f0b1/src/api/routes.ts#L12">src/api/routes.ts:12</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a name="RemoveUserField" class="tsd-anchor"></a>
|
|
<h3>Remove<wbr>User<wbr>Field</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Remove<wbr>User<wbr>Field<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ProfileContent"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ProfileBackground"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"StatusText"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Avatar"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/0c5f0b1/src/api/routes.ts#L10">src/api/routes.ts:10</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter">
|
|
<a name="Route" class="tsd-anchor"></a>
|
|
<h3>Route</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Route<M, T><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ExtractMethodParameters</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ExtractRouteParameters</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Routes</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">M</span><span class="tsd-signature-symbol">></span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/0c5f0b1/src/api/routes.ts#L809">src/api/routes.ts:809</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
<ul class="tsd-type-parameters">
|
|
<li>
|
|
<h4>M<span class="tsd-signature-symbol">: </span><a href="api_routes.html#RouteMethod" class="tsd-signature-type" data-tsd-kind="Type alias">RouteMethod</a></h4>
|
|
</li>
|
|
<li>
|
|
<h4>T<span class="tsd-signature-symbol">: </span><a href="api_routes.html#RoutePath" class="tsd-signature-type" data-tsd-kind="Type alias">RoutePath</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a name="RouteMethod" class="tsd-anchor"></a>
|
|
<h3>Route<wbr>Method</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Route<wbr>Method<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Routes</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"method"</span><span class="tsd-signature-symbol">]</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/0c5f0b1/src/api/routes.ts#L799">src/api/routes.ts:799</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a name="RoutePath" class="tsd-anchor"></a>
|
|
<h3>Route<wbr>Path</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Route<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Routes</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"route"</span><span class="tsd-signature-symbol">]</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/0c5f0b1/src/api/routes.ts#L798">src/api/routes.ts:798</a></li>
|
|
</ul>
|
|
</aside>
|
|
</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="Client.html">Client</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="api_permissions.html">api/permissions</a>
|
|
</li>
|
|
<li class="current tsd-kind-module">
|
|
<a href="api_routes.html">api/routes</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="config.html">config</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="globals.html">globals</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="index.html">index</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="maps_Bots.html">maps/<wbr>Bots</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="maps_Channels.html">maps/<wbr>Channels</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="maps_Collection.html">maps/<wbr>Collection</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="maps_Members.html">maps/<wbr>Members</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="maps_Messages.html">maps/<wbr>Messages</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="maps_Servers.html">maps/<wbr>Servers</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="maps_Users.html">maps/<wbr>Users</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="util_null.html">util/null</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="websocket_client.html">websocket/client</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="websocket_notifications.html">websocket/notifications</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="api_routes.html#RemoveChannelField" class="tsd-kind-icon">Remove<wbr>Channel<wbr>Field</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="api_routes.html#RemoveMemberField" class="tsd-kind-icon">Remove<wbr>Member<wbr>Field</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="api_routes.html#RemoveRoleField" class="tsd-kind-icon">Remove<wbr>Role<wbr>Field</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="api_routes.html#RemoveServerField" class="tsd-kind-icon">Remove<wbr>Server<wbr>Field</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="api_routes.html#RemoveUserField" class="tsd-kind-icon">Remove<wbr>User<wbr>Field</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter">
|
|
<a href="api_routes.html#Route" class="tsd-kind-icon">Route</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="api_routes.html#RouteMethod" class="tsd-kind-icon">Route<wbr>Method</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="api_routes.html#RoutePath" class="tsd-kind-icon">Route<wbr>Path</a>
|
|
</li>
|
|
</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>
|
|
</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> |