@convergence/convergence
Version:
Convergence JavaScript Client
402 lines (401 loc) • 21.7 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Convergence JavaScript Client API Documentation</title>
<meta name="description" content="Documentation for Convergence JavaScript Client API Documentation">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
<link rel="icon" type="image/png" href="https://convergence.io/assets/img/favicon/favicon-16x16.png" sizes="16x16">
<link rel="icon" type="image/png" href="https://convergence.io/assets/img/favicon/favicon-32x32.png" sizes="32x32">
<link rel="icon" type="image/ico" href="https://convergence.io/assets/img/favicon/favicon.ico" sizes="48x48">
<link rel="icon" type="image/png" href="https://convergence.io/assets/img/favicon/favicon-96x96.png" sizes="96x96">
<!-- Start of convergencelabs Zendesk Widget script -->
<script id="ze-snippet" src="https://static.zdassets.com/ekr/snippet.js?key=3ee5157d-2fc2-4b08-b6c7-d5fad0533179"> </script>
<!-- End of convergencelabs Zendesk Widget script -->
</head>
<body>
<header>
<div class="tsd-page-toolbar convergence-header">
<div class="container">
<div class="flex-content">
<a href="index.html" class="header-brand">
<img src=assets/images/convergence-logo.png />
<span class="brand-title brand-copy">Convergence JavaScript Client API Documentation</span>
<span class="version">1.0.0-rc.12</span>
</a>
<div class="links brand-copy">
<div class="link">
<a href="https://docs.convergence.io/guide/">Dev Guide</a>
</div>
<div class="link">
<a href="https://examples.convergence.io">Examples</a>
</div>
<div class="link">
<a href="https://convergence.io/support/">Support</a>
</div>
</div>
</div>
<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>
</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">
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</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">Index</a>
</li>
</ul>
<h1>Convergence JavaScript Client API Documentation</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>Modules</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-module"><a href="modules/activities.html" class="tsd-kind-icon">Activities</a></li>
<li class="tsd-kind-module"><a href="modules/chat.html" class="tsd-kind-icon">Chat</a></li>
<li class="tsd-kind-module"><a href="modules/connection_and_authentication.html" class="tsd-kind-icon">Connection and <wbr>Authentication</a></li>
<li class="tsd-kind-module"><a href="modules/offline.html" class="tsd-kind-icon">Offline</a></li>
<li class="tsd-kind-module"><a href="modules/presence.html" class="tsd-kind-icon">Presence</a></li>
<li class="tsd-kind-module"><a href="modules/real_time_data.html" class="tsd-kind-icon">Real <wbr>Time <wbr>Data</a></li>
<li class="tsd-kind-module"><a href="modules/users_and_identity.html" class="tsd-kind-icon">Users and <wbr>Identity</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Classes</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/abstractpermissionmanager.html" class="tsd-kind-icon">Abstract<wbr>Permission<wbr>Manager</a></li>
<li class="tsd-kind-class"><a href="classes/convergence.html" class="tsd-kind-icon">Convergence</a></li>
<li class="tsd-kind-class"><a href="classes/convergencedomain.html" class="tsd-kind-icon">Convergence<wbr>Domain</a></li>
<li class="tsd-kind-class"><a href="classes/convergenceerror.html" class="tsd-kind-icon">Convergence<wbr>Error</a></li>
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/convergenceeventemitter.html" class="tsd-kind-icon">Convergence<wbr>Event<wbr>Emitter</a></li>
<li class="tsd-kind-class"><a href="classes/convergenceservererror.html" class="tsd-kind-icon">Convergence<wbr>Server<wbr>Error</a></li>
<li class="tsd-kind-class"><a href="classes/errorevent.html" class="tsd-kind-icon">Error<wbr>Event</a></li>
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/pageddata.html" class="tsd-kind-icon">Paged<wbr>Data</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Enumerations</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum"><a href="enums/loglevel.html" class="tsd-kind-icon">Log<wbr>Level</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/iallpermissions.html" class="tsd-kind-icon">IAll<wbr>Permissions</a></li>
<li class="tsd-kind-interface"><a href="interfaces/iconvergenceevent.html" class="tsd-kind-icon">IConvergence<wbr>Event</a></li>
<li class="tsd-kind-interface"><a href="interfaces/iloggerconfig.html" class="tsd-kind-icon">ILogger<wbr>Config</a></li>
<li class="tsd-kind-interface"><a href="interfaces/iloggingconfigdata.html" class="tsd-kind-icon">ILogging<wbr>Config<wbr>Data</a></li>
<li class="tsd-kind-interface"><a href="interfaces/orderby.html" class="tsd-kind-icon">Order<wbr>By</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Type aliases</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="globals.html#convergenceeventlistener" class="tsd-kind-icon">Convergence<wbr>Event<wbr>Listener</a></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="globals.html#stringmaplike" class="tsd-kind-icon">String<wbr>Map<wbr>Like</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Object literals</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-object-literal"><a href="globals.html#convergenceerrorcodes" class="tsd-kind-icon">Convergence<wbr>Error<wbr>Codes</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-has-type-parameter">
<a name="convergenceeventlistener" class="tsd-anchor"></a>
<h3>Convergence<wbr>Event<wbr>Listener</h3>
<div class="tsd-signature tsd-kind-icon">Convergence<wbr>Event<wbr>Listener<T><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>event<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">void</span></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ConvergenceEventListener type defines a function which takes a specific
subclass of IConvergenceEvent as a single argument in order to receive fired
events. Consumers can use the familiar Node style event registration methods
(e.g. addListener, removeListener, on, off, once, etc.) or they can consume
events as an observable stream using the <code>events</code> method.</p>
</div>
<dl class="tsd-comment-tags">
<dt>param</dt>
<dd><p> The subclass of IConvergenceEvent that represents the fired event.</p>
</dd>
</dl>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T<span class="tsd-signature-symbol">: </span><a href="interfaces/iconvergenceevent.html" class="tsd-signature-type">IConvergenceEvent</a></h4>
</li>
</ul>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<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">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-type">T</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter">
<a name="stringmaplike" class="tsd-anchor"></a>
<h3>String<wbr>Map<wbr>Like</h3>
<div class="tsd-signature tsd-kind-icon">String<wbr>Map<wbr>Like<T><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</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-symbol">{}</span></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Represents a Javascript Map or Object literal.</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T = <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Object literals</h2>
<section class="tsd-panel tsd-member tsd-kind-object-literal">
<a name="convergenceerrorcodes" class="tsd-anchor"></a>
<h3>Convergence<wbr>Error<wbr>Codes</h3>
<div class="tsd-signature tsd-kind-icon">Convergence<wbr>Error<wbr>Codes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Some potential error codes in Convergence.</p>
</div>
</div>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="convergenceerrorcodes.authentication_failed" class="tsd-anchor"></a>
<h3>AUTHENTICATION_<wbr>FAILED</h3>
<div class="tsd-signature tsd-kind-icon">AUTHENTICATION_<wbr>FAILED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "authentication_failed"</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="convergenceerrorcodes.chat_not_joined" class="tsd-anchor"></a>
<h3>CHAT_<wbr>NOT_<wbr>JOINED</h3>
<div class="tsd-signature tsd-kind-icon">CHAT_<wbr>NOT_<wbr>JOINED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "chat_not_joined"</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="convergenceerrorcodes.connection_failed" class="tsd-anchor"></a>
<h3>CONNECTION_<wbr>FAILED</h3>
<div class="tsd-signature tsd-kind-icon">CONNECTION_<wbr>FAILED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "connection_failed"</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="convergenceerrorcodes.model_already_exists" class="tsd-anchor"></a>
<h3>MODEL_<wbr>ALREADY_<wbr>EXISTS</h3>
<div class="tsd-signature tsd-kind-icon">MODEL_<wbr>ALREADY_<wbr>EXISTS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "model_already_exists"</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="convergenceerrorcodes.offline" class="tsd-anchor"></a>
<h3>OFFLINE</h3>
<div class="tsd-signature tsd-kind-icon">OFFLINE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "offline"</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="convergenceerrorcodes.request_timeout" class="tsd-anchor"></a>
<h3>REQUEST_<wbr>TIMEOUT</h3>
<div class="tsd-signature tsd-kind-icon">REQUEST_<wbr>TIMEOUT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "request_timeout"</span></div>
<aside class="tsd-sources">
</aside>
</section>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals current ">
<a href="globals.html"><em>Index</em></a>
</li>
<li class="modules-label">Modules</li>
<li class=" tsd-kind-module">
<span class="tsd-kind-icon"><a href="modules/activities.html">Activities</a></span>
</li>
<li class=" tsd-kind-module">
<span class="tsd-kind-icon"><a href="modules/chat.html">Chat</a></span>
</li>
<li class=" tsd-kind-module">
<span class="tsd-kind-icon"><a href="modules/connection_and_authentication.html">Connection and <wbr>Authentication</a></span>
</li>
<li class=" tsd-kind-module">
<span class="tsd-kind-icon"><a href="modules/offline.html">Offline</a></span>
</li>
<li class=" tsd-kind-module">
<span class="tsd-kind-icon"><a href="modules/presence.html">Presence</a></span>
</li>
<li class=" tsd-kind-module">
<span class="tsd-kind-icon"><a href="modules/real_time_data.html">Real <wbr>Time <wbr>Data</a></span>
</li>
<li class=" tsd-kind-module">
<span class="tsd-kind-icon"><a href="modules/users_and_identity.html">Users and <wbr>Identity</a></span>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="enums/loglevel.html" class="tsd-kind-icon">Log<wbr>Level</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter">
<a href="classes/abstractpermissionmanager.html" class="tsd-kind-icon">Abstract<wbr>Permission<wbr>Manager</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/convergence.html" class="tsd-kind-icon">Convergence</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/convergencedomain.html" class="tsd-kind-icon">Convergence<wbr>Domain</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/convergenceerror.html" class="tsd-kind-icon">Convergence<wbr>Error</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter">
<a href="classes/convergenceeventemitter.html" class="tsd-kind-icon">Convergence<wbr>Event<wbr>Emitter</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/convergenceservererror.html" class="tsd-kind-icon">Convergence<wbr>Server<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/errorevent.html" class="tsd-kind-icon">Error<wbr>Event</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter">
<a href="classes/pageddata.html" class="tsd-kind-icon">Paged<wbr>Data</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="interfaces/iallpermissions.html" class="tsd-kind-icon">IAll<wbr>Permissions</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/iconvergenceevent.html" class="tsd-kind-icon">IConvergence<wbr>Event</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/iloggerconfig.html" class="tsd-kind-icon">ILogger<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/iloggingconfigdata.html" class="tsd-kind-icon">ILogging<wbr>Config<wbr>Data</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/orderby.html" class="tsd-kind-icon">Order<wbr>By</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="globals.html#convergenceeventlistener" class="tsd-kind-icon">Convergence<wbr>Event<wbr>Listener</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="globals.html#stringmaplike" class="tsd-kind-icon">String<wbr>Map<wbr>Like</a>
</li>
<li class=" tsd-kind-object-literal">
<a href="globals.html#convergenceerrorcodes" class="tsd-kind-icon">Convergence<wbr>Error<wbr>Codes</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<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-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-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-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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<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>
</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-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-84372428-3', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>