kumulos by Kumulos Ltd

Currently displaying version

Kumulos

Kumulos is the app management platform for mobile app developers and development businesses. Kumulos provides simple and easy-to-use tools to quickly build and host backend storage for apps, send push notifications, view audience and behaviour analytics and report on adoption, engagement and performance. All through a single-pane-of-glass.

To get started with the Kumulos Trigger SDK, please see our getting started guide before continuing.


Initialization

Before completing any operations with the Kumulos SDK, it should be initialized with your API key and secret from the Kumulos app dashboard in your agency console.

forge.kumulos.init({
    apiKey: 'YOUR_API_KEY',
    secretKey: 'YOUR_SECRET_KEY'
});

After initialization, you can proceed to perform API operations or register for push notifications.

Calling API Methods

Calling an API method for your Kumulos app is achieved with forge.kumulos.call(method, params). For example:

var params = {
    paramName: 'value'
};

forge.kumulos.call('methodAlias', params)
    .then(function (data) {
        forge.logging.info('Call completed with result: ' + JSON.stringify(data));
    })
    .catch(function (err) {
        forge.logging.info('Call failed with error: ' + JSON.stringify(err));
    });

Push Notifications

Kumulos allows sending push notifications to devices. This section outlines how to register an installation to receive push notifications, and how to consume the notification data.

Registering for Push

When it is most appropriate to ask for push notifications, you can call forge.kumulos.push.register().

forge.kumulos.push.register();

This will trigger the platform-specific flow to request a push token and store it with Kumulos.

Handling Push Notifications

To handle push notifications received by the device, you can listen for the forge.kumulos.events.PUSH_RECEIVED event. A notification object will be passed to your handler when a push is received.

forge.internal.addEventListener(forge.kumulos.events.PUSH_RECEIVED, function (notification) {
    // Do something with the notification?
});

The format of the notification object is as follows:

{
    "id": "81db31dc-eeaa-4991-b46c-e7445850eead",
    "message": "Hello World",
    "data": null,
    "didOpenFromPush": 1
}

The didOpenFromPush flag will be set if the user tapped the notification from the notification area to launch your app. In this case, Kumulos will also handle tracking the push open event for you.

The data property will either be null or an object with any custom data sent in the push notification.

Installation ID

Each app installation is associated with a unique installation ID which identifies the installation to Kumulos.

You can retrieve the installation ID with forge.kumulos.getInstallId() like so:

forge.kumulos.getInstallId()
    .then(function (id) {
        forge.logging.info("Got install ID: " + id);
    })
    .catch(function (err) {
        forge.logging.info("Failed to get install ID");
    });

Changelog

1.1.0

  • Update to support Push Notifications for iOS10
  • Add audience analytics installation metrics

At the time of writing, the Trigger platform version 2.5.1beta-3 or later is required to use this version of the Kumulos module

1.0.3

  • Initial public release for iOS supporting Push Notifications