playbasis
Version:
Playbasis Javascript SDK
4,884 lines (1,396 loc) • 80.2 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>Documentation Namespace: playerApi</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: playerApi</h1>
<section>
<header>
<h2>
<span class="ancestors"><a href="Playbasis.html">Playbasis</a>.</span>
playerApi
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Playbasis Player API</p></div>
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<dl>
<hr>
<dt>
<h4 class="name" id=".actionCount"><span class="type-signature"><static> </span>actionCount(playerId, actionName)</h4>
</dt>
<dd>
<div class="description">
<p>Returns the number of times that a player has performed the specified action.</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>playerId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>player id</p></td>
</tr>
<tr>
<td class="name"><code>actionName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>name of the action to query</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=".actionTime"><span class="type-signature"><static> </span>actionTime(playerId, actionName)</h4>
</dt>
<dd>
<div class="description">
<p>Return the last time that player has performed the specified action.</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>playerId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>player id</p></td>
</tr>
<tr>
<td class="name"><code>actionName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>name of action to query</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=".allBadges"><span class="type-signature"><static> </span>allBadges(playerId, options)</h4>
</dt>
<dd>
<div class="description">
<p>Return information about all the badges of the client as well as the amount that a player may earn.</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>playerId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>player id</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>
{
<code>tags</code>: <em>String</em> = specific tags to find, each tag delimited by comma i.e. foo,bar<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=".allQuestsOfPlayer"><span class="type-signature"><static> </span>allQuestsOfPlayer(playerId)</h4>
</dt>
<dd>
<div class="description">
<p>Return list of all available quests of the client as well as the status of the player if joined.</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>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=".badge"><span class="type-signature"><static> </span>badge(playerId, options)</h4>
</dt>
<dd>
<div class="description">
<p>Return information about all the badges that a player has earned.</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>playerId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>player id</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>tags</code>: <em>String</em> = specific tags to find, each tag delimited by comma i.e. foo,bar<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=".deductBadge"><span class="type-signature"><static> </span>deductBadge(playerId, badge, amount, options)</h4>
</dt>
<dd>
<div class="description">
<p>Deduct a badge from a given player.</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>playerId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>player id</p></td>
</tr>
<tr>
<td class="name"><code>badge</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>name of badge to deduct</p></td>
</tr>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>amount to deduct</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>force</code>: <em>Number</em> = 0 for not force if player has not enough badge to deduct | 1 = force to do the deduct (and player's badge becomes zero)<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=".deductReward"><span class="type-signature"><static> </span>deductReward(playerId, reward, amount, options)</h4>
</dt>
<dd>
<div class="description">
<p>Deduct a reward from player</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>playerId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>player id</p></td>
</tr>
<tr>
<td class="name"><code>reward</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>reward name to deduct from player</p></td>
</tr>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>amount of reward to deduct</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>force</code>: <em>Number</em> = 0 for not force if player has not enough reward to deduct | 1 = force to do the deduct (and player's reward becomes zero)<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=".delete"><span class="type-signature"><static> </span>delete(playerId)</h4>
</dt>
<dd>
<div class="description">
<p>Permanently delete player from Playbasis database.</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>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=".favoriteGoods"><span class="type-signature"><static> </span>favoriteGoods(playerId, goodsId, status)</h4>
</dt>
<dd>
<div class="description">
<p>Set specific goods in player's inventory as favorite</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>playerId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>player id</p></td>
</tr>
<tr>
<td class="name"><code>goodsId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>goods id to set favorite status</p></td>
</tr>
<tr>
<td class="name"><code>status</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last"><p>status to set. It can be either <code>true</code> or <code>false</code></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=".findPlayerBySession"><span class="type-signature"><static> </span>findPlayerBySession(sessionId)</h4>
</dt>
<dd>
<div class="description">
<p>Find a player by given session 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>sessionId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>session 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=".giveGift"><span class="type-signature"><static> </span>giveGift(sentPlayerId, receivedPlayerId, giftId, type, amount)</h4>
</dt>
<dd>
<div class="description">
<p>Give gift item from player to player.</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>sentPlayerId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>player id that send the gift</p></td>
</tr>
<tr>
<td class="name"><code>receivedPlayerId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>player id that received the gift</p></td>
</tr>
<tr>
<td class="name"><code>giftId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>gift id can be badge id, goods id , custom point id</p></td>
</tr>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>type of gift, the value can be "badge" | "custom_point" | "goods"</p></td>
</tr>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>amount of gift to be sent to received player</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=".goods"><span class="type-signature"><static> </span>goods(playerId, options)</h4>
</dt>
<dd>
<div class="description">
<p>Returns information about all the goods list that a player has redeem.</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>playerId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>player id</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>tags</code>: <em>String</em> = tag to query separated by comma,<br>
<code>status</code>: <em>String</em> = "all" | "active" | "expired" | "used". Default is "active".<br>
}.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".goodsCount"><span class="type-signature"><static> </span>goodsCount(playerId, options)</h4>
</dt>
<dd>
<div class="description">
<p>Returns information about number of goods that player has</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>playerId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>player id</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>tags</code>: <em>String</em> = goods tag to query separated by comma,<br>
<code>status</code>: <em>String</em> = "all" | "active" | "expired" | "used". Default is "active".<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=".lastAction"><span class="type-signature"><static> </span>lastAction(playerId)</h4>
</dt>
<dd>
<div class="description">
<p>Return the time and action that a player last performed.</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>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=".level"><span class="type-signature"><static> </span>level(level)</h4>
</dt>
<dd>
<div class="description">
<p>Return detail of level</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>level</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>numbe of level</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=".levels"><span class="type-signature"><static> </span>levels()</h4>
</dt>
<dd>
<div class="description">
<p>Return all detail of level.</p>
</div>
<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=".listActivePlayerSessions"><span class="type-signature"><static> </span>listActivePlayerSessions(playerId)</h4>
</dt>
<dd>
<div class="description">
<p>List active sessions of a player in Playbasis system.</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>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=".listCustomFieldsOfPlayer"><span class="type-signature"><static> </span>listCustomFieldsOfPlayer(playerId)</h4>
</dt>
<dd>
<div class="description">
<p>Get custom fields information about a player.</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>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=".listPlayer"><span class="type-signature"><static> </span>listPlayer(playerIdArray)</h4>
</dt>
<dd>
<div class="description">
<p>Get basic information of players</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>playerIdArray</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>array of player id String</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=".login"><span class="type-signature"><static> </span>login(playerId)</h4>
</dt>
<dd>
<div class="description">
<p>Tell Playbasis system that a player has logged in.</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>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=".logout"><span class="type-signature"><static> </span>logout(playerId)</h4>
</dt>
<dd>
<div class="description">
<p>Tell Playbasis system that a player has logged out.</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>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=".performOTPVerification"><span class="type-signature"><static> </span>performOTPVerification(playerId, OTPcode)</h4>
</dt>
<dd>
<div class="description">
<p>Perform OTP verification from code that has sent to player SMS.</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>playerId</code></td>
<td class="type">
<span class="param-type">Stirng</span>
</td>
<td class="description last"><p>player id</p></td>
</tr>
<tr>
<td class="name"><code>OTPcode</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>OTP code as sent to player</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=".playerDetailedInfo"><span class="type-signature"><static> </span>playerDetailedInfo(playerId)</h4>
</dt>
<dd>
<div class="description">
<p>Get detailed public and private information about player, including points and badges.</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>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=".playerDetailedPublicInfo"><span class="type-signature"><static> </span>playerDetailedPublicInfo(playerId)</h4>
</dt>
<dd>
<div class="description">
<p>Get detailed public information about player, including points and badges.</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>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=".playerInfo"><span class="type-signature"><static> </span>playerInfo(playerId)</h4>
</dt>
<dd>
<div class="description">
<p>Get public and private information about a player.</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>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=".playerPublicInfo"><span class="type-signature"><static> </span>playerPublicInfo(playerId)</h4>
</dt>
<dd>
<div class="description">
<p>Get public information about player.</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>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=".playerReferralCode"><span class="type-signature"><static> </span>playerReferralCode(playerId)</h4>
</dt>
<dd>
<div class="description">
<p>Return generated referral code of player.</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>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=".point"><span class="type-signature"><static> </span>point(playerId, pointName)</h4>
</dt>
<dd>
<div class="description">
<p>Returns how much of specified the point-based reward a player currently has.</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>playerId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>player id</p></td>
</tr>
<tr>
<td class="name"><code>pointName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>name of point-based reward to query</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=".pointHistory"><span class="type-signature"><static> </span>pointHistory(playerId, options)</h4>
</dt>
<dd>
<div class="description">
<p>Returns history points of player</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 clas