ca-mas-foundation-cordova
Version:
Cordova MAS Plugin
8,835 lines • 115 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Global</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Global</h1>
<section>
<header>
<h2></h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="active"><span class="type-signature"></span>active<span class="type-signature"> :bool</span></h4>
<div class="description">
Checks if the user is active
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">bool</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginUser.js.html">MASPluginUser.js</a>, <a href="MASPluginUser.js.html#line73">line 73</a>
</li></ul></dd>
</dl>
<h4 class="name" id="addresses"><span class="type-signature"></span>addresses<span class="type-signature"> :array</span></h4>
<div class="description">
Lists of the addresses of the user
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">array</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginUser.js.html">MASPluginUser.js</a>, <a href="MASPluginUser.js.html#line55">line 55</a>
</li></ul></dd>
</dl>
<h4 class="name" id="emailAddresses"><span class="type-signature"></span>emailAddresses<span class="type-signature"> :array</span></h4>
<div class="description">
Lists of the email addresses of the user
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">array</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginUser.js.html">MASPluginUser.js</a>, <a href="MASPluginUser.js.html#line43">line 43</a>
</li></ul></dd>
</dl>
<h4 class="name" id="familyName"><span class="type-signature"></span>familyName<span class="type-signature"> :string</span></h4>
<div class="description">
The family name of the user
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginUser.js.html">MASPluginUser.js</a>, <a href="MASPluginUser.js.html#line25">line 25</a>
</li></ul></dd>
</dl>
<h4 class="name" id="formattedName"><span class="type-signature"></span>formattedName<span class="type-signature"> :string</span></h4>
<div class="description">
The formatted name of the user
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginUser.js.html">MASPluginUser.js</a>, <a href="MASPluginUser.js.html#line37">line 37</a>
</li></ul></dd>
</dl>
<h4 class="name" id="givenName"><span class="type-signature"></span>givenName<span class="type-signature"> :string</span></h4>
<div class="description">
The given name of the user
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginUser.js.html">MASPluginUser.js</a>, <a href="MASPluginUser.js.html#line31">line 31</a>
</li></ul></dd>
</dl>
<h4 class="name" id="groupName"><span class="type-signature"></span>groupName<span class="type-signature"> :string</span></h4>
<div class="description">
The name of the group
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginGroup.js.html">MASPluginGroup.js</a>, <a href="MASPluginGroup.js.html#line19">line 19</a>
</li></ul></dd>
</dl>
<h4 class="name" id="groups"><span class="type-signature"></span>groups<span class="type-signature"> :array</span></h4>
<div class="description">
List of the groups the user is a part of
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">array</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginUser.js.html">MASPluginUser.js</a>, <a href="MASPluginUser.js.html#line67">line 67</a>
</li></ul></dd>
</dl>
<h4 class="name" id="members"><span class="type-signature"></span>members<span class="type-signature"> :array</span></h4>
<div class="description">
Lists the members of the group
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">array</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginGroup.js.html">MASPluginGroup.js</a>, <a href="MASPluginGroup.js.html#line31">line 31</a>
</li></ul></dd>
</dl>
<h4 class="name" id="owner"><span class="type-signature"></span>owner<span class="type-signature"> :string</span></h4>
<div class="description">
The owner of the group
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginGroup.js.html">MASPluginGroup.js</a>, <a href="MASPluginGroup.js.html#line25">line 25</a>
</li></ul></dd>
</dl>
<h4 class="name" id="phoneNumbers"><span class="type-signature"></span>phoneNumbers<span class="type-signature"> :array</span></h4>
<div class="description">
Lists of the phone numbers of the user
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">array</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginUser.js.html">MASPluginUser.js</a>, <a href="MASPluginUser.js.html#line49">line 49</a>
</li></ul></dd>
</dl>
<h4 class="name" id="photos"><span class="type-signature"></span>photos<span class="type-signature"> :string</span></h4>
<div class="description">
Returns the base64 string of the user's photo
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginUser.js.html">MASPluginUser.js</a>, <a href="MASPluginUser.js.html#line61">line 61</a>
</li></ul></dd>
</dl>
<h4 class="name" id="userName"><span class="type-signature"></span>userName<span class="type-signature"> :string</span></h4>
<div class="description">
The username of the user
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginUser.js.html">MASPluginUser.js</a>, <a href="MASPluginUser.js.html#line19">line 19</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="authenticationStatus"><span class="type-signature"></span>authenticationStatus<span class="signature">(successHandler, errorHandler)</span><span class="type-signature"></span></h4>
<div class="description">
Returns the authentication status of the application
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginApplication.js.html">MASPluginApplication.js</a>, <a href="MASPluginApplication.js.html#line53">line 53</a>
</li></ul></dd>
</dl>
<h4 class="name" id="authorize"><span class="type-signature"></span>authorize<span class="signature">(successHandler, errorHandler, code)</span><span class="type-signature"></span></h4>
<div class="description">
Authorizes with a QR code
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
<tr>
<td class="name"><code>code</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">code extracted by the QR code scanner</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginMAS.js.html">MASPluginMAS.js</a>, <a href="MASPluginMAS.js.html#line617">line 617</a>
</li></ul></dd>
</dl>
<h4 class="name" id="cancelAuthentication"><span class="type-signature"></span>cancelAuthentication<span class="signature">(successHandler, errorHandler, args)</span><span class="type-signature"></span></h4>
<div class="description">
Cancels the current user's authentication session validation.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
<tr>
<td class="name"><code>args</code></td>
<td class="type">
</td>
<td class="description last">user defined variable which is request ID in Android. It is not used in iOS</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginMAS.js.html">MASPluginMAS.js</a>, <a href="MASPluginMAS.js.html#line321">line 321</a>
</li></ul></dd>
</dl>
<h4 class="name" id="cancelGenerateAndSendOTP"><span class="type-signature"></span>cancelGenerateAndSendOTP<span class="signature">(successHandler, errorHandler)</span><span class="type-signature"></span></h4>
<div class="description">
Cancels the current user's generating and sending OTP call.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginMAS.js.html">MASPluginMAS.js</a>, <a href="MASPluginMAS.js.html#line423">line 423</a>
</li></ul></dd>
</dl>
<h4 class="name" id="cancelOTPValidation"><span class="type-signature"></span>cancelOTPValidation<span class="signature">(successHandler, errorHandler)</span><span class="type-signature"></span></h4>
<div class="description">
Cancels the authentication validation session of the user
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginMAS.js.html">MASPluginMAS.js</a>, <a href="MASPluginMAS.js.html#line464">line 464</a>
</li></ul></dd>
</dl>
<h4 class="name" id="closePopup"><span class="type-signature"></span>closePopup<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Closes an existing popup.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginMAS.js.html">MASPluginMAS.js</a>, <a href="MASPluginMAS.js.html#line630">line 630</a>
</li></ul></dd>
</dl>
<h4 class="name" id="completeAuthentication"><span class="type-signature"></span>completeAuthentication<span class="signature">(successHandler, errorHandler, username, password)</span><span class="type-signature"></span></h4>
<div class="description">
Completes the current user's authentication session validation.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
<tr>
<td class="name"><code>username</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">user defined username</td>
</tr>
<tr>
<td class="name"><code>password</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">user defined password</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginMAS.js.html">MASPluginMAS.js</a>, <a href="MASPluginMAS.js.html#line226">line 226</a>
</li></ul></dd>
</dl>
<h4 class="name" id="configFileName"><span class="type-signature"></span>configFileName<span class="signature">(successHandler, errorHandler, fileName)</span><span class="type-signature"></span></h4>
<div class="description">
Sets the name of the configuration file. This gives the ability to set the file's name to a custom value.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
<tr>
<td class="name"><code>fileName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginMAS.js.html">MASPluginMAS.js</a>, <a href="MASPluginMAS.js.html#line165">line 165</a>
</li></ul></dd>
</dl>
<h4 class="name" id="deleteFromPath"><span class="type-signature"></span>deleteFromPath<span class="signature">(successHandler, errorHandler, path, parametersInfo, headersInfo, requestType, responseType)</span><span class="type-signature"></span></h4>
<div class="description">
Calls the HTTP DELTE method from the Gateway. It requires at least three mandatory parameters as shown in the below example. The requestType and responseType are the optional parameters. If the requestType and responseType are not present, then it is set to the default JSON type.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
<tr>
<td class="name"><code>path</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">URL path</td>
</tr>
<tr>
<td class="name"><code>parametersInfo</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">parameters to be passed along with the request</td>
</tr>
<tr>
<td class="name"><code>headersInfo</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">headers of the request</td>
</tr>
<tr>
<td class="name"><code>requestType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">specifies the request type of the request</td>
</tr>
<tr>
<td class="name"><code>responseType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">specifies the response type of the request</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginMAS.js.html">MASPluginMAS.js</a>, <a href="MASPluginMAS.js.html#line570">line 570</a>
</li></ul></dd>
</dl>
<h4 class="name" id="deregister"><span class="type-signature"></span>deregister<span class="signature">(successHandler, errorHandler)</span><span class="type-signature"></span></h4>
<div class="description">
Deregisters a device from MAG server i.e. remove all registration information of this device from server
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginDevice.js.html">MASPluginDevice.js</a>, <a href="MASPluginDevice.js.html#line55">line 55</a>
</li></ul></dd>
</dl>
<h4 class="name" id="gatewayIsReachable"><span class="type-signature"></span>gatewayIsReachable<span class="signature">(successHandler, errorHandler)</span><span class="type-signature"></span></h4>
<div class="description">
Checks whether the Gateway is reachable
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginMAS.js.html">MASPluginMAS.js</a>, <a href="MASPluginMAS.js.html#line534">line 534</a>
</li></ul></dd>
</dl>
<h4 class="name" id="generateAndSendOTP"><span class="type-signature"></span>generateAndSendOTP<span class="signature">(successHandler, errorHandler, channels)</span><span class="type-signature"></span></h4>
<div class="description">
Requests server to generate and send OTP to the channels provided.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
<tr>
<td class="name"><code>channels</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last">user defined variable which is an array of channels where the OTP is to be delivered.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginMAS.js.html">MASPluginMAS.js</a>, <a href="MASPluginMAS.js.html#line361">line 361</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getCurrentDevice"><span class="type-signature"></span>getCurrentDevice<span class="signature">(successHandler, errorHandler)</span><span class="type-signature"></span></h4>
<div class="description">
Fetches the device registration state and identifier as JSON string
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginDevice.js.html">MASPluginDevice.js</a>, <a href="MASPluginDevice.js.html#line45">line 45</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getCurrentProviders"><span class="type-signature"></span>getCurrentProviders<span class="signature">(successHandler, errorHandler)</span><span class="type-signature"></span></h4>
<div class="description">
Returns a list of available providers
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginAuthProviders.js.html">MASPluginAuthProviders.js</a>, <a href="MASPluginAuthProviders.js.html#line15">line 15</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getDeviceIdentifier"><span class="type-signature"></span>getDeviceIdentifier<span class="signature">(successHandler, errorHandler)</span><span class="type-signature"></span></h4>
<div class="description">
Fetches the device identifier registered in MAG server
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginDevice.js.html">MASPluginDevice.js</a>, <a href="MASPluginDevice.js.html#line30">line 30</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getFromPath"><span class="type-signature"></span>getFromPath<span class="signature">(successHandler, errorHandler, path, parametersInfo, headersInfo, requestType, responseType)</span><span class="type-signature"></span></h4>
<div class="description">
Calls the HTTP GET method from the gateway. This requires at least three mandatory parameters as shown in the below example. The requestType and responseType are the optional parameters. If the requestType and responseType are not present, then it is set to the default JSON type.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
<tr>
<td class="name"><code>path</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">URL path</td>
</tr>
<tr>
<td class="name"><code>parametersInfo</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">parameters to be passed along with the request</td>
</tr>
<tr>
<td class="name"><code>headersInfo</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">headers of the request</td>
</tr>
<tr>
<td class="name"><code>requestType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">specifies the request type of the request</td>
</tr>
<tr>
<td class="name"><code>responseType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">specifies the response type of the request</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginMAS.js.html">MASPluginMAS.js</a>, <a href="MASPluginMAS.js.html#line554">line 554</a>
</li></ul></dd>
</dl>
<h4 class="name" id="grantFlow"><span class="type-signature"></span>grantFlow<span class="signature">(successHandler, errorHandler, MASGrantFlow)</span><span class="type-signature"></span></h4>
<div class="description">
Sets the device registration type as MASDeviceRegistrationType. This should be set before MAS start is called
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
<tr>
<td class="name"><code>MASGrantFlow</code></td>
<td class="type">
<span class="param-type">MASGrantFlow</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginMAS.js.html">MASPluginMAS.js</a>, <a href="MASPluginMAS.js.html#line209">line 209</a>
</li></ul></dd>
</dl>
<h4 class="name" id="initEnterpriseBrowser"><span class="type-signature"></span>initEnterpriseBrowser<span class="signature">(successHandler, errorHandler)</span><span class="type-signature"></span></h4>
<div class="description">
Initializes the Enterprise Browser window and populates it with the native and web apps registered in the MAG server
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginApplication.js.html">MASPluginApplication.js</a>, <a href="MASPluginApplication.js.html#line97">line 97</a>
</li></ul></dd>
</dl>
<h4 class="name" id="initialize"><span class="type-signature"></span>initialize<span class="signature">(successHandler, errorHandler)</span><span class="type-signature"></span></h4>
<div class="description">
Initializes the MAS plugin. This includes setting of the various listeners required
for authenticating the user while registration of the application with the Gateway
and accessing various protected API. Any further initialization related setting will go here
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginMAS.js.html">MASPluginMAS.js</a>, <a href="MASPluginMAS.js.html#line28">line 28</a>
</li></ul></dd>
</dl>
<h4 class="name" id="initWithInfo"><span class="type-signature"></span>initWithInfo<span class="signature">(successHandler, errorHandler, info)</span><span class="type-signature"></span></h4>
<div class="description">
Creates a new group with the specified information
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
<tr>
<td class="name"><code>info</code></td>
<td class="type">
<span class="param-type">dictionary</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginGroup.js.html">MASPluginGroup.js</a>, <a href="MASPluginGroup.js.html#line44">line 44</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isApplicationAuthenticated"><span class="type-signature"></span>isApplicationAuthenticated<span class="signature">(successHandler, errorHandler)</span><span class="type-signature"></span></h4>
<div class="description">
Checks if application is authenticated
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginApplication.js.html">MASPluginApplication.js</a>, <a href="MASPluginApplication.js.html#line43">line 43</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isAuthenticated"><span class="type-signature"></span>isAuthenticated<span class="signature">(successHandler, errorHandler)</span><span class="type-signature"></span></h4>
<div class="description">
Boolean indicator that specifies whether the MASPluginUser object is authenticated
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginUser.js.html">MASPluginUser.js</a>, <a href="MASPluginUser.js.html#line90">line 90</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isCurrentUser"><span class="type-signature"></span>isCurrentUser<span class="signature">(successHandler, errorHandler)</span><span class="type-signature"></span></h4>
<div class="description">
Boolean indicator that specifies whether the MASPluginUser object is the current user.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginUser.js.html">MASPluginUser.js</a>, <a href="MASPluginUser.js.html#line81">line 81</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isDeviceRegistered"><span class="type-signature"></span>isDeviceRegistered<span class="signature">(successHandler, errorHandler)</span><span class="type-signature"></span></h4>
<div class="description">
Boolean state of device registration status on MAG server
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginDevice.js.html">MASPluginDevice.js</a>, <a href="MASPluginDevice.js.html#line20">line 20</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isSessionLocked"><span class="type-signature"></span>isSessionLocked<span class="signature">(successHandler, errorHandler)</span><span class="type-signature"></span></h4>
<div class="description">
Boolean indicator that specifies whether the currently authenticated MASPluginUser object is locked
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginUser.js.html">MASPluginUser.js</a>, <a href="MASPluginUser.js.html#line99">line 99</a>
</li></ul></dd>
</dl>
<h4 class="name" id="launchApp"><span class="type-signature"></span>launchApp<span class="signature">(successHandler, errorHandler, appId)</span><span class="type-signature"></span></h4>
<div class="description">
Launches the selected enterprise App
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
<tr>
<td class="name"><code>appId</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">app ID of the app that needs to be launched</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginApplication.js.html">MASPluginApplication.js</a>, <a href="MASPluginApplication.js.html#line69">line 69</a>
</li></ul></dd>
</dl>
<h4 class="name" id="lockSession"><span class="type-signature"></span>lockSession<span class="signature">(successHandler, errorHandler)</span><span class="type-signature"></span></h4>
<div class="description">
Locks the current session
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginUser.js.html">MASPluginUser.js</a>, <a href="MASPluginUser.js.html#line112">line 112</a>
</li></ul></dd>
</dl>
<h4 class="name" id="logout"><span class="type-signature"></span>logout<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Logs off the user.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginUser.js.html">MASPluginUser.js</a>, <a href="MASPluginUser.js.html#line147">line 147</a>
</li></ul></dd>
</dl>
<h4 class="name" id="newGroup"><span class="type-signature"></span>newGroup<span class="signature">(successHandler, errorHandler)</span><span class="type-signature"></span></h4>
<div class="description">
Creates a new group
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginGroup.js.html">MASPluginGroup.js</a>, <a href="MASPluginGroup.js.html#line54">line 54</a>
</li></ul></dd>
</dl>
<h4 class="name" id="postToPath"><span class="type-signature"></span>postToPath<span class="signature">(successHandler, errorHandler, path, parametersInfo, headersInfo, requestType, responseType)</span><span class="type-signature"></span></h4>
<div class="description">
postToPath does the HTTP POST call from the gateway. This expects atleast three mandatry parameters as shown in the the below example. The requestType and responseType are the optional parameters. If the requestType and responseType is not present then it is set to the Default Type to JSON.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
<tr>
<td class="name"><code>path</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">path to the url</td>
</tr>
<tr>
<td class="name"><code>parametersInfo</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">parameters to be passed along with the request</td>
</tr>
<tr>
<td class="name"><code>headersInfo</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">headers of the request</td>
</tr>
<tr>
<td class="name"><code>requestType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">specifies the request type of the request</td>
</tr>
<tr>
<td class="name"><code>responseType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">specifies the response type of the request</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginMAS.js.html">MASPluginMAS.js</a>, <a href="MASPluginMAS.js.html#line602">line 602</a>
</li></ul></dd>
</dl>
<h4 class="name" id="putToPath"><span class="type-signature"></span>putToPath<span class="signature">(successHandler, errorHandler, path, parametersInfo, headersInfo, requestType, responseType)</span><span class="type-signature"></span></h4>
<div class="description">
Calls the HTTP POST method from the Gateway. This expects at least three mandatory parameters as shown in the below example. The requestType and responseType are the optional parameters. If the requestType and responseType are not present, then it is set to the default JSON type
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
<tr>
<td class="name"><code>path</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">path to the url</td>
</tr>
<tr>
<td class="name"><code>parametersInfo</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">parameters to be passed along with the request</td>
</tr>
<tr>
<td class="name"><code>headersInfo</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">headers of the request</td>
</tr>
<tr>
<td class="name"><code>requestType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">specifies the request type of the request</td>
</tr>
<tr>
<td class="name"><code>responseType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">specifies the response type of the request</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginMAS.js.html">MASPluginMAS.js</a>, <a href="MASPluginMAS.js.html#line586">line 586</a>
</li></ul></dd>
</dl>
<h4 class="name" id="removeSessionLock"><span class="type-signature"></span>removeSessionLock<span class="signature">(successHandler, errorHandler)</span><span class="type-signature"></span></h4>
<div class="description">
Removes the session lock
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginUser.js.html">MASPluginUser.js</a>, <a href="MASPluginUser.js.html#line140">line 140</a>
</li></ul></dd>
</dl>
<h4 class="name" id="resetLocally"><span class="type-signature"></span>resetLocally<span class="signature">(successHandler, errorHandler)</span><span class="type-signature"></span></h4>
<div class="description">
Resets all the local cache of the device for the app i.e. all tokens, credentials, states are flushed
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginDevice.js.html">MASPluginDevice.js</a>, <a href="MASPluginDevice.js.html#line65">line 65</a>
</li></ul></dd>
</dl>
<h4 class="name" id="retrieveAuthenticationProviderForProximityLogin"><span class="type-signature"></span>retrieveAuthenticationProviderForProximityLogin<span class="signature">(successHandler, errorHandler)</span><span class="type-signature"></span></h4>
<div class="description">
Returns the proximity login providers
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginAuthProviders.js.html">MASPluginAuthProviders.js</a>, <a href="MASPluginAuthProviders.js.html#line25">line 25</a>
</li></ul></dd>
</dl>
<h4 class="name" id="retrieveEnterpriseApps"><span class="type-signature"></span>retrieveEnterpriseApps<span class="signature">(successHandler, errorHandler)</span><span class="type-signature"></span></h4>
<div class="description">
Retrieves all the enterprise apps in the form of JSON from the server. It includes both native and web apps
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginApplication.js.html">MASPluginApplication.js</a>, <a href="MASPluginApplication.js.html#line82">line 82</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setCustomLoginPage"><span class="type-signature"></span>setCustomLoginPage<span class="signature">(successHandler, errorHandler, customPage)</span><span class="type-signature"></span></h4>
<div class="description">
Sets the authentication UI handling page
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
<tr>
<td class="name"><code>customPage</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">user defined page if you want the plugin to use it.
"mas-login.html" is the default page.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginMAS.js.html">MASPluginMAS.js</a>, <a href="MASPluginMAS.js.html#line49">line 49</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setCustomOTPChannelsPage"><span class="type-signature"></span>setCustomOTPChannelsPage<span class="signature">(successHandler, errorHandler, customPage)</span><span class="type-signature"></span></h4>
<div class="description">
Sets the OTP Channels Selection UI handling page
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
<tr>
<td class="name"><code>customPage</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">user defined page if you want the plugin to use it.
"mas-otpchannel.html" is the default page.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginMAS.js.html">MASPluginMAS.js</a>, <a href="MASPluginMAS.js.html#line86">line 86</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setCustomOTPPage"><span class="type-signature"></span>setCustomOTPPage<span class="signature">(successHandler, errorHandler, customPage)</span><span class="type-signature"></span></h4>
<div class="description">
Sets the OTP UI handling page
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
<tr>
<td class="name"><code>customPage</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">user defined page if you want the plugin to use it.
"mas-otp.html" is the default page.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginMAS.js.html">MASPluginMAS.js</a>, <a href="MASPluginMAS.js.html#line121">line 121</a>
</li></ul></dd>
</dl>
<h4 class="name" id="start"><span class="type-signature"></span>start<span class="signature">(successHandler, errorHandler)</span><span class="type-signature"></span></h4>
<div class="description">
Starts the lifecycle of the MAS processes. This includes the registration of the application on the Gateway, if the network is available.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginMAS.js.html">MASPluginMAS.js</a>, <a href="MASPluginMAS.js.html#line487">line 487</a>
</li></ul></dd>
</dl>
<h4 class="name" id="startWithDefaultConfiguration"><span class="type-signature"></span>startWithDefaultConfiguration<span class="signature">(successHandler, errorHandler, defaultConfiguration)</span><span class="type-signature"></span></h4>
<div class="description">
Starts the lifecycle of the MAS processes with a specified default configuration. This includes the registration of the application on the Gateway, if the network is available.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
<tr>
<td class="name"><code>defaultConfiguration</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginMAS.js.html">MASPluginMAS.js</a>, <a href="MASPluginMAS.js.html#line498">line 498</a>
</li></ul></dd>
</dl>
<h4 class="name" id="startWithJSON"><span class="type-signature"></span>startWithJSON<span class="signature">(successHandler, errorHandler, jsonObject)</span><span class="type-signature"></span></h4>
<div class="description">
Starts the lifecycle of the MAS processes with a specified msso_config.json. This includes the registration of the application on the Gateway, if the network is available.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
<tr>
<td class="name"><code>jsonObject</code></td>
<td class="type">
<span class="param-type">jsonObject</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginMAS.js.html">MASPluginMAS.js</a>, <a href="MASPluginMAS.js.html#line509">line 509</a>
</li></ul></dd>
</dl>
<h4 class="name" id="stop"><span class="type-signature"></span>stop<span class="signature">(successHandler, errorHandler)</span><span class="type-signature"></span></h4>
<div class="description">
Stops the lifecycle of all MAS processes.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginMAS.js.html">MASPluginMAS.js</a>, <a href="MASPluginMAS.js.html#line520">line 520</a>
</li></ul></dd>
</dl>
<h4 class="name" id="unlockSession"><span class="type-signature"></span>unlockSession<span class="signature">(successHandler, errorHandler)</span><span class="type-signature"></span></h4>
<div class="description">
Unlocks the current session
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginUser.js.html">MASPluginUser.js</a>, <a href="MASPluginUser.js.html#line121">line 121</a>
</li></ul></dd>
</dl>
<h4 class="name" id="unlockSessionWithMessage"><span class="type-signature"></span>unlockSessionWithMessage<span class="signature">(successHandler, errorHandler, message)</span><span class="type-signature"></span></h4>
<div class="description">
Unlocks the current session with a message to the user
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
<tr>
<td class="name"><code>message</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">message to the user</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginUser.js.html">MASPluginUser.js</a>, <a href="MASPluginUser.js.html#line131">line 131</a>
</li></ul></dd>
</dl>
<h4 class="name" id="useNativeMASUI"><span class="type-signature"></span>useNativeMASUI<span class="signature">(successHandler, errorHandler)</span><span class="type-signature"></span></h4>
<div class="description">
Use Native MASUI
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginMAS.js.html">MASPluginMAS.js</a>, <a href="MASPluginMAS.js.html#line153">line 153</a>
</li></ul></dd>
</dl>
<h4 class="name" id="validateOTP"><span class="type-signature"></span>validateOTP<span class="signature">(successHandler, errorHandler, otp)</span><span class="type-signature"></span></h4>
<div class="description">
Validates the entered OTP.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>successHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined success callback</td>
</tr>
<tr>
<td class="name"><code>errorHandler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">user defined error callback</td>
</tr>
<tr>
<td class="name"><code>otp</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">user defined one-time password that is to be verified</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginMAS.js.html">MASPluginMAS.js</a>, <a href="MASPluginMAS.js.html#line444">line 444</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#active">active</a></li><li><a href="global.html#addresses">addresses</a></li><li><a href="global.html#authenticationStatus">authenticationStatus</a></li><li><a href="global.html#authorize">authorize</a></li><li><a href="global.html#cancelAuthentication">cancelAuthentication</a></li><li><a href="global.html#cancelGenerateAndSendOTP">cancelGenerateAndSendOTP</a></li><li><a href="global.html#cancelOTPValidation">cancelOTPValidation</a></li><li><a href="global.html#closePopup">closePopup</a></li><li><a href="global.html#completeAuthentication">completeAuthentication</a></li><li><a href="global.html#configFileName">configFileName</a></li><li><a href="global.html#deleteFromPath">deleteFromPath</a></li><li><a href="global.html#deregister">deregister</a></li><li><a href="global.html#emailAddresses">emailAddresses</a></li><li><a href="global.html#familyName">familyName</a></li><li><a href="global.html#formattedName">formattedName</a></li><li><a href="global.html#gatewayIsReachable">gatewayIsReachable</a></li><li><a href="global.html#generateAndSendOTP">generateAndSendOTP</a></li><li><a href="global.html#getCurrentDevice">getCurrentDevice</a></li><li><a href="global.html#getCurrentProviders">getCurrentProviders</a></li><li><a href="global.html#getDeviceIdentifier">getDeviceIdentifier</a></li><li><a href="global.html#getFromPath">getFromPath</a></li><li><a href="global.html#givenName">givenName</a></li><li><a href="global.html#grantFlow">grantFlow</a></li><li><a href="global.html#groupName">groupName</a></li><li><a href="global.html#groups">groups</a></li><li><a href="global.html#initEnterpriseBrowser">initEnterpriseBrowser</a></li><li><a href="global.html#initialize">initialize</a></li><li><a href="global.html#initWithInfo">initWithInfo</a></li><li><a href="global.html#isApplicationAuthenticated">isApplicationAuthenticated</a></li><li><a href="global.html#isAuthenticated">isAuthenticated</a></li><li><a href="global.html#isCurrentUser">isCurrentUser</a></li><li><a href="global.html#isDeviceRegistered">isDeviceRegistered</a></li><li><a href="global.html#isSessionLocked">isSessionLocked</a></li><li><a href="global.html#launchApp">launchApp</a></li><li><a href="global.html#lockSession">lockSession</a></li><li><a href="global.html#logout">logout</a></li><li><a href="global.html#members">members</a></li><li><a href="global.html#newGroup">newGroup</a></li><li><a href="global.html#owner">owner</a></li><li><a href="global.html#phoneNumbers">phoneNumbers</a></li><li><a href="global.html#photos">photos</a></li><li><a href="global.html#postToPath">postToPath</a></li><li><a href="global.html#putToPath">putToPath</a></li><li><a href="global.html#removeSessionLock">removeSessionLock</a></li><li><a href="global.html#resetLocally">resetLocally</a></li><li><a href="global.html#retrieveAuthenticationProviderForProximityLogin">retrieveAuthenticationProviderForProximityLogin</a></li><li><a href="global.html#retrieveEnterpriseApps">retrieveEnterpriseApps</a></li><li><a href="global.html#setCustomLoginPage">setCustomLoginPage</a></li><li><a href="global.html#setCustomOTPChannelsPage">setCustomOTPChannelsPage</a></li><li><a href="global.html#setCustomOTPPage">setCustomOTPPage</a></li><li><a href="global.html#start">start</a></li><li><a href="global.html#startWithDefaultConfiguration">startWithDefaultConfiguration</a></li><li><a href="global.html#startWithJSON">startWithJSON</a></li><li><a href="global.html#stop">stop</a></li><li><a href="global.html#unlockSession">unlockSession</a></li><li><a href="global.html#unlockSessionWithMessage">unlockSessionWithMessage</a></li><li><a href="global.html#useNativeMASUI">useNativeMASUI</a></li><li><a href="global.html#userName">userName</a></li><li><a href="global.html#validateOTP">validateOTP</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.0-dev</a> on Mon Mar 06 2017 16:30:10 GMT+0530 (IST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>