@convergence/convergence
Version:
Convergence JavaScript Client
239 lines (238 loc) • 12.4 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Presence | 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>
<li>
<a href="presence.html">Presence</a>
</li>
</ul>
<h1>Module Presence</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">
<div class="lead">
<p>The Presence subsytem provides the ability to tell who is available
for collaboration and what their current status is.</p>
</div>
<p>The entrance point is the <a href="../classes/presence.presenceservice.html">PresenceService</a>.
User Presence tracks the availability and state of
Domain Users within the System. Users are generally available or not
if they have at least one session that is connected. Each user in the
system can set presence state. Presence state is global for each user
in that the state is shared across all sessions.</p>
<p>See the <a href="https://docs.convergence.io/guide/presence/overview.html">developer guide</a> for additional background.</p>
</div>
</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>Classes</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/presence.presenceavailabilitychangedevent.html" class="tsd-kind-icon">Presence<wbr>Availability<wbr>Changed<wbr>Event</a></li>
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/presence.presenceservice.html" class="tsd-kind-icon">Presence<wbr>Service</a></li>
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/presence.presencestateclearedevent.html" class="tsd-kind-icon">Presence<wbr>State<wbr>Cleared<wbr>Event</a></li>
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/presence.presencestateremovedevent.html" class="tsd-kind-icon">Presence<wbr>State<wbr>Removed<wbr>Event</a></li>
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/presence.presencestatesetevent.html" class="tsd-kind-icon">Presence<wbr>State<wbr>Set<wbr>Event</a></li>
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/presence.userpresence.html" class="tsd-kind-icon">User<wbr>Presence</a></li>
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/presence.userpresencesubscription.html" class="tsd-kind-icon">User<wbr>Presence<wbr>Subscription</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/presence.ipresenceevent.html" class="tsd-kind-icon">IPresence<wbr>Event</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/presence.presenceserviceevents.html" class="tsd-kind-icon">Presence<wbr>Service<wbr>Events</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/presence.userpresencesubscriptionevents.html" class="tsd-kind-icon">User<wbr>Presence<wbr>Subscription<wbr>Events</a></li>
</ul>
</section>
</div>
</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>Index</em></a>
</li>
<li class="modules-label">Modules</li>
<li class=" tsd-kind-module">
<span class="tsd-kind-icon"><a href="activities.html">Activities</a></span>
</li>
<li class=" tsd-kind-module">
<span class="tsd-kind-icon"><a href="chat.html">Chat</a></span>
</li>
<li class=" tsd-kind-module">
<span class="tsd-kind-icon"><a href="connection_and_authentication.html">Connection and <wbr>Authentication</a></span>
</li>
<li class=" tsd-kind-module">
<span class="tsd-kind-icon"><a href="offline.html">Offline</a></span>
</li>
<li class="current tsd-kind-module">
<span class="tsd-kind-icon"><a href="presence.html">Presence</a></span>
</li>
<li class=" tsd-kind-module">
<span class="tsd-kind-icon"><a href="real_time_data.html">Real <wbr>Time <wbr>Data</a></span>
</li>
<li class=" tsd-kind-module">
<span class="tsd-kind-icon"><a href="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-class tsd-parent-kind-module">
<a href="../classes/presence.presenceavailabilitychangedevent.html" class="tsd-kind-icon">Presence<wbr>Availability<wbr>Changed<wbr>Event</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="../classes/presence.presenceservice.html" class="tsd-kind-icon">Presence<wbr>Service</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="../classes/presence.presencestateclearedevent.html" class="tsd-kind-icon">Presence<wbr>State<wbr>Cleared<wbr>Event</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="../classes/presence.presencestateremovedevent.html" class="tsd-kind-icon">Presence<wbr>State<wbr>Removed<wbr>Event</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="../classes/presence.presencestatesetevent.html" class="tsd-kind-icon">Presence<wbr>State<wbr>Set<wbr>Event</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="../classes/presence.userpresence.html" class="tsd-kind-icon">User<wbr>Presence</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="../classes/presence.userpresencesubscription.html" class="tsd-kind-icon">User<wbr>Presence<wbr>Subscription</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/presence.ipresenceevent.html" class="tsd-kind-icon">IPresence<wbr>Event</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/presence.presenceserviceevents.html" class="tsd-kind-icon">Presence<wbr>Service<wbr>Events</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/presence.userpresencesubscriptionevents.html" class="tsd-kind-icon">User<wbr>Presence<wbr>Subscription<wbr>Events</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>