playbasis
Version:
Playbasis Javascript SDK
3,515 lines (1,106 loc) • 43 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>Documentation Namespace: storeOrganizeApi</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top ">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand" href="index.html">Documentation</a>
<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<div class="navbar-collapse collapse" id="topNavigation">
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="Playbasis.html">Playbasis</a></li><li><a href="Playbasis.authApi.html">Playbasis.authApi</a></li><li><a href="Playbasis.badgeApi.html">Playbasis.badgeApi</a></li><li><a href="Playbasis.barCode.html">Playbasis.barCode</a></li><li><a href="Playbasis.builder.html">Playbasis.builder</a></li><li><a href="Playbasis.communicationApi.html">Playbasis.communicationApi</a></li><li><a href="Playbasis.const.html">Playbasis.const</a></li><li><a href="Playbasis.contentApi.html">Playbasis.contentApi</a></li><li><a href="Playbasis.engineApi.html">Playbasis.engineApi</a></li><li><a href="Playbasis.goodsApi.html">Playbasis.goodsApi</a></li><li><a href="Playbasis.helpers.html">Playbasis.helpers</a></li><li><a href="Playbasis.http.html">Playbasis.http</a></li><li><a href="Playbasis.livefeedApi.html">Playbasis.livefeedApi</a></li><li><a href="Playbasis.merchantApi.html">Playbasis.merchantApi</a></li><li><a href="Playbasis.playerApi.html">Playbasis.playerApi</a></li><li><a href="Playbasis.pointApi.html">Playbasis.pointApi</a></li><li><a href="Playbasis.qrCode.html">Playbasis.qrCode</a></li><li><a href="Playbasis.questApi.html">Playbasis.questApi</a></li><li><a href="Playbasis.quizApi.html">Playbasis.quizApi</a></li><li><a href="Playbasis.redeemApi.html">Playbasis.redeemApi</a></li><li><a href="Playbasis.serviceApi.html">Playbasis.serviceApi</a></li><li><a href="Playbasis.storeOrganizeApi.html">Playbasis.storeOrganizeApi</a></li><li><a href="Playbasis.util.html">Playbasis.util</a></li>
</ul>
</li>
</ul>
<div class="col-sm-3 col-md-3">
<form class="navbar-form" role="search">
<div class="input-group">
<input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
<div class="input-group-btn">
<button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
</div>
</div>
</form>
</div>
</div>
</div>
</div>
<div class="container" id="toc-content">
<div class="row">
<div class="col-md-8">
<div id="main">
<h1 class="page-title">Namespace: storeOrganizeApi</h1>
<section>
<header>
<h2>
<span class="ancestors"><a href="Playbasis.html">Playbasis</a>.</span>
storeOrganizeApi
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Playbasis Store Organize API</p></div>
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<dl>
<hr>
<dt>
<h4 class="name" id=".addContentToNode"><span class="type-signature"><static> </span>addContentToNode(nodeId, contentNodeId)</h4>
</dt>
<dd>
<div class="description">
<p>Add content to specific node</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nodeId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>node id</p></td>
</tr>
<tr>
<td class="name"><code>contentNodeId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>node id of content</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Promise object</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".addPlayerToNode"><span class="type-signature"><static> </span>addPlayerToNode(nodeId, playerId)</h4>
</dt>
<dd>
<div class="description">
<p>Add player to specific node.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nodeId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>node id to add player</p></td>
</tr>
<tr>
<td class="name"><code>playerId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>player id</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Promise object</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".findChildNodes"><span class="type-signature"><static> </span>findChildNodes(nodeId, layer)</h4>
</dt>
<dd>
<div class="description">
<p>Find all child nodes under specific node.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nodeId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>node id to find child nodes</p></td>
</tr>
<tr>
<td class="name"><code>layer</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>layer of nodes under specific node to find. Set to 0 to find for all layers.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Promise object</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".listNodes"><span class="type-signature"><static> </span>listNodes(options)</h4>
</dt>
<dd>
<div class="description">
<p>List nodes as set from admin dashboard.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(<strong>optional</strong>) options as object.<br>
It can include<br>
{<br>
<code>id</code>: <em>String</em> = node id to retrieve,<br>
<code>organize_id</code>: <em>String</em> = organize id,<br>
<code>search</code>: <em>String</em> = organize name to search,<br>
<code>sort</code>: <em>String</em> = field to be sorted "name" | "status" | "description" | "date_added" | "date_modified",<br>
<code>order</code>: <em>String</em> = "asc" | "desc",<br>
<code>offset</code>: <em>Number</em> = offset of returned records,<br>
<code>limit</code>: <em>Number</em> = number of returned records<br>
}</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Promise object</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".listOrganizations"><span class="type-signature"><static> </span>listOrganizations(options)</h4>
</dt>
<dd>
<div class="description">
<p>List organizations as set from admin dashboard.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(<strong>optional</strong>) options as object.<br>
It can include<br>
{<br>
<code>id</code>: <em>String</em> = organize id to retrieve,<br>
<code>search</code>: <em>String</em> = organize name to search,<br>
<code>sort</code>: <em>String</em> = field to be sorted "name" | "status" | "description" | "date_added" | "date_modified",<br>
<code>order</code>: <em>String</em> = "asc" | "desc",<br>
<code>offset</code>: <em>Number</em> = offset of returned records,<br>
<code>limit</code>: <em>Number</em> = number of returned records<br>
}</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Promise object</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".listPlayerFromNode"><span class="type-signature"><static> </span>listPlayerFromNode(nodeId, options)</h4>
</dt>
<dd>
<div class="description">
<p>Get player's list from specific node.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nodeId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>node id to get list of player from</p></td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(<strong>optional</strong>) options as object.<br>
It can include<br>
{<br>
<code>role</code>: <em>String</em> = role name to query<br>
}</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Promise object</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".peerLeaderboard"><span class="type-signature"><static> </span>peerLeaderboard(nodeId, rankBy, options)</h4>
</dt>
<dd>
<div class="description">
<p>Return leaderboard list for organization under given node id</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nodeId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>node id to return leaderboard from</p></td>
</tr>
<tr>
<td class="name"><code>rankBy</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>name of point-based reward to rank players by</p></td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(<strong>optional</strong>) options as object.<br>
It can include<br>
{<br>
<code>page</code>: <em>Number</em> = select page to be reported, page 0 is the first page. Default is 0.<br>
<code>limit</code>: <em>Number</em> = number of results to return. Default is 20.<br>
<code>under_org</code>: <em>String</em> = "true" to return rank of organize under given node_id | "false" to rank associate with given node_id<br>
<code>role</code>: <em>String</em> = role to be filtered<br>
<code>player_id</code>: <em>String</em> = player id to return his/her own rank<br>
<code>month</code>: <em>String</em> = month to rank players by which can be "01" | "02" | ... | "12"<br>
<code>year</code>: <em>String</em> = year to rank players by i.e. "2015"<br>
}</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Promise object</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".peerLeaderboardByAction"><span class="type-signature"><static> </span>peerLeaderboardByAction(nodeId, action, parameter, options)</h4>
</dt>
<dd>
<div class="description">
<p>Return leaderboard list for organization under given node id ranking according to action name.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nodeId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>node id to return leaderboard from</p></td>
</tr>
<tr>
<td class="name"><code>action</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>action name to rank players</p></td>
</tr>
<tr>
<td class="name"><code>parameter</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>name of parameter of action to rank players by</p></td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(<strong>optional</strong>) options as object.<br>
It can include<br>
{<br>
<code>page</code>: <em>Number</em> = select page to be reported, page 0 is the first page. Default is 0.<br>
<code>limit</code>: <em>Number</em> = number of results to return. Default is 20.<br>
<code>role</code>: <em>String</em> = role to be filtered<br>
<code>player_id</code>: <em>String</em> = player id to return his/her own rank<br>
<code>month</code>: <em>String</em> = month to rank players by which can be "01" | "02" | ... | "12"<br>
<code>year</code>: <em>String</em> = year to rank players by i.e. "2015"
}</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Promise object</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".removeContentFromNode"><span class="type-signature"><static> </span>removeContentFromNode(nodeId, contentNodeId)</h4>
</dt>
<dd>
<div class="description">
<p>Remove content from specific node</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nodeId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>node id</p></td>
</tr>
<tr>
<td class="name"><code>contentNodeId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>node id of content</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Promise object</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".removePlayerFromNode"><span class="type-signature"><static> </span>removePlayerFromNode(nodeId, playerId)</h4>
</dt>
<dd>
<div class="description">
<p>Remove player from node.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nodeId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>node id to remove player from</p></td>
</tr>
<tr>
<td class="name"><code>playerId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>player id</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Promise object</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".saleBoard"><span class="type-signature"><static> </span>saleBoard(nodeId, layer, options)</h4>
</dt>
<dd>
<div class="description">
<p>Leaderboard by sale amount of all nodes under specific node.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nodeId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>node id to find child nodes</p></td>
</tr>
<tr>
<td class="name"><code>layer</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>layer of nodes under specific node to find. Set to 0 for finding all layers.</p></td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(<strong>optional</strong>) options as object.<br>
It can include<br>
{<br>
<code>month</code>: <em>String</em> = month to get sale report ex. "01" | "02" | ... | "12". Default is current month.<br>
<code>year</code>: <em>String</em> = year to get sale report ex. "2015"<br>
<code>action</code>: <em>String</em> = action name to query from action log<br>
<code>parameter</code>: <em>String</em> = parameter to report from action log<br>
<code>page</code>: <em>Number</em> = select page to be reported, page 0 is the first page. Default is 0.<br>
<code>limit</code>: <em>Number</em> = limit per page to be reported. Default is 20.<br>
}</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Promise object</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".saleHistory"><span class="type-signature"><static> </span>saleHistory(nodeId, count, options)</h4>
</dt>
<dd>
<div class="description">
<p>Sale report of specific node.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nodeId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>node id to get sale report from</p></td>
</tr>
<tr>
<td class="name"><code>count</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>number of month to get report</p></td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(<strong>optional</strong>) options as object.<br>
It can include<br>
{<br>
<code>month</code>: <em>String</em> = month to get sale report ex. "01" | "02" | ... | "12". Default is current month.<br>
<code>year</code>: <em>String</em> = year to get sale report ex. "2015"<br>
<code>action</code>: <em>String</em> = action name to query from action log<br>
<code>parameter</code>: <em>String</em> = parameter to report from action log<br>
}</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Promise object</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".saleReport"><span class="type-signature"><static> </span>saleReport(nodeId, options)</h4>
</dt>
<dd>
<div class="description">
<p>Sale report of specific node in a month</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nodeId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>node id to return sale report from</p></td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(<strong>optional</strong>) options as object.<br>
It can include<br>
{<br>
<code>month</code>: <em>String</em> = month to get sale report ex. "01" | "02" | ... | "12". Default is current month.<br>
<code>year</code>: <em>String</em> = year to get sale report ex. "2015"<br>
<code>action</code>: <em>String</em> = action name to query from action log<br>
<code>parameter</code>: <em>String</em> = parameter to report from action log<br>
}</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Promise object</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".setContentRole"><span class="type-signature"><static> </span>setContentRole(nodeId, contentNodeId, role)</h4>
</dt>
<dd>
<div class="description">
<p>Set content's organization role to specific node.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nodeId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>node id to set role</p></td>
</tr>
<tr>
<td class="name"><code>contentNodeId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>node id of content</p></td>
</tr>
<tr>
<td class="name"><code>role</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>role to set to content</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Promise object</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".setPlayerRole"><span class="type-signature"><static> </span>setPlayerRole(nodeId, playerId, role)</h4>
</dt>
<dd>
<div class="description">
<p>Set player's organization role to specific node.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nodeId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>node id</p></td>
</tr>
<tr>
<td class="name"><code>playerId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>player id to set role</p></td>
</tr>
<tr>
<td class="name"><code>role</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>role name to set player's role</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Promise object</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".unsetContentRole"><span class="type-signature"><static> </span>unsetContentRole(nodeId, contentNodeId, role)</h4>
</dt>
<dd>
<div class="description">
<p>Unset content's organization role to specific node.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nodeId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>node id to set role</p></td>
</tr>
<tr>
<td class="name"><code>contentNodeId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>node id of content</p></td>
</tr>
<tr>
<td class="name"><code>role</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>role to set to content</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Promise object</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".unsetPlayerRole"><span class="type-signature"><static> </span>unsetPlayerRole(nodeId, playerId, role)</h4>
</dt>
<dd>
<div class="description">
<p>Unset player's organization role from specific node.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nodeId</code></td>
<td class="type">
<span class="param-type">Strinh</span>
</td>
<td class="description last"><p>node id</p></td>
</tr>
<tr>
<td class="name"><code>playerId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>player id to unset role from</p></td>
</tr>
<tr>
<td class="name"><code>role</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>role name to unset player's role</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Promise object</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
</div>
<div class="clearfix"></div>
<div class="col-md-3">
<div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
</div>
</div>
</div>
<div class="modal fade" id="searchResults">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
<h4 class="modal-title">Search results</h4>
</div>
<div class="modal-body"></div>
<div class="modal-footer">
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
</div>
</div><!-- /.modal-content -->
</div><!-- /.modal-dialog -->
</div>
<footer>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a>
on August 23rd 2019, 1:59:06 pm
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
</footer>
<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/toc.js"></script>
<script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
<script>
$( function () {
$( "[id*='$']" ).each( function () {
var $this = $( this );
$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
} );
$( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
var $this = $( this );
var example = $this.find( "code" );
exampleText = example.html();
var lang = /{@lang (.*?)}/.exec( exampleText );
if ( lang && lang[1] ) {
exampleText = exampleText.replace( lang[0], "" );
example.html( exampleText );
lang = lang[1];
} else {
var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
lang = langClassMatch ? langClassMatch[1] : "javascript";
}
if ( lang ) {
$this
.addClass( "sunlight-highlight-" + lang )
.addClass( "linenums" )
.html( example.html() );
}
} );
Sunlight.highlightAll( {
lineNumbers : true,
showMenu : true,
enableDoclinks : true
} );
$.catchAnchorLinks( {
navbarOffset: 10
} );
$( "#toc" ).toc( {
anchorName : function ( i, heading, prefix ) {
return $( heading ).attr( "id" ) || ( prefix + i );
},
selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
showAndHide : false,
smoothScrolling: true
} );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
$( '.dropdown-toggle' ).dropdown();
$( "table" ).each( function () {
var $this = $( this );
$this.addClass('table');
} );
} );
</script>
<!--Navigation and Symbol Display-->
<!--Google Analytics-->
<script type="text/javascript">
$(document).ready(function() {
SearcherDisplay.init();
});
</script>
</body>
</html>