docs/classes/client.html
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Client | Okuna.js</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.js" 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">Okuna.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-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="../globals.html">Globals</a>
</li>
<li>
<a href="client.html">Client</a>
</li>
</ul>
<h1>Class Client</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>api</dt>
<dd><p>public</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Client</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 tsd-is-not-exported">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-not-exported"><a href="client.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-not-exported">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="client.html#apiurl" class="tsd-kind-icon">api<wbr>Url</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="client.html#authtoken" class="tsd-kind-icon">auth<wbr>Token</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="client.html#magicheadername" class="tsd-kind-icon">magic<wbr>Header<wbr>Name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="client.html#magicheadervalue" class="tsd-kind-icon">magic<wbr>Header<wbr>Value</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="client.html#requeststrategy" class="tsd-kind-icon">request<wbr>Strategy</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-not-exported">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="client.html#_buildmagicheader" class="tsd-kind-icon">_build<wbr>Magic<wbr>Header</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="client.html#auth" class="tsd-kind-icon">auth</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="client.html#categories" class="tsd-kind-icon">categories</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="client.html#circles" class="tsd-kind-icon">circles</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="client.html#communities" class="tsd-kind-icon">communities</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="client.html#connections" class="tsd-kind-icon">connections</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="client.html#devices" class="tsd-kind-icon">devices</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="client.html#emojis" class="tsd-kind-icon">emojis</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="client.html#follows" class="tsd-kind-icon">follows</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="client.html#hashtags" class="tsd-kind-icon">hashtags</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="client.html#health" class="tsd-kind-icon">health</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="client.html#lists" class="tsd-kind-icon">lists</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="client.html#moderation" class="tsd-kind-icon">moderation</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="client.html#notifications" class="tsd-kind-icon">notifications</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="client.html#posts" class="tsd-kind-icon">posts</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="client.html#updateauthtoken" class="tsd-kind-icon">update<wbr>Auth<wbr>Token</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="client.html#userinvites" class="tsd-kind-icon">user<wbr>Invites</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-not-exported">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">new <wbr>Client<span class="tsd-signature-symbol">(</span>opts<span class="tsd-signature-symbol">?: </span><a href="../interfaces/okunaopts.html" class="tsd-signature-type">OkunaOpts</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client.html" class="tsd-signature-type">Client</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/okunaorg/okuna-js/blob/ea4bcfe/src/Okuna.ts#L34">Okuna.ts:34</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> opts: <a href="../interfaces/okunaopts.html" class="tsd-signature-type">OkunaOpts</a><span class="tsd-signature-symbol"> = {}</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="client.html" class="tsd-signature-type">Client</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="apiurl" class="tsd-anchor"></a>
<h3>api<wbr>Url</h3>
<div class="tsd-signature tsd-kind-icon">api<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/okunaorg/okuna-js/blob/ea4bcfe/src/Okuna.ts#L30">Okuna.ts:30</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>JavaScript API bindings for the Okuna social network</p>
</div>
<dl class="tsd-comment-tags">
<dt>param</dt>
<dd></dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="authtoken" class="tsd-anchor"></a>
<h3>auth<wbr>Token</h3>
<div class="tsd-signature tsd-kind-icon">auth<wbr>Token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/okunaorg/okuna-js/blob/ea4bcfe/src/Okuna.ts#L31">Okuna.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="magicheadername" class="tsd-anchor"></a>
<h3>magic<wbr>Header<wbr>Name</h3>
<div class="tsd-signature tsd-kind-icon">magic<wbr>Header<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/okunaorg/okuna-js/blob/ea4bcfe/src/Okuna.ts#L32">Okuna.ts:32</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="magicheadervalue" class="tsd-anchor"></a>
<h3>magic<wbr>Header<wbr>Value</h3>
<div class="tsd-signature tsd-kind-icon">magic<wbr>Header<wbr>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/okunaorg/okuna-js/blob/ea4bcfe/src/Okuna.ts#L33">Okuna.ts:33</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="requeststrategy" class="tsd-anchor"></a>
<h3>request<wbr>Strategy</h3>
<div class="tsd-signature tsd-kind-icon">request<wbr>Strategy<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="requeststrategy.html" class="tsd-signature-type">RequestStrategy</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/okunaorg/okuna-js/blob/ea4bcfe/src/Okuna.ts#L34">Okuna.ts:34</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a name="_buildmagicheader" class="tsd-anchor"></a>
<h3>_build<wbr>Magic<wbr>Header</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">_build<wbr>Magic<wbr>Header<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/okunaorg/okuna-js/blob/ea4bcfe/src/Okuna.ts#L53">Okuna.ts:53</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>_buildMagicHeader() - Builds a magic header to add to the request headers</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
<div class="tsd-comment tsd-typography">
<p>the name of the magic header</p>
</div>
</li>
<li>
<h5>value: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
<div class="tsd-comment tsd-typography">
<p>the value of the magic header</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4>
<p>an object containing the provided data</p>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a name="auth" class="tsd-anchor"></a>
<h3>auth</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">auth<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="authapi.html" class="tsd-signature-type">AuthAPI</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/okunaorg/okuna-js/blob/ea4bcfe/src/Okuna.ts#L79">Okuna.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>auth()</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="authapi.html" class="tsd-signature-type">AuthAPI</a></h4>
<ul>
<li>AuthAPI instance</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a name="categories" class="tsd-anchor"></a>
<h3>categories</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">categories<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="categoriesapi.html" class="tsd-signature-type">CategoriesAPI</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/okunaorg/okuna-js/blob/ea4bcfe/src/Okuna.ts#L87">Okuna.ts:87</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>categories()</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="categoriesapi.html" class="tsd-signature-type">CategoriesAPI</a></h4>
<ul>
<li>CategoriesAPI instance</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a name="circles" class="tsd-anchor"></a>
<h3>circles</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">circles<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="circlesapi.html" class="tsd-signature-type">CirclesAPI</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/okunaorg/okuna-js/blob/ea4bcfe/src/Okuna.ts#L95">Okuna.ts:95</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>circles()</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="circlesapi.html" class="tsd-signature-type">CirclesAPI</a></h4>
<ul>
<li>CirclesAPI instance</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a name="communities" class="tsd-anchor"></a>
<h3>communities</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">communities<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="communitiesapi.html" class="tsd-signature-type">CommunitiesAPI</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/okunaorg/okuna-js/blob/ea4bcfe/src/Okuna.ts#L103">Okuna.ts:103</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>communities()</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="communitiesapi.html" class="tsd-signature-type">CommunitiesAPI</a></h4>
<ul>
<li>CommunitiesAPI instance</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a name="connections" class="tsd-anchor"></a>
<h3>connections</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">connections<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="connectionsapi.html" class="tsd-signature-type">ConnectionsAPI</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/okunaorg/okuna-js/blob/ea4bcfe/src/Okuna.ts#L111">Okuna.ts:111</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>connections()</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="connectionsapi.html" class="tsd-signature-type">ConnectionsAPI</a></h4>
<ul>
<li>ConnectionsAPI instance</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a name="devices" class="tsd-anchor"></a>
<h3>devices</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">devices<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="devicesapi.html" class="tsd-signature-type">DevicesAPI</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/okunaorg/okuna-js/blob/ea4bcfe/src/Okuna.ts#L119">Okuna.ts:119</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>devices()</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="devicesapi.html" class="tsd-signature-type">DevicesAPI</a></h4>
<ul>
<li>DevicesAPI instance</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a name="emojis" class="tsd-anchor"></a>
<h3>emojis</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">emojis<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="emojisapi.html" class="tsd-signature-type">EmojisAPI</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/okunaorg/okuna-js/blob/ea4bcfe/src/Okuna.ts#L127">Okuna.ts:127</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>emojis()</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="emojisapi.html" class="tsd-signature-type">EmojisAPI</a></h4>
<ul>
<li>EmojisAPI instance</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a name="follows" class="tsd-anchor"></a>
<h3>follows</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">follows<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="followsapi.html" class="tsd-signature-type">FollowsAPI</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/okunaorg/okuna-js/blob/ea4bcfe/src/Okuna.ts#L135">Okuna.ts:135</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>follows()</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="followsapi.html" class="tsd-signature-type">FollowsAPI</a></h4>
<ul>
<li>FollowsAPI instance</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a name="hashtags" class="tsd-anchor"></a>
<h3>hashtags</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">hashtags<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="hashtagsapi.html" class="tsd-signature-type">HashtagsAPI</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/okunaorg/okuna-js/blob/ea4bcfe/src/Okuna.ts#L143">Okuna.ts:143</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>hashtags()</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="hashtagsapi.html" class="tsd-signature-type">HashtagsAPI</a></h4>
<ul>
<li>HashtagsAPI instance</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a name="health" class="tsd-anchor"></a>
<h3>health</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">health<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="healthapi.html" class="tsd-signature-type">HealthAPI</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/okunaorg/okuna-js/blob/ea4bcfe/src/Okuna.ts#L151">Okuna.ts:151</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>health()</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="healthapi.html" class="tsd-signature-type">HealthAPI</a></h4>
<ul>
<li>HealthAPI instance</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a name="lists" class="tsd-anchor"></a>
<h3>lists</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">lists<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="listsapi.html" class="tsd-signature-type">ListsAPI</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/okunaorg/okuna-js/blob/ea4bcfe/src/Okuna.ts#L159">Okuna.ts:159</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>lists()</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="listsapi.html" class="tsd-signature-type">ListsAPI</a></h4>
<ul>
<li>ListsAPI instance</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a name="moderation" class="tsd-anchor"></a>
<h3>moderation</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">moderation<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="moderationapi.html" class="tsd-signature-type">ModerationAPI</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/okunaorg/okuna-js/blob/ea4bcfe/src/Okuna.ts#L167">Okuna.ts:167</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>moderation()</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="moderationapi.html" class="tsd-signature-type">ModerationAPI</a></h4>
<ul>
<li>ModerationAPI instance</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a name="notifications" class="tsd-anchor"></a>
<h3>notifications</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">notifications<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="notificationsapi.html" class="tsd-signature-type">NotificationsAPI</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/okunaorg/okuna-js/blob/ea4bcfe/src/Okuna.ts#L175">Okuna.ts:175</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>notifications()</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="notificationsapi.html" class="tsd-signature-type">NotificationsAPI</a></h4>
<ul>
<li>NotificationsAPI instance</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a name="posts" class="tsd-anchor"></a>
<h3>posts</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">posts<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="postsapi.html" class="tsd-signature-type">PostsAPI</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/okunaorg/okuna-js/blob/ea4bcfe/src/Okuna.ts#L183">Okuna.ts:183</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>posts()</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="postsapi.html" class="tsd-signature-type">PostsAPI</a></h4>
<ul>
<li>PostsAPI instance</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a name="updateauthtoken" class="tsd-anchor"></a>
<h3>update<wbr>Auth<wbr>Token</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">update<wbr>Auth<wbr>Token<span class="tsd-signature-symbol">(</span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/okunaorg/okuna-js/blob/ea4bcfe/src/Okuna.ts#L71">Okuna.ts:71</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>updateAuthToken() - Updates the authorization token of the current Client instance</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>token: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the new authorization token</p>
</div>
</li>
</ul>
<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 tsd-is-not-exported">
<a name="userinvites" class="tsd-anchor"></a>
<h3>user<wbr>Invites</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">user<wbr>Invites<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="userinvitesapi.html" class="tsd-signature-type">UserInvitesAPI</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/okunaorg/okuna-js/blob/ea4bcfe/src/Okuna.ts#L191">Okuna.ts:191</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>userInvites()</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="userinvitesapi.html" class="tsd-signature-type">UserInvitesAPI</a></h4>
<ul>
<li>UserInvitesAPI instance</li>
</ul>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></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-is-not-exported">
<a href="client.html" class="tsd-kind-icon">Client</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-not-exported">
<a href="client.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="client.html#apiurl" class="tsd-kind-icon">api<wbr>Url</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="client.html#authtoken" class="tsd-kind-icon">auth<wbr>Token</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="client.html#magicheadername" class="tsd-kind-icon">magic<wbr>Header<wbr>Name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="client.html#magicheadervalue" class="tsd-kind-icon">magic<wbr>Header<wbr>Value</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="client.html#requeststrategy" class="tsd-kind-icon">request<wbr>Strategy</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="client.html#_buildmagicheader" class="tsd-kind-icon">_build<wbr>Magic<wbr>Header</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="client.html#auth" class="tsd-kind-icon">auth</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="client.html#categories" class="tsd-kind-icon">categories</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="client.html#circles" class="tsd-kind-icon">circles</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="client.html#communities" class="tsd-kind-icon">communities</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="client.html#connections" class="tsd-kind-icon">connections</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="client.html#devices" class="tsd-kind-icon">devices</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="client.html#emojis" class="tsd-kind-icon">emojis</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="client.html#follows" class="tsd-kind-icon">follows</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="client.html#hashtags" class="tsd-kind-icon">hashtags</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="client.html#health" class="tsd-kind-icon">health</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="client.html#lists" class="tsd-kind-icon">lists</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="client.html#moderation" class="tsd-kind-icon">moderation</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="client.html#notifications" class="tsd-kind-icon">notifications</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="client.html#posts" class="tsd-kind-icon">posts</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="client.html#updateauthtoken" class="tsd-kind-icon">update<wbr>Auth<wbr>Token</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="client.html#userinvites" class="tsd-kind-icon">user<wbr>Invites</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-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<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-index-signature"><span class="tsd-kind-icon">Index signature</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-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><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>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</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>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</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>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>