@convergence/convergence

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>AbstractPermissionManager | 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="abstractpermissionmanager.html">AbstractPermissionManager</a> </li> </ul> <h1>Class AbstractPermissionManager<T></h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-type-parameters"> <h3>Type parameters</h3> <ul class="tsd-type-parameters"> <li> <h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">AbstractPermissionManager</span> <ul class="tsd-hierarchy"> <li> <a href="activities.activitypermissionmanager.html" class="tsd-signature-type">ActivityPermissionManager</a> </li> <li> <a href="chat.chatpermissionmanager.html" class="tsd-signature-type">ChatPermissionManager</a> </li> </ul> </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>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class"><a href="abstractpermissionmanager.html#addgrouppermissions" class="tsd-kind-icon">add<wbr>Group<wbr>Permissions</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="abstractpermissionmanager.html#adduserpermissions" class="tsd-kind-icon">add<wbr>User<wbr>Permissions</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="abstractpermissionmanager.html#addworldpermissions" class="tsd-kind-icon">add<wbr>World<wbr>Permissions</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="abstractpermissionmanager.html#getallgrouppermissions" class="tsd-kind-icon">get<wbr>All<wbr>Group<wbr>Permissions</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="abstractpermissionmanager.html#getalluserpermissions" class="tsd-kind-icon">get<wbr>All<wbr>User<wbr>Permissions</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="abstractpermissionmanager.html#getgrouppermissions" class="tsd-kind-icon">get<wbr>Group<wbr>Permissions</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="abstractpermissionmanager.html#getpermissions" class="tsd-kind-icon">get<wbr>Permissions</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="abstractpermissionmanager.html#getuserpermissions" class="tsd-kind-icon">get<wbr>User<wbr>Permissions</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="abstractpermissionmanager.html#getworldpermissions" class="tsd-kind-icon">get<wbr>World<wbr>Permissions</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="abstractpermissionmanager.html#removegrouppermissions" class="tsd-kind-icon">remove<wbr>Group<wbr>Permissions</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="abstractpermissionmanager.html#removeuserpermissions" class="tsd-kind-icon">remove<wbr>User<wbr>Permissions</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="abstractpermissionmanager.html#removeworldpermissions" class="tsd-kind-icon">remove<wbr>World<wbr>Permissions</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="abstractpermissionmanager.html#resolvesessionpermissions" class="tsd-kind-icon">resolve<wbr>Session<wbr>Permissions</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="abstractpermissionmanager.html#setgrouppermissions" class="tsd-kind-icon">set<wbr>Group<wbr>Permissions</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="abstractpermissionmanager.html#setuserpermissions" class="tsd-kind-icon">set<wbr>User<wbr>Permissions</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="abstractpermissionmanager.html#setworldpermissions" class="tsd-kind-icon">set<wbr>World<wbr>Permissions</a></li> </ul> </section> </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="addgrouppermissions" class="tsd-anchor"></a> <h3>add<wbr>Group<wbr>Permissions</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">add<wbr>Group<wbr>Permissions<span class="tsd-signature-symbol">(</span>permissions<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">Set</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-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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>Adds the given permissions to any existing permissions for all given groups.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>permissions: <a href="../globals.html#stringmaplike" class="tsd-signature-type">StringMapLike</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Set</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-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"> <p> an object, mapping group Ids to an set of desired permission strings to be added</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> <p> A resolved promise if successful</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="adduserpermissions" class="tsd-anchor"></a> <h3>add<wbr>User<wbr>Permissions</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">add<wbr>User<wbr>Permissions<span class="tsd-signature-symbol">(</span>permissions<span class="tsd-signature-symbol">: </span><a href="../modules/users_and_identity.html#domainusermapping" class="tsd-signature-type">DomainUserMapping</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Set</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-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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>Adds the given permissions to any existing permissions for all given users.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>permissions: <a href="../modules/users_and_identity.html#domainusermapping" class="tsd-signature-type">DomainUserMapping</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Set</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-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"> <p> an object, mapping usernames to an set of desired permission strings to be added</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> <p> A resolved promise if successful</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="addworldpermissions" class="tsd-anchor"></a> <h3>add<wbr>World<wbr>Permissions</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">add<wbr>World<wbr>Permissions<span class="tsd-signature-symbol">(</span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Set</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-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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>Adds the given permissions to any existing WORLD permissions.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>permissions: <span class="tsd-signature-type">Set</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-type">T</span><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"> <p>an set of permission strings</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> <p> A resolved promise if successful</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getallgrouppermissions" class="tsd-anchor"></a> <h3>get<wbr>All<wbr>Group<wbr>Permissions</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>All<wbr>Group<wbr>Permissions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><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">Set</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></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 the permissions for all groups.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><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">Set</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></h4> <p> A promise, which resolves with a map of permission strings per group ID.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getalluserpermissions" class="tsd-anchor"></a> <h3>get<wbr>All<wbr>User<wbr>Permissions</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>All<wbr>User<wbr>Permissions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="users_and_identity.domainuseridmap.html" class="tsd-signature-type">DomainUserIdMap</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Set</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></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 the permissions for all users.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="users_and_identity.domainuseridmap.html" class="tsd-signature-type">DomainUserIdMap</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Set</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></h4> <p> A promise, which resolves with a map of permission strings per username.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getgrouppermissions" class="tsd-anchor"></a> <h3>get<wbr>Group<wbr>Permissions</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Group<wbr>Permissions<span class="tsd-signature-symbol">(</span>groupId<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">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Set</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></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 the permissions for the given group.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>groupId: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>an existing group ID</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Set</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></h4> <p> A promise, which resolves with an set of permission strings</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getpermissions" class="tsd-anchor"></a> <h3>get<wbr>Permissions</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Permissions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/iallpermissions.html" class="tsd-signature-type">IAllPermissions</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></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/iallpermissions.html" class="tsd-signature-type">IAllPermissions</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></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getuserpermissions" class="tsd-anchor"></a> <h3>get<wbr>User<wbr>Permissions</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>User<wbr>Permissions<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><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Set</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></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 the permissions for the given user.</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>an existing user's username</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Set</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></h4> <p> A promise, which resolves with an set of permission strings</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getworldpermissions" class="tsd-anchor"></a> <h3>get<wbr>World<wbr>Permissions</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>World<wbr>Permissions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Set</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></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 the permissions for WORLD.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Set</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></h4> <p> A promise, which resolves with an set of permission strings</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="removegrouppermissions" class="tsd-anchor"></a> <h3>remove<wbr>Group<wbr>Permissions</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">remove<wbr>Group<wbr>Permissions<span class="tsd-signature-symbol">(</span>permissions<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">Set</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-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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>Removes the given permissions from any of the provided groups' permissions for this <a href="../interfaces/chat.ichatevent.html#chatid">chatId</a>.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>permissions: <a href="../globals.html#stringmaplike" class="tsd-signature-type">StringMapLike</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Set</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-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"> <p> An object, mapping group IDs to an set of desired permission strings to be removed</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> <p> A resolved promise if successful</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="removeuserpermissions" class="tsd-anchor"></a> <h3>remove<wbr>User<wbr>Permissions</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">remove<wbr>User<wbr>Permissions<span class="tsd-signature-symbol">(</span>permissions<span class="tsd-signature-symbol">: </span><a href="../modules/users_and_identity.html#domainusermapping" class="tsd-signature-type">DomainUserMapping</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Set</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-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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>Removes the given permissions from any of the provided users' permissions for this <a href="../interfaces/chat.ichatevent.html#chatid">chatId</a>.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>permissions: <a href="../modules/users_and_identity.html#domainusermapping" class="tsd-signature-type">DomainUserMapping</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Set</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-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"> <p> An object, mapping usernames to an set of desired permission strings to be removed</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> <p> A resolved promise if successful</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="removeworldpermissions" class="tsd-anchor"></a> <h3>remove<wbr>World<wbr>Permissions</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">remove<wbr>World<wbr>Permissions<span class="tsd-signature-symbol">(</span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Set</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-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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>Removes the given permissions from any existing WORLD permissions.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>permissions: <span class="tsd-signature-type">Set</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-type">T</span><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"> <p>an set of permission strings</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> <p> A resolved promise if successful</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="resolvesessionpermissions" class="tsd-anchor"></a> <h3>resolve<wbr>Session<wbr>Permissions</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">resolve<wbr>Session<wbr>Permissions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Set</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></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 the <em>resolved</em> permissions for the current user for this target. Resolved means computed from the set of any relevant <code>world</code>, <code>group</code> or <code>user</code> permissions.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Set</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></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="setgrouppermissions" class="tsd-anchor"></a> <h3>set<wbr>Group<wbr>Permissions</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">set<wbr>Group<wbr>Permissions<span class="tsd-signature-symbol">(</span>permissions<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">Set</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-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span>, replaceAll<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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>Sets the given permissions for the given groups.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>permissions: <a href="../globals.html#stringmaplike" class="tsd-signature-type">StringMapLike</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Set</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-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"> <p> an object which maps one or more group IDs to their new set of permissions</p> </div> </li> <li> <h5>replaceAll: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5> <div class="tsd-comment tsd-typography"> <p> Determines if the map passed in represents the entire set of group permissions to set. All permissions for other groups will be removed. The default is false.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> <p> A resolved promise if successful</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="setuserpermissions" class="tsd-anchor"></a> <h3>set<wbr>User<wbr>Permissions</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">set<wbr>User<wbr>Permissions<span class="tsd-signature-symbol">(</span>permissions<span class="tsd-signature-symbol">: </span><a href="../modules/users_and_identity.html#domainusermapping" class="tsd-signature-type">DomainUserMapping</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Set</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-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span>, replaceAll<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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>Sets the given permissions for the given users</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>permissions: <a href="../modules/users_and_identity.html#domainusermapping" class="tsd-signature-type">DomainUserMapping</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Set</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-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"> <p> an object which maps one or more usernames to their new set of permissions</p> </div> </li> <li> <h5>replaceAll: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5> <div class="tsd-comment tsd-typography"> <p> Determines if the map passed in represents the entire set of user permissions to set. All permissions for other user will be removed. The default is false.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> <p> A resolved promise if successful</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="setworldpermissions" class="tsd-anchor"></a> <h3>set<wbr>World<wbr>Permissions</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">set<wbr>World<wbr>Permissions<span class="tsd-signature-symbol">(</span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Set</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-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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>Sets the given permissions for WORLD.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>permissions: <span class="tsd-signature-type">Set</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-type">T</span><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"> <p>an set of permission strings</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> <p> A resolved promise if successful</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=" 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> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-has-type-parameter"> <a href="abstractpermissionmanager.html" class="tsd-kind-icon">Abstract<wbr>Permission<wbr>Manager</a> <ul> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="abstractpermissionmanager.html#addgrouppermissions" class="tsd-kind-icon">add<wbr>Group<wbr>Permissions</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="abstractpermissionmanager.html#adduserpermissions" class="tsd-kind-icon">add<wbr>User<wbr>Permissions</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="abstractpermissionmanager.html#addworldpermissions" class="tsd-kind-icon">add<wbr>World<wbr>Permissions</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="abstractpermissionmanager.html#getallgrouppermissions" class="tsd-kind-icon">get<wbr>All<wbr>Group<wbr>Permissions</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="abstractpermissionmanager.html#getalluserpermissions" class="tsd-kind-icon">get<wbr>All<wbr>User<wbr>Permissions</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="abstractpermissionmanager.html#getgrouppermissions" class="tsd-kind-icon">get<wbr>Group<wbr>Permissions</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="abstractpermissionmanager.html#getpermissions" class="tsd-kind-icon">get<wbr>Permissions</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="abstractpermissionmanager.html#getuserpermissions" class="tsd-kind-icon">get<wbr>User<wbr>Permissions</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="abstractpermissionmanager.html#getworldpermissions" class="tsd-kind-icon">get<wbr>World<wbr>Permissions</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="abstractpermissionmanager.html#removegrouppermissions" class="tsd-kind-icon">remove<wbr>Group<wbr>Permissions</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="abstractpermissionmanager.html#removeuserpermissions" class="tsd-kind-icon">remove<wbr>User<wbr>Permissions</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="abstractpermissionmanager.html#removeworldpermissions" class="tsd-kind-icon">remove<wbr>World<wbr>Permissions</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="abstractpermissionmanager.html#resolvesessionpermissions" class="tsd-kind-icon">resolve<wbr>Session<wbr>Permissions</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="abstractpermissionmanager.html#setgrouppermissions" class="tsd-kind-icon">set<wbr>Group<wbr>Permissions</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="abstractpermissionmanager.html#setuserpermissions" class="tsd-kind-icon">set<wbr>User<wbr>Permissions</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="abstractpermissionmanager.html#setworldpermissions" class="tsd-kind-icon">set<wbr>World<wbr>Permissions</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-class"> <a href="convergence.html" class="tsd-kind-icon">Convergence</a> </li> <li class=" tsd-kind-class"> <a href="convergencedomain.html" class="tsd-kind-icon">Convergence<wbr>Domain</a> </li> <li class=" tsd-kind-class"> <a href="convergenceerror.html" class="tsd-kind-icon">Convergence<wbr>Error</a> </li> <li class=" tsd-kind-class tsd-has-type-parameter"> <a href="convergenceeventemitter.html" class="tsd-kind-icon">Convergence<wbr>Event<wbr>Emitter</a> </li> <li class=" tsd-kind-class"> <a href="convergenceservererror.html" class="tsd-kind-icon">Convergence<wbr>Server<wbr>Error</a> </li> <li class=" tsd-kind-class"> <a href="errorevent.html" class="tsd-kind-icon">Error<wbr>Event</a> </li> <li class=" tsd-kind-class tsd-has-type-parameter"> <a href="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="../interf