caapim / cordova-mas-foundation Goto Github PK

Cordova-MAS-Foundation is the core Cordova framework for Layer7 Mobile API Gateway.

The Cordova-MAS-Foundation framework has the following features:

• User Authentication and Authorization
• Customize Login Dialogs
• Customized Login Mechanism Handling
• Enterprise Browser
• Fingerprint Sessions Lock
• One-Time Password (OTP)
• Proximity Login (QR Code)
• Social Login
• SSL Pinning with certificate, public key, or public key hash
• Intermediate Certificate for enhanced security
• Multipart Form Upload capability. Enables the SDK user to upload files.

Follow our documentation to install Cordova and set up iOS and Android projects.

The reference documents for the MAS modules are generated using the JSDoc markdown language. JSDoc reads the JS files with annotations in comments, and generates an HTML output. It considers the comments that start with /**.

To install JSDoc, follow the instructions on JSDoc website.

The Cordova reference documents are available at our techdocs.broadcom.com site.

Example: An annotated comment for validateOTP method is as follows:

 /**
  Validate the OTP.
  * @param {function} successHandler user defined success callback
  * @param {function} errorHandler user defined error callback
  * @param {string} otp user defined one-time password to verify
  */

Param – Specifies a parameter. {string} – Specifies the return type of the method. otp – Specifies the variable name. user defined one-time password to verify – Describes the method.

Compile the JSDoc reference document as follows:

jsdoc www/ -d jsdocs

where “www/” is the location of the js file, and “-d jsdocs” is the location where the generated reference documents are placed.

For more information about how to write and compile the JSDoc reference documents, see the JSDoc website.

Contributions are welcome and much appreciated. To learn more, see the Contribution Guidelines.

• Have general questions or need help?, use [Stack Overflow][StackOverflow]. (Tag 'massdk')
• Find a bug?, open an issue with the steps to reproduce it.
• Request a feature or have an idea?, open an issue.

Copyright (c) 2019 Broadcom. All Rights Reserved. The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.

This software may be modified and distributed under the terms of the MIT license. See the LICENSE file for details.