@convergence/convergence
Version:
Convergence JavaScript Client
663 lines (662 loc) • 34 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DomainUserId | 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="../modules/users_and_identity.html">Users and Identity</a>
</li>
<li>
<a href="users_and_identity.domainuserid.html">DomainUserId</a>
</li>
</ul>
<h1>Class DomainUserId</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 is a convenience class providing utilities to help identity a particular
Domain User. A guid is the best means of uniquely identifing a user within a domain,
which combines their <a href="users_and_identity.domainuserid.html#usertype">userType</a> with <a href="users_and_identity.domainuserid.html#username">username</a>.</p>
</div>
<p><a href="users_and_identity.domainuserid.html">DomainUserId</a>s are read-only.</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">DomainUserId</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 ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="users_and_identity.domainuserid.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="users_and_identity.domainuserid.html#usertype" class="tsd-kind-icon">user<wbr>Type</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="users_and_identity.domainuserid.html#username" class="tsd-kind-icon">username</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="users_and_identity.domainuserid.html#equals" class="tsd-kind-icon">equals</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="users_and_identity.domainuserid.html#toguid" class="tsd-kind-icon">to<wbr>Guid</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="users_and_identity.domainuserid.html#anonymous" class="tsd-kind-icon">anonymous</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="users_and_identity.domainuserid.html#convergence" class="tsd-kind-icon">convergence</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="users_and_identity.domainuserid.html#fromguid" class="tsd-kind-icon">from<wbr>Guid</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="users_and_identity.domainuserid.html#guid" class="tsd-kind-icon">guid</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="users_and_identity.domainuserid.html#normal" class="tsd-kind-icon">normal</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="users_and_identity.domainuserid.html#of" class="tsd-kind-icon">of</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="users_and_identity.domainuserid.html#todomainuserid" class="tsd-kind-icon">to<wbr>Domain<wbr>User<wbr>Id</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="users_and_identity.domainuserid.html#todomainusertype" class="tsd-kind-icon">to<wbr>Domain<wbr>User<wbr>Type</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Domain<wbr>User<wbr>Id<span class="tsd-signature-symbol">(</span>userType<span class="tsd-signature-symbol">: </span><a href="../enums/users_and_identity.domainusertype.html" class="tsd-signature-type">DomainUserType</a>, username<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><a href="users_and_identity.domainuserid.html" class="tsd-signature-type">DomainUserId</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Constructs a <code>DomainUserId</code> from the given user type and username.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>userType: <a href="../enums/users_and_identity.domainusertype.html" class="tsd-signature-type">DomainUserType</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the type of user</p>
</div>
</div>
</li>
<li>
<h5>username: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the user's username</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="users_and_identity.domainuserid.html" class="tsd-signature-type">DomainUserId</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="usertype" class="tsd-anchor"></a>
<h3>user<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">user<wbr>Type<span class="tsd-signature-symbol">:</span> <a href="../enums/users_and_identity.domainusertype.html" class="tsd-signature-type">DomainUserType</a></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the type of user</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="username" class="tsd-anchor"></a>
<h3>username</h3>
<div class="tsd-signature tsd-kind-icon">username<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the user's username</p>
</div>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="equals" class="tsd-anchor"></a>
<h3>equals</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">equals<span class="tsd-signature-symbol">(</span>other<span class="tsd-signature-symbol">: </span><a href="users_and_identity.domainuserid.html" class="tsd-signature-type">DomainUserId</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns true if this user is the same as the given user.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>other: <a href="users_and_identity.domainuserid.html" class="tsd-signature-type">DomainUserId</a></h5>
<div class="tsd-comment tsd-typography">
<p>another domain user</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="toguid" class="tsd-anchor"></a>
<h3>to<wbr>Guid</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">to<wbr>Guid<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns a string GUID for this user guaranteed to be unique within this domain.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="anonymous" class="tsd-anchor"></a>
<h3>anonymous</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">anonymous<span class="tsd-signature-symbol">(</span>username<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><a href="users_and_identity.domainuserid.html" class="tsd-signature-type">DomainUserId</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Constructs a "anonymous" <code>DomainUserId</code> by username.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>username: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the anonymous user's unique username.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="users_and_identity.domainuserid.html" class="tsd-signature-type">DomainUserId</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="convergence" class="tsd-anchor"></a>
<h3>convergence</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">convergence<span class="tsd-signature-symbol">(</span>username<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><a href="users_and_identity.domainuserid.html" class="tsd-signature-type">DomainUserId</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Constructs a "convergence" <code>DomainUserId</code> by username.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>username: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the convergence user's unique username.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="users_and_identity.domainuserid.html" class="tsd-signature-type">DomainUserId</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="fromguid" class="tsd-anchor"></a>
<h3>from<wbr>Guid</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">from<wbr>Guid<span class="tsd-signature-symbol">(</span>guid<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><a href="users_and_identity.domainuserid.html" class="tsd-signature-type">DomainUserId</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Constructs a DomainUserId from a guid.</p>
</div>
<dl class="tsd-comment-tags">
<dt>see</dt>
<dd><p>guid</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>guid: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the type of user</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="users_and_identity.domainuserid.html" class="tsd-signature-type">DomainUserId</a></h4>
<p>A new DomainUserId, deserialized from the guid.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="guid" class="tsd-anchor"></a>
<h3>guid</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">guid<span class="tsd-signature-symbol">(</span>userType<span class="tsd-signature-symbol">: </span><a href="../enums/users_and_identity.domainusertype.html" class="tsd-signature-type">DomainUserType</a>, username<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">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Constructs a GUID from the given user type and username.</p>
</div>
<p>Equivalent to <code>new DomainUserId(userType, username).toGuid()</code></p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>userType: <a href="../enums/users_and_identity.domainusertype.html" class="tsd-signature-type">DomainUserType</a></h5>
<div class="tsd-comment tsd-typography">
<p>the type of user</p>
</div>
</li>
<li>
<h5>username: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the user's username</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="normal" class="tsd-anchor"></a>
<h3>normal</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">normal<span class="tsd-signature-symbol">(</span>username<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><a href="users_and_identity.domainuserid.html" class="tsd-signature-type">DomainUserId</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Constructs a "normal" <code>DomainUserId</code> by username.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>username: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the normal user's unique username</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="users_and_identity.domainuserid.html" class="tsd-signature-type">DomainUserId</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="of" class="tsd-anchor"></a>
<h3>of</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">of<span class="tsd-signature-symbol">(</span>userId<span class="tsd-signature-symbol">: </span><a href="../modules/users_and_identity.html#domainuseridentifier" class="tsd-signature-type">DomainUserIdentifier</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="users_and_identity.domainuserid.html" class="tsd-signature-type">DomainUserId</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>This is a convenience function to construct a <code>DomainUserId</code> from a bare username.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>userId: <a href="../modules/users_and_identity.html#domainuseridentifier" class="tsd-signature-type">DomainUserIdentifier</a></h5>
<div class="tsd-comment tsd-typography">
<p>a "normal" user's username or DomainUserId</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="users_and_identity.domainuserid.html" class="tsd-signature-type">DomainUserId</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="todomainuserid" class="tsd-anchor"></a>
<h3>to<wbr>Domain<wbr>User<wbr>Id</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">to<wbr>Domain<wbr>User<wbr>Id<span class="tsd-signature-symbol">(</span>userId<span class="tsd-signature-symbol">: </span><a href="../modules/users_and_identity.html#domainuseridentifier" class="tsd-signature-type">DomainUserIdentifier</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="users_and_identity.domainuserid.html" class="tsd-signature-type">DomainUserId</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>This is a convenience function to construct a <code>DomainUserId</code> from a bare username.</p>
</div>
<dl class="tsd-comment-tags">
<dt>deprecated</dt>
<dd><p>use of().</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>userId: <a href="../modules/users_and_identity.html#domainuseridentifier" class="tsd-signature-type">DomainUserIdentifier</a></h5>
<div class="tsd-comment tsd-typography">
<p>a "normal" user's username or DomainUserId</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="users_and_identity.domainuserid.html" class="tsd-signature-type">DomainUserId</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="todomainusertype" class="tsd-anchor"></a>
<h3>to<wbr>Domain<wbr>User<wbr>Type</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">to<wbr>Domain<wbr>User<wbr>Type<span class="tsd-signature-symbol">(</span>typeStr<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><a href="../enums/users_and_identity.domainusertype.html" class="tsd-signature-type">DomainUserType</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Validates a string value is a proper DomainUserType string
and returns it. Otherwise will throw and error.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>typeStr: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The type string to validate.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../enums/users_and_identity.domainusertype.html" class="tsd-signature-type">DomainUserType</a></h4>
<p>A valid DomainUserType string.</p>
</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>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="current 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 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="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="users_and_identity.domainuser.html" class="tsd-kind-icon">Domain<wbr>User</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-module">
<a href="users_and_identity.domainuserid.html" class="tsd-kind-icon">Domain<wbr>User<wbr>Id</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="users_and_identity.domainuserid.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="users_and_identity.domainuserid.html#usertype" class="tsd-kind-icon">user<wbr>Type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="users_and_identity.domainuserid.html#username" class="tsd-kind-icon">username</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="users_and_identity.domainuserid.html#equals" class="tsd-kind-icon">equals</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="users_and_identity.domainuserid.html#toguid" class="tsd-kind-icon">to<wbr>Guid</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="users_and_identity.domainuserid.html#anonymous" class="tsd-kind-icon">anonymous</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="users_and_identity.domainuserid.html#convergence" class="tsd-kind-icon">convergence</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="users_and_identity.domainuserid.html#fromguid" class="tsd-kind-icon">from<wbr>Guid</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="users_and_identity.domainuserid.html#guid" class="tsd-kind-icon">guid</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="users_and_identity.domainuserid.html#normal" class="tsd-kind-icon">normal</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="users_and_identity.domainuserid.html#of" class="tsd-kind-icon">of</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="users_and_identity.domainuserid.html#todomainuserid" class="tsd-kind-icon">to<wbr>Domain<wbr>User<wbr>Id</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="users_and_identity.domainuserid.html#todomainusertype" class="tsd-kind-icon">to<wbr>Domain<wbr>User<wbr>Type</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter">
<a href="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="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="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="../modules/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="../modules/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="../modules/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>