cordova-plugin-cbienkit v1.0.5

CBKit for Cordova

This is a plugin that allows your Cordova app to use CBKit for iOS and Android.

Supported Platforms

• Android 4.0.3+ (API15)
• iOS 8.0+

Installation

Add xcode package (iOS only) :

npm install xcode

To install the plugin in your Cordova app, run the following:

cordova plugin add https://github.com/CBien/cbien-cordova.git

Configuring

To configure CBKit, you must add domains names and your app's keys to your config.xml:

<access origin="http://*.cbien.com"></access>
<access origin="http://cbien-partner.herokuapp.com"></access>
<access origin="http://*.amazonaws.com"></access>
<access origin="http://*.newrelic.com"></access>
<access origin="http://*.nr-data.net"></access>
<access origin="http://*.googleapis.com"></access>

<preference name="cbien-ios-clientid" value="your_client_id_for_ios"/>
<preference name="cbien-ios-clientsecret" value="your_client_secret_for_ios"/>
<preference name="cbien-ios-inproduction" value="true_or_false"/>

<preference name="cbien-android-clientid" value="your_client_id_for_android"/>
<preference name="cbien-android-clientsecret" value="your_client_secret_for_android"/>
<preference name="cbien-android-inproduction" value="true_or_false"/>

Use

1. Firstly, on successful completion of login (or wherever you check your user's authenticated state when your app starts up) you will need to initialize with user's identifier.

CBKit.initialize({
  uniqueIdentifier: "unique_identifier"
});

2. Also, you can customize colors (all parameters are optional)

CBKit.configure({
  primaryColor : "#004B9B", 
  colorOnPrimaryColor : "#FFFFFF",  // iOS only
  secondaryColor : "#FDC600", 
  colorOnSecondaryColor : "#FFFFFF", // iOS only
  stuffColor : "#41F4C4",
  vehicleColor : "#636C8C",
  domainColor : "#D39ACC",
  headerBackgroundColor : "#FF3730",
  headerTextIconColor : "#684514",
  headerIndicatorColor : "#E4FF6D",
  buttonType : CBKit.ButtonType.ICON,
  font : CBKit.Font.ROBOTO,
});

4. Check if new refresh token needed and set a new one (Optional)

CBKit.refreshTokenNeeded( function(needed) { 
  if (needed) {
    CBKit.setRefreshToken({refreshToken: "refresh_token"}); 
  } 
});

3. Finally, display CBien screens.

CBKit.show();

CBKit.Font : enum

Kind: static enum property of CBKit Properties

CBKit.ButtonType : enum

Kind: static enum property of CBKit Properties

License

cbien-cordova is released under the MIT License.

Copyright

Copyright (c) 2017, Inc. All rights reserved.