@convergence/convergence

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Users and Identity | 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">  <script id="ze-snippet" src="https://static.zdassets.com/ekr/snippet.js?key=3ee5157d-2fc2-4b08-b6c7-d5fad0533179"> </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="users_and_identity.html">Users and Identity</a> </li> </ul> <h1>Module Users and Identity</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>This subsystem provides a suite of utilities for looking up users and groups in the current domain.</p> </div> <p>See some common use cases in the <a href="https://docs.convergence.io/guide/identity/overview.html">developer guide</a>.</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>Type aliases</h3> <ul class="tsd-index-list"> <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="users_and_identity.html#domainuseridentifier" class="tsd-kind-icon">Domain<wbr>User<wbr>Identifier</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a href="users_and_identity.html#domainusermapping" class="tsd-kind-icon">Domain<wbr>User<wbr>Mapping</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="users_and_identity.html#userfield" class="tsd-kind-icon">User<wbr>Field</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Enumerations</h3> <ul class="tsd-index-list"> <li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/users_and_identity.domainusertype.html" class="tsd-kind-icon">Domain<wbr>User<wbr>Type</a></li> </ul> </section> <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/users_and_identity.convergencesession.html" class="tsd-kind-icon">Convergence<wbr>Session</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/users_and_identity.domainuser.html" class="tsd-kind-icon">Domain<wbr>User</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/users_and_identity.domainuserid.html" class="tsd-kind-icon">Domain<wbr>User<wbr>Id</a></li> <li class="tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter"><a href="../classes/users_and_identity.domainuseridmap.html" class="tsd-kind-icon">Domain<wbr>User<wbr>IdMap</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/users_and_identity.identityservice.html" class="tsd-kind-icon">Identity<wbr>Service</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/users_and_identity.usergroup.html" class="tsd-kind-icon">User<wbr>Group</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/users_and_identity.userquery.html" class="tsd-kind-icon">User<wbr>Query</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="domainuseridentifier" class="tsd-anchor"></a> <h3>Domain<wbr>User<wbr>Identifier</h3> <div class="tsd-signature tsd-kind-icon">Domain<wbr>User<wbr>Identifier<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../classes/users_and_identity.domainuserid.html" class="tsd-signature-type">DomainUserId</a></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A string representing the username of a "normal" user or <a href="../classes/users_and_identity.domainuserid.html">DomainUserId</a>.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"> <a name="domainusermapping" class="tsd-anchor"></a> <h3>Domain<wbr>User<wbr>Mapping</h3> <div class="tsd-signature tsd-kind-icon">Domain<wbr>User<wbr>Mapping<T><span class="tsd-signature-symbol">:</span> <a href="../globals.html#stringmaplike" class="tsd-signature-type">StringMapLike</a><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">Map</span><span class="tsd-signature-symbol"><</span><a href="users_and_identity.html#domainuseridentifier" class="tsd-signature-type">DomainUserIdentifier</a><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><a href="../classes/users_and_identity.domainuseridmap.html" class="tsd-signature-type">DomainUserIdMap</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The DomainUserMapping type defines the union type for the multiple ways a domain user might be mapped to a value.</p> </div> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>T</h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"> <a name="userfield" class="tsd-anchor"></a> <h3>User<wbr>Field</h3> <div class="tsd-signature tsd-kind-icon">User<wbr>Field<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"username"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"email"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"firstName"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"lastName"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"displayName"</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The fields of a user that are available to be queried on. See <a href="../classes/users_and_identity.identityservice.html#search">search</a></p> </div> </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=" 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="current 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-enum tsd-parent-kind-module"> <a href="../enums/users_and_identity.domainusertype.html" class="tsd-kind-icon">Domain<wbr>User<wbr>Type</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="../classes/users_and_identity.convergencesession.html" class="tsd-kind-icon">Convergence<wbr>Session</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="../classes/users_and_identity.domainuser.html" class="tsd-kind-icon">Domain<wbr>User</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="../classes/users_and_identity.domainuserid.html" class="tsd-kind-icon">Domain<wbr>User<wbr>Id</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter"> <a href="../classes/users_and_identity.domainuseridmap.html" class="tsd-kind-icon">Domain<wbr>User<wbr>IdMap</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="../classes/users_and_identity.identityservice.html" class="tsd-kind-icon">Identity<wbr>Service</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="../classes/users_and_identity.usergroup.html" class="tsd-kind-icon">User<wbr>Group</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="../interfaces/users_and_identity.userquery.html" class="tsd-kind-icon">User<wbr>Query</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="users_and_identity.html#domainuseridentifier" class="tsd-kind-icon">Domain<wbr>User<wbr>Identifier</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"> <a href="users_and_identity.html#domainusermapping" class="tsd-kind-icon">Domain<wbr>User<wbr>Mapping</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="users_and_identity.html#userfield" class="tsd-kind-icon">User<wbr>Field</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>