UNPKG

cordova-plugin-mas-core

Version:
987 lines (232 loc) 12.9 kB
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: MASPluginApplication</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: MASPluginApplication</h1> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span>MASPluginApplication</h2> <div class="class-description">The main class responsible for MASApplication Object Lifecycle Management. <table> <tr bgcolor="#D3D3D3"><th>MASApplication Construtor</th></tr> <tr><td><i>var MASApplication = new MASPlugin.MASApplication();</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="MASPluginApplication.js.html">MASPluginApplication.js</a>, <a href="MASPluginApplication.js.html#line11">line 11</a> </li></ul></dd> </dl> </div> <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"><a href="global.html#successCallbackFunction">successCallbackFunction</a></span> </td> <td class="description last">user defined success callback that is invoked on success scenario.</td> </tr> <tr> <td class="name"><code>errorHandler</code></td> <td class="type"> <span class="param-type"><a href="global.html#errorCallbackFunction">errorCallbackFunction</a></span> </td> <td class="description last">user defined error callback that is invoked on failure scenario.</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#line40">line 40</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"><a href="global.html#successCallbackFunction">successCallbackFunction</a></span> </td> <td class="description last">user defined success callback that is invoked on success scenario.</td> </tr> <tr> <td class="name"><code>errorHandler</code></td> <td class="type"> <span class="param-type"><a href="global.html#errorCallbackFunction">errorCallbackFunction</a></span> </td> <td class="description last">user defined error callback that is invoked on failure scenario.</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#line79">line 79</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"><a href="global.html#successCallbackFunction">successCallbackFunction</a></span> </td> <td class="description last">user defined success callback that is invoked on success scenario.</td> </tr> <tr> <td class="name"><code>errorHandler</code></td> <td class="type"> <span class="param-type"><a href="global.html#errorCallbackFunction">errorCallbackFunction</a></span> </td> <td class="description last">user defined error callback that is invoked on failure scenario.</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#line28">line 28</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 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"><a href="global.html#successCallbackFunction">successCallbackFunction</a></span> </td> <td class="description last">user defined success callback that is invoked on success scenario.</td> </tr> <tr> <td class="name"><code>errorHandler</code></td> <td class="type"> <span class="param-type"><a href="global.html#errorCallbackFunction">errorCallbackFunction</a></span> </td> <td class="description last">user defined error callback that is invoked on failure scenario.</td> </tr> <tr> <td class="name"><code>appId</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">application 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#line52">line 52</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"><a href="global.html#successCallbackFunction">successCallbackFunction</a></span> </td> <td class="description last">user defined success callback that is invoked on success scenario.</td> </tr> <tr> <td class="name"><code>errorHandler</code></td> <td class="type"> <span class="param-type"><a href="global.html#errorCallbackFunction">errorCallbackFunction</a></span> </td> <td class="description last">user defined error callback that is invoked on failure scenario.</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#line67">line 67</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>