cordova-plugin-mas-core
Version:
Cordova MAS Foundation Plugin
973 lines (283 loc) • 13.9 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: MASPluginConstants</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">Class: MASPluginConstants</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>MASPluginConstants</h2>
<div class="class-description">This class contains various MAS constants.
<table>
<tr bgcolor="#D3D3D3"><th>Sample constant access</th></tr>
<tr><td><i>var grantFlow = MASPluginConstants.MASGrantFlow.MASGrantFlowClientCredentials;</i></td></tr>
</table></div>
</header>
<article>
<div class="container-overview">
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginConstants.js.html">MASPluginConstants.js</a>, <a href="MASPluginConstants.js.html#line7">line 7</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Type Definitions</h3>
<h4 class="name" id=".MASGrantFlow">MASGrantFlow</h4>
<div class="description">
The constant which indicates the OAuth Grant Flow type to be used for all the requests.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>MASGrantFlowUnknown</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Unknown grant flow type.</td>
</tr>
<tr>
<td class="name"><code>MASGrantFlowClientCredentials</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The client credentials grant flow.</td>
</tr>
<tr>
<td class="name"><code>MASGrantFlowPassword</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The user credentials grant flow.</td>
</tr>
<tr>
<td class="name"><code>MASGrantFlowCount</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The total number of supported types.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginConstants.js.html">MASPluginConstants.js</a>, <a href="MASPluginConstants.js.html#line36">line 36</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".MASPopupStyle">MASPopupStyle</h4>
<div class="description">
The default popup styles for UI elements in case of Authentication/OTP etc.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>MASPopupLoginStyle</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="default">
"position:fixed;top:50%;left:50%;transform:translate(-50%,-50%);height:100%;width:100%;overflow:auto"
</td>
<td class="description last">Default Login UI style</td>
</tr>
<tr>
<td class="name"><code>MASPopupOTPStyle</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="default">
"position:fixed;top:50%;left:50%;transform:translate(-50%,-50%);height:500px;overflow:auto"
</td>
<td class="description last">Default OTP UI style</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginConstants.js.html">MASPluginConstants.js</a>, <a href="MASPluginConstants.js.html#line22">line 22</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".MASRequestResponseType">MASRequestResponseType</h4>
<div class="description">
The constant which indicates what data format is expected in a CRUD operation's request or a response.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>MASRequestResponseTypeUnknown</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Unknown encoding type.</td>
</tr>
<tr>
<td class="name"><code>MASRequestResponseTypeJson</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Standard JSON encoding.</td>
</tr>
<tr>
<td class="name"><code>MASRequestResponseTypeScimJson</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">SCIM-specific JSON variant encoding.</td>
</tr>
<tr>
<td class="name"><code>MASRequestResponseTypeTextPlain</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Plain Text.</td>
</tr>
<tr>
<td class="name"><code>MASRequestResponseTypeWwwFormUrlEncoded</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Standard WWW Form URL encoding.</td>
</tr>
<tr>
<td class="name"><code>MASRequestResponseTypeXml</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Standard XML encoding.</td>
</tr>
<tr>
<td class="name"><code>MASRequestResponseTypeCount</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The total number of supported types.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginConstants.js.html">MASPluginConstants.js</a>, <a href="MASPluginConstants.js.html#line52">line 52</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".MASState">MASState</h4>
<div class="description">
The constant which indicates the state in which the MAS process lifecycle is
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>MASStateNotConfigured</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">States that SDK has not been initialized and does not have configuration file either in local file system based on the default configuration file name, nor in the keychain storage.</td>
</tr>
<tr>
<td class="name"><code>MASStateNotInitialized</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">States that SDK has the active configuration either in the local file system but has not been initialized yet.</td>
</tr>
<tr>
<td class="name"><code>MASStateStarted</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">States that SDK did start; at this state, SDK should be fully functional.</td>
</tr>
<tr>
<td class="name"><code>MASStateStopped</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">States that SDK did stop; at this state, SDK is properly stopped and should be able to re-start.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MASPluginConstants.js.html">MASPluginConstants.js</a>, <a href="MASPluginConstants.js.html#line74">line 74</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="MASPlugin.html">MASPlugin</a></li><li><a href="MASPluginApplication.html">MASPluginApplication</a></li><li><a href="MASPluginAuthProviders.html">MASPluginAuthProviders</a></li><li><a href="MASPluginConstants.html">MASPluginConstants</a></li><li><a href="MASPluginDevice.html">MASPluginDevice</a></li><li><a href="MASPluginMAS.html">MASPluginMAS</a></li><li><a href="MASPluginMultipartForm.html">MASPluginMultipartForm</a></li><li><a href="MASPluginSecurityConfiguration.html">MASPluginSecurityConfiguration</a></li><li><a href="MASPluginUser.html">MASPluginUser</a></li><li><a href="MASPluginUtils.html">MASPluginUtils</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Feb 18 2020 21:13:36 GMT+0530 (India Standard Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>