Getting started

Register yourself at Leanplum.com and log in.

On the dashboard, create an application and enable iOS and/or Android, then click 'Setup Keys'. You will need these keys when configuring the plugin later on.

If you want to send push notifications to your iOS app from the Leanplum service, then make sure to hit the second tab and provide Leanplum with your push certificates. Not sure how to obtain those? Log in to Leanplum.com, click Help, Docs, In-App & Push, and follow steps 1 through 6.
For Android you can configure your Google Cloud Messaging sender ID, or leave it empty to use the default Leanplum sender ID.

Configuring the Keys in your app

• If you use the Cordova CLI refer to the instructions at the top of this page.
• When using the demo app from the button at the top of this page, or in case you're installing the plugin yourself in AppBuilder, you can configure the variables at Properties > Plugins > Leanplum. Now expand the plugin to reveal the 'Configuration Variables' button.

Hooking up your app to Leanplum

After deviceready has fired, the global Leanplum variable is available and you will be able to connect to Leanplum through it like this:

document.addEventListener("deviceready", function () {
  // Calling 'start' will run your app in production mode.
  // Call 'enableDebugging' before calling 'start' to run this session in developer mode.
  Leanplum.enableDebugging();

  Leanplum.start(
      function(msg) {console.log("Started Leanplum. Message was: " + msg)},  // success handler
      function(msg) {alert("ERROR, Leanplum did not start: " + msg)}  // error handler
  );
});

Tracking events

As an addition to the default insight into app usage Leanplum provides you with, you can track custom events. Just pass in a String as the third parameter to the 'track' function.

Leanplum.track(
    function(msg) {alert(msg)}, // success handler
    function(msg) {alert("ERROR, not tracked: " + msg)}, // error handler
    "Button clicked"
);

You can also pass a fourth param which contains a JSON object to track for example the value of in-app purchases. Make sure the values are numerical.

Leanplum.track(
    function(msg) {alert(msg)}, // success handler
    function(msg) {alert("ERROR, not tracked: " + msg)}, // error handler
    "Upgrade purchased",
    {"price" : 40, "quantity" : 2, "totalprice" : 80}
);

Receiving push notifications

For iOS, once the certificate and provisioning profile hassle is over, you can register your app for receiving push notifications. The first time this method is called, your app will ask permission for receiving push notifications. If that's not the case, make sure you've signed your app with a unique push-enabled app ID.

It's good to know that if you can't get push notifications to work, you can always use the excellent server-pushed messages the Leanplum SDK provides. The 'confirm' dialog in the screenshots section is a great example of a message configured in the cloud and displayed in the app. The main difference with real push notifications is these don't trigger the user to open your app. But they are a lot more flexible and you don't need this code to tell the server the app is correctly set up to receive notifications:

Leanplum.registerPush({
  "badge": "true",
  "sound": "true",
  "alert": "true",
  "callback": "onPushNotificationReceived" // make sure you define this function somewhere
});

// the callback we configured a few lines back
function onPushNotificationReceived(e) {
  alert("Push Notification received: " + JSON.stringify(e));
}

Once registered, go to the dashboard on Leanplum.com, hit Messaging, select 'Push Notification' and click the play button next to it to send a message to your developer device.

Stop receiving push notifications

If you have a switch for your user to disable or mute push notifications, attach that switch to this function:

Leanplum.unregisterPush();