Smartface Native Framework extension to use Oracle Mobile Cloud Services
JavaScript Shell
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
sample
.gitignore
.npmignore
CODE_OF_CONDUCT.md
LICENSE
README.md
api.md
base64.js
createdoc.sh
mcs.js
package.json

README.md

MCS Extension from Smartface

Twitter: @Smartface_io License

An extension to Oracle MCS Connection with Smartface Native Framework.

Installation

MCS Extension can be installed via npm easily from our public npm repository. The installation is pretty easy via Smartface Cloud IDE.

  • Open terminal
  • (cd ~/workspace/scripts && npm i -S sf-extension-mcs)
  • Finally require the extension as: require("sf-extension-mcs")

How to use

  1. Init your MCS config
const MCS = require('sf-extension-mcs');
var options = {
	'backendId': 'YOUR BACKEND ID', //required
	'baseUrl': 'YOUR BASE URL', //required
	'androidApplicationKey': 'YOUR ANDROID APP KEY', //required only for analytics & events
	'iOSApplicationKey': 'YOUR IOS APP KEY', //required only for analytics & events
	'anonymousKey': 'YOUR BASIC AUTHENTICATION ANONYMOUS KEY' //required only to perform operations without logging in first
};
var mcs = new MCS(options);
  1. Login to MCS (Example)
mcs.login({
	'username': 'YOUR USER NAME',
	'password': 'YOUR PASSWORD'
},

function(err, result) {

	loadingView.visible = false;

	if (err) {
		return alert("LOGIN FAILED.  " + err);
	}

	alert("LOGIN SUCCESS.  " + result);	

});
  1. Send Basic Analytic Event (Example)
var optionsAnalytic = {
	'deviceID': '112233', //required
	'sessionID': '112233', //required
	'eventName': 'sendBasicEvent'
};

mcs.sendBasicEvent(optionsAnalytic, function(err, result) {

	if (err) {
		return alert("sendBasicEvent FAILED.  " + err);
	}

	alert("sendBasicEvent SUCC.  " + result.toString());

});

API Documentation

Full api documentation is in api.md

Need Help?

Please submit an issue on GitHub and provide information about your problem.

Support & Documentation & Useful Links

Code of Conduct

We are committed to making participation in this project a harassment-free experience for everyone, regardless of the level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality. Please read and follow our Code of Conduct.

License

This project is licensed under the terms of the MIT license. See the LICENSE file. Within the scope of this license, all modifications to the source code, regardless of the fact that it is used commercially or not, shall be committed as a contribution back to this repository.