Skip to content
No description, website, or topics provided.
Objective-C JavaScript Java C
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
hooks
src
tests
www
.gitignore
LICENSE
README.md
package-lock.json Version 1.0.10 Sep 25, 2019
package.json
plugin.xml

README.md

Selligent Cordova Plugin (selligent-cordova)

This plugin defines a global window.Selligent object, which provides an API for the usage of the Selligent SDK in Cordova and Ionic.

Supported platforms

  • Android
  • iOS

Installation

Cordova

Execute the following command: cordova plugin add @selligent-marketing-cloud/selligent-cordova

Ionic

Execute the following command: ionic cordova plugin add @selligent-marketing-cloud/selligent-cordova

Android Specific installation

  1. Add the google-services dependencies to the ./platforms/android/build.gradle file:
buildscript {
...
    dependencies {
  ...
        classpath 'com.google.gms:google-services:3.2.0'
        ...
    }
    ...
}
  1. Follow section 3 Creating a Google Application of the Android - Using the SDK pdf, and place the google-services.json file in the ./platforms/android/app folder.

  2. Add the android:name property of the application tag in the ./platforms/android/app/src/main/AndroidManifest.xml file:

<application android:hardwareAccelerated="true"
             android:icon="@mipmap/icon"
             android:label="@string/app_name"
             android:supportsRtl="true"
             android:name="com.selligent.SelligentApplication">

Change default push notification icons

Add the following properties to the selligent.json file:

    "notificationSmallIcon": "ic_notification",
    "notificationLargeIcon": "ic_notification"

Note: only parse the name of the icon, without the path. The icon should reside in the res/drawable folder of the Android project, as explained in Android's official guide.

Third party plugins

The plugin has a cordova build hook for Android. The hook will rebuild the ext.postBuildExtras section of the build-extras.gradle file. It will add various repositories and settings needed to build the plugin. You can customize this file yourself, but it's important to keep the ext.postBuildExtras section last.

All dependency verions of this plugin are preferences that can be customized. The preferences are the following: MULTIDEX_VERSION, APP_COMPAT_VERSION, FIREBASE_VERSION, FIREBASE_JOB_DISPATCHER_VERSION, PLAY_SERVICES_VERSION, PLOT_PROJECTS_VERSION, GSON_VERSION, METADATA_EXTRACTOR_VERSION

Upgrading the plugin to a new version

Execute the following steps:

  • $ cordova plugin rm selligent-cordova
  • $ cordova platform rm android
  • $ cordova plugin platform add android
  • $ cordova plugin add @selligent-marketing-cloud/selligent-cordova
  • Follow the above installation steps again.

If for some reason you can't remove and rebuild the Android platform it's important to remove any references to the sdk in the project.properties and build.gradle files.

iOS Specific installation

For remote push notifications, follow section 4 Configure the APNS (Apple Push Notification Service), of the IOS - Using the SDK pdf.

For geolocation services, follow section 6.5 Geolocation, of the IOS - Using the SDK pdf. You also need to configure several permissions described in 5.3.3 Permission for geo location.

Using the API

  1. First, bootstrap the plugin
  2. Create a selligent.json file (name is case sensitive) in the www/assets folder (create the assets folder if it's not there) using the following structure:
{
    "url": "someMobilePushUrl",
    "clientId": "someClientId",
    "privateKey": "somePrivateKey",
    "fullyQualifiedNotificationActivityClassName": "com.some.project.MainActivity"
}

For a detailed overview of the settings see Selligent.reloadSettings(successCallback, errorCallback, settings).

  1. Add a button for testing purposes
  • For Cordova add the following in the www/index.html file:

    <div class="app">
        ...
        <!-- Add this: -->
        <button id="get-version">
            Get version
        </button>
        ...
    </div>
  • For Ionic add the following in the src/pages/home/home.html file:

    <ion-content padding>
        ...
        <!-- Add this: -->
        <ion-content padding>
          <button ion-button round (click)="getVersionLib()">Get version</button>
        </ion-content>
        ...
    </ion-content>
  1. Bind a callback to the button created above
  • For Cordova add the following in your www/js/index.js file:

    onDeviceReady: function () {
            ...
            // Bind getVersionLib to the button's onclick event:
            var getVersionButton = document.getElementById('get-version');
            getVersionButton.addEventListener('click', function () {
                window.Selligent.getVersionLib(
                    function (version) { // success callback
                        alert("Version: " + version);
                    },
                    function (error) { // error callback
                        alert("Error: " + JSON.stringify(error));
                    }
                );
            });
            ...
    }
  • For Ionic add the following in your src/pages/home/home.ts file

    declare var Selligent: any;
    ...
    
    export class HomePage {
      ...
      getVersionLib() {
        Selligent.getVersionLib((response) => {
          alert('getVersionLib response: ' + response);
        });
      }
      ...
    }
  1. Build the iOS and Android project
  • For Cordova:

    • cordova build ios
    • cordova build android
  • For Ionic:

    • ionic cordova build ios
    • ionic cordova build android
  1. Run the project and press the Get Version button, you should see a popup showing the currently installed Selligent SDK version.

Deeplinking

You can catch the deeplinks 2 ways:

  1. Native in AppDelegate.m, add the following (example code that logs the URL)
-(BOOL)application:(UIApplication*) application openURL:(NSURL*) url sourceApplication:(NSString*) sourceApplication annotation:(id) annotation
{
  NSLog(@"%@", [url absoluteString]);
  return YES;
}
  1. In your Cordova codebase, https://www.npmjs.com/package/cordova-plugin-deeplinks

API Reference

Methods

Selligent.getVersionLib(successCallback, errorCallback)

Returns the version of the installed Selligent SDK.

The response of the success callback is a string containing the version of the SDK.

getVersionLib example
window.Selligent.getVersionLib(
  function (response) { // success callback
    alert('Selligent SDK Version: ' + response);
  },
  function (error) { // error callback
    ...
  }
);

Selligent.reloadSettings(successCallback, errorCallback, settings)

Can be used to reload and/or change the settings of the Selligent instance.

The settings parameter is an object containing the web service URL, the Selligent client id and private key, the Google application id and any other optional parameters (see the table below for a detailed overview). There are parameters that can only be used on a specific platform, but can be passed to either and will be ignored when possible.

Detailed overview:

Property Type Required Platform
url string Yes Both
clientId string Yes Both
privateKey string Yes Both
googleApplicationId string No Both
clearCacheIntervalValue enum Selligent.ClearCacheIntervalValue No Both
configureLocationServices boolean No Both
inAppMessageRefreshType enum Selligent.InAppMessageRefreshType No Both
shouldClearBadge boolean No iOS Only
shouldDisplayRemoteNotification boolean No iOS Only
shouldPerformBackgroundFetch boolean No iOS Only
doNotListenToThePush boolean No Android Only
doNotFetchTheToken boolean No Android Only
loadCacheAsynchronously boolean No Android Only
fullyQualifiedNotificationActivityClassName string No Android Only
remoteMessageDisplayType enum Selligent.AndroidRemoteMessagesDisplayType No Android Only
reloadSettings example
window.Selligent.reloadSettings(
  function (response) { // success callback
    ...
  },
  function (error) { // error callback
    ...
  },
  {
    url: "...",
    clientId: "...",
    privateKey: "...",
    configureLocationServices: true,
    shouldDisplayRemoteNotification: true, // will only be used on the iOS platform
    remoteMessageDisplayType: Selligent.AndroidRemoteMessagesDisplayType.NOTIFICATION // will only be used on the Android platform
  }
);

Selligent.loadSettings(successCallback, errorCallback)

Load the Selligent settings from www/assets/selligent.json.

The response of the success callback is a json-parsed object containing the settings from the file. This can be useful to use in combination with the reloadSettings method. For an overview of the settings object have a look at the reloadSettings method description above.

loadSettings example
window.Selligent.loadSettings(
  function (response) { // success callback
    ...
  },
  function (error) { // error callback
    ...
  }
);

Selligent.sendDeviceInfo(successCallback, errorCallback, options)

Send the device's information.

The options parameter is an object which has a required externalId property where the external id should be placed.

Detailed overview:

Property Type Required Platform
externalId string Yes Both
sendDeviceInfo example
window.Selligent.sendDeviceInfo(
  function (response) { // success callback
    ...
  },
  function (error) { // error callback
    ...
  },
  {
    externalId: "an external id here"
  }
);

Selligent.enableGeolocation(successCallback, errorCallback, enabled)

Enable or disable geolocation services.

The enabled parameter is a required boolean to enable or disable geolocation services.

enableGeolocation example
window.Selligent.enableGeolocation(
  function (response) { // success callback
    ...
  },
  function (error) { // error callback
    ...
  },
  true
);

Selligent.isGeolocationEnabled(successCallback, errorCallback)

Check if geolocation services are enabled or disabled.

The response of the success callback is a boolean stating geolocation services are enabled or disabled.

isGeolocationEnabled example
window.Selligent.isGeolocationEnabled(
  function (response) { // success callback
    ...
  },
  function (error) { // error callback
    ...
  }
);

Selligent.enableNotifications(successCallback, errorCallback, enabled)

Enable or disable the usage of notifications.

The enabled parameter is a required boolean to enable or disable notifications.

enableNotifications example
window.Selligent.enableNotifications(
  function (response) { // success callback
    ...
  },
  function (error) { // error callback
    ...
  },
  true
);

Selligent.displayLastReceivedRemotePushNotification(successCallback, errorCallback)

Display the last received remote notification.

displayLastReceivedRemotePushNotification example
window.Selligent.displayLastReceivedRemotePushNotification(
  function (response) { // success callback
    ...
  },
  function (error) { // error callback
    ...
  }
);

Selligent.getLastRemotePushNotification(successCallback, errorCallback)

Get the id and the title of the last received remote push notification.

The response of the success callback is an object containing the information about the last received remote push notification, or null if there is no last received remote push notification.

Detailed overview:

Property Type Description
id string Id of the last remote push notification
title string Title of the last remote push notification
getLastRemotePushNotification Example
window.Selligent.getLastRemotePushNotification(
  function (response) { // success callback
    ...
  },
  function (error) { // error callback
    ...
  }
);

Selligent.enableInAppMessages(successCallback, errorCallback, options)

This method enables or disables the management of in-app messages.

The options parameter can be a boolean or a constant of the InAppMessageRefreshType enum.

In the case of a boolean set to false, the in-app messages will be disabled. When the passed options parameter is an InAppMessageRefreshType constant, the in-app messages will be enabled and the refresh frequency will be set to the provided value. The method will return an error if the parsed boolean is set to true, as to enable the in-app messages a refresh type is expected.

enableInAppMessages example
// to enable in-app messages
window.Selligent.enableInAppMessages(
    function (response) { // success callback
      ...
    },
    function (error) { // error callback
      ...
    },
    Selligent.InAppMessageRefreshType.DAY
);
// to disable in-app messages
window.Selligent.enableInAppMessages(
    function (response) { // success callback
      ...
    },
    function (error) { // error callback
      ...
    },
    false
);

Selligent.sendEvent(successCallback, errorCallback, event)

This method provides the functionality to send a specific or custom event.

The method accepts an event object which requires certain properties, depending on the type of the event.

Detailed overview:

Property Type Required Platform Default value
type enum EventType Yes Both N/A
email string Yes if event type is custom, ignored if non-custom Both N/A
data object Yes if event type is non-custom, optional if custom Both N/A
shouldCache boolean No iOS Only true

The type property is used to define the event as custom or specific event, using the EventType constants.

To define it as a custom event, one should use the Selligent.EventType.CUSTOM constant. All other event types can be used to define the event as something specific.

When an event is a custom event type, the event object requires an email property containing a string, and has an optional property data which is an object that can contain other information. When an event is a specific event type, the event object requires a data property containing an object which contains other information, and ignores the email property.

iOS specific:

On iOS the event object can contain an additional optional shouldCache property, which is a boolean that can be used to cache and retry sending events in situations where the event could not be delivered.

By default it is set to true, setting it to false will disable it.

sendEvent example
// send specific event
window.Selligent.sendEvent(
    function (response) { // success callback
      ...
    },
    function (error) { // error callback
      ...
    },
    {
      type: Selligent.EventType.BUTTON_CLICKED // specific event
      data: { // required
        id: 1337,
        randomFlag: true,
        description: "this is some extra information concerning this event"
      }
      email: "someone@somedomain.com" // ignored
    },
    shouldCache: false // iOS only, optional
);
// send custom event
window.Selligent.sendEvent(
    function (response) { // success callback
       ...
    },
    function (error) { // error callback
      ...
    },
    {
      type: Selligent.EventType.CUSTOM  // custom event
      data: { // optional
        id: 1337,
        someFlag: true,
        description: "this is some extra information concerning this event"
      }
      email: "someone@somedomain.com" // required
    }
);

Selligent.subscribeToEvents(successCallback, errorCallback)

This method is used to subscribe to events.

The response of the success callback is an object which contains information on the type of broadcast event and the data attached to it.

Detailed overview:

Property Type Description
broadcastEventType enum BroadcastEventType The type of broadcast event
data object Contains more information specific to the type of broadcast event

The data property is an object itself containing more information specific to the type of the broadcast event:

In case of a broadcast event type ButtonClicked the detailed overview for the data is as such:

Property Type Description
type iOS: enum iOSNotificationButtonType The type of notification button clicked
Android: integer
value string A certain value the broadcof ast event
id string A certain id of the event
label string A certain label of the event
data object Specific additional data of the event
action integer Specific action of the event

In case of a broadcast event type ReceivedInAppMessage the detailed overview for the data is as such:

Property Type Description
messages array List of messages

And the detailed overview for items in the messages array is as such:

Property Type Description
id string Id of a message
title string Title of a message

In case of a broadcast event type ReceivedGCMToken the detailed overview for the data is as such:

Property Type Description
token string The token attached to the event

In case of a broadcast event type ReceivedRemoteNotification the detailed overview for the data is as such:

Property Type Description
pushId string The id of the remote push notification
name string The name attached to the push notification

In case of a broadcast event type WillDisplayNotification or WillDismissNotification the data prop is null.

Android specific:

On the Android platform you can subscribe to custom events, by parsing an array of strings of these custom events. See the example for more information.

subscribeToEvents example
window.Selligent.subscribeToEvents(
    function (response) { // success callback
      ...
    },
    function (error) { // error callback
      ...
    },
    ["some custom event x", "navigated to page y", "accepted request z"] // optional, android only
);

Android Only/Specific Methods

Selligent.setApplication(successCallback, errorCallback)

Give a pointer of the Application instance to the SDK.

setApplication example
window.Selligent.setApplication(
    function (response) { // success callback
      ...
    },
    function (error) { // error callback
      ...
    }
);

Selligent.areInAppMessagesEnabled(successCallback, errorCallback)

Check if in-app messages are enabled or disabled.

The response of the success callback returns a boolean stating the in-app messages are enabled or disabled.

areInAppMessagesEnabled example
window.Selligent.areInAppMessagesEnabled(
    function (response) { // success callback
      ...
    },
    function (error) { // error callback
      ...
    }
);

Selligent.enableAndroidLogging(successCallback, errorCallback, enabled)

Display different actions and information logged by the SDK in the Android Studio logcat.

The enabled parameter is a boolean to effectively enable or disable logging.

enableAndroidLogging example
window.Selligent.enableAndroidLogging(
    function (response) { // success callback
      ...
    },
    function (error) { // error callback
      ...
    },
    true
);

Selligent.displayMessage(successCallback, errorCallback, messageId)

Display a specific in-app message. The method accepts a parameter messageId which is a string containing the id of the in-app message to display.

displayMessage example
window.Selligent.displayMessage(
    function (response) { // success callback
      ...
    },
    function (error) { // error callback
      ...
    },
    "some in-app message id"
);

Selligent.areNotificationsEnabled(successCallback, errorCallback)

Check if notifications are enabled or disabled.

The response of the success callback returns a boolean stating the notifications are enabled or disabled.

areNotificationsEnabled example
window.Selligent.areNotificationsEnabled(
    function (response) { // success callback
      ...
    },
    function (error) { // error callback
      ...
    }
);

Selligent.setNotificationSmallIcon(successCallback, errorCallback, iconName)

Set the small icon of a notification on Android.

The method accepts an iconName parameter which is a string containing the name of the small icon. When the application is closed it will default back to the icons specified in selligent.json.

Note: only parse the name of the icon, without the path. The icon should reside in the res/drawable folder of the Android project, as explained in Android's official guide.

setNotificationSmallIcon example
window.Selligent.setNotificationSmallIcon(
    function (response) { // success callback
      ...
    },
    function (error) { // error callback
      ...
    },
    "smallNotificationIcon"
);

Selligent.setNotificationLargeIcon(successCallback, errorCallback, iconName)

Set the large icon of a notification on Android.

The method accepts an iconName parameter which is a string containing the name of the large icon. When the application is closed it will default back to the icons specified in selligent.json.

Note: only parse the name of the icon, without the path. The icon should reside in the res/drawable folder of the Android project, as explained in Android's official guide.

setNotificationLargeIcon example
window.Selligent.setNotificationLargeIcon(
    function (response) { // success callback
      ...
    },
    function (error) { // error callback
      ...
    },
    "largeNotificationIcon"
);

Selligent.getGCMToken(successCallback, errorCallback)

Get the GCM token being used.

The response of the success callback is a string containing the GCM token.

getGCMToken Example
window.Selligent.getGCMToken(
  function (response) { // success callback
    ...
  },
  function (error) { // error callback
    ...
  }
);

Selligent.getRemoteMessagesDisplayType(successCallback, errorCallback)

Get the type of the remote messages that are being displayed.

The response of the success callback is a number corresponding with a constant of the AndroidRemoteMessagesDisplayType enum.

getRemoteMessagesDisplayType Example
window.Selligent.getRemoteMessagesDisplayType(
  function (response) { // success callback
    ...
  },
  function (error) { // error callback
    ...
  }
);

Selligent.setFirebaseToken(successCallback, errorCallback, token)

Set the firebase token manually.

setFirebaseToken example
window.Selligent.setFirebaseToken(
    function (response) { // success callback
      ...
    },
    function (error) { // error callback
      ...
    },
    '123xyz'
);

iOS Only/Specific Methods

Selligent.enableiOSLogging(successCallback, errorCallback, logLevels)

Display different actions and information logged by the SDK in the Android Studio logcat.

The logLevels parameter is an array of logging levels that you want to enable, using the Selligent.iOSLogLevel enum.

To disable a certain level, the existing array of the enabled logging level(s), minus the one you want to disable, should be passed to the method. To disable all log levels you need to use the iOSLogLevel.NONE constant. To enable all log levels use the iOSLogLevel.ALL constant.

enableiOSLogging example
// to enable logging of info, warning and error statements
window.Selligent.enableiOSLogging(
    function (response) { // success callback
      ...
    },
    function (error) { // error callback
      ...
    },
    [Selligent.iOSLogLevel.INFO, Selligent.iOSLogLevel.WARNING, Selligent.iOSLogLevel.ERROR]
);
// to disable all logging
window.Selligent.enableiOSLogging(
    function (response) { // success callback
      ...
    },
    function (error) { // error callback
      ...
    },
    [Selligent.iOSLogLevel.NONE]
);

Selligent.currentAuthorisationStatus(successCallback, errorCallback)

Get the current status of location authorisation.

The response of the success callback is a number corresponding with a constant of the Selligent.iOSLocationAuthorisationStatus enum.

currentAuthorisationStatus Example
window.Selligent.currentAuthorisationStatus(
  function (response) { // success callback
    ...
  },
  function (error) { // error callback
    ...
  }
);

Selligent.requestLocationAuthorisation(successCallback, errorCallback, iOSLocationAuthorisationType)

Request an authorisation of using location on a device.

The method accepts an iOSLocationAuthorisationType parameter to define the type of authorisation which should be requested as there are two possibilities: "in use" and "always". You can use constants of the Selligent.iOSLocationAuthorisationType enum to specify the authorisation request.

requestLocationAuthorisation Example
window.Selligent.requestLocationAuthorisation(
  function (response) { // success callback
    ...
  },
  function (error) { // error callback
    ...
  },
  Selligent.iOSLocationAuthorisationType.IN_USE
);

Selligent.displayNotification(successCallback, errorCallback, notificationId)

Display a notification based on its id, which is a string that needs to be parsed in the method with the notificationId parameter.

displayNotification Example
window.Selligent.displayNotification(
  function (response) { // success callback
    ...
  },
  function (error) { // error callback
    ...
  },
  "some notification id"
);

Selligent.registerRemoteNotificationFetchCompletionHandler(successCallback, errorCallback)

Register a completion handler for successfully fetching remote notifications.

The success callback is completion handler to be set.

registerRemoteNotificationFetchCompletionHandler example
window.Selligent.registerRemoteNotificationFetchCompletionHandler(
    function (response) { // success callback
      ...
    },
    function (error) { // error callback
      ...
    }
);

Selligent.forceRemoteNotificationBackgroundFetchResult(successCallback, errorCallback, iOSBackgroundFetchResult)

Force the result of a remote notification fetch to be a specific value.

forceRemoteNotificationBackgroundFetchResult example
window.Selligent.forceRemoteNotificationBackgroundFetchResult(
    function (response) { // success callback
      ...
    },
    function (error) { // error callback
      ...
    },
    Selligent.iOSBackgroundFetchResult.NEW_DATA
);

Constants

Selligent.ClearCacheIntervalValue

Defines the interval value to clear the cache.

Name Type Value Description
AUTO number 1 Clear cache automatically (on startup?)
NONE number 2 Don't clear cache
Android.DAY number 3 Clear cache daily, only available on Android
WEEK number 4 Clear cache weekly
MONTH number 5 Clear cache monthly
QUARTER number 6 Clear cache quarterly

Note: ClearCacheIntervalValue.Android.DAY is only used on Android and can not be used on iOS.

Selligent.InAppMessageRefreshType

Defines how often the SDK must retrieve the in-app messages.

Name Type Value Description
NONE number 10 Don't refresh the in-app messages
Android.MINUTE number 11 Refresh minutely (only on Android)
HOUR number 12 Refresh hourly
DAY number 13 Refresh weekly

Note: InAppMessageRefreshType.Android.MINUTE is only used on Android and can not be used on iOS.

Selligent.AndroidRemoteMessagesDisplayType

Defines if and how remote messages can be displayed on Android.

Name Type Value Description
AUTOMATIC number 20 Display remote messages automatically
NONE number 21 Don't display remote messages
NOTIFICATION number 22 Display remote messages as notification

Selligent.iOSLogLevel

Defines the level of output of logging messages on iOS.

Name Type Value Description
NONE number 50 Output nothing
INFO number 51 Output info
WARNING number 52 Output warning
ERROR number 52 Output error
HTTP_CALL number 52 Output http calls
LOCATION number 52 Output location
ALL number 52 Output all

Selligent.iOSBackgroundFetchResult

Description of the possible results of a background fetch on iOS.

Name Type Value Description
NEW_DATA number 60 Background fetch resulted in new data
NO_DATA number 61 Background fetch resulted in no new data
FAILED number 62 Background fetch failed

Selligent.iOSLocationAuthorisationStatus

Description of the possible status of use of location services on a device.

Name Type Value Description
UNKNOWN number 70 Status of use of location services is unknown
REFUSED number 71 Use of location services is refused
GRANTED_IN_USE number 72 Use of location services is granted when in use
GRANTED_ALWAYS number 72 Use of location services is always granted

Selligent.iOSLocationAuthorisationType

Defines the level of request for the authorisation of usage of location services on a device.

Name Type Value Description
IN_USE number 80 Request authorisation when location services are in use
ALWAYS number 81 Always request the authorisation of the location services

Selligent.EventType

Defines the type of an event.

Name Type Value Description
USER_REGISTER number 90 User registered
USER_UNREGISTER number 91 User unregistered
USER_LOGIN number 92 User logged in
USER_LOGOUT number 93 User logged out
CUSTOM number 94 Custom event

Selligent.iOSNotificationButtonType

Defines the type of button for notifications on iOS.

Name Type Value Description
UNKNOWN number 100 Unknown button type
SIMPLE_OPEN_PHONE_CALL number 101 Simple open phone call button type
OPEN_SMS number 102 Open sms button type
OPEN_MAIL number 103 Open mail button type
OPEN_BROWSER number 104 Open browser button type
OPEN_APPLICATION number 105 Open application button type
RATE_APPLICATION number 105 Rate application button type
CUSTOM_ACTION_BROADCAST_EVENT number 105 Custom action broadcast event button type
RETURN_TEXT number 105 Return text button type
RETURN_PHOTO number 105 Return photo button type
RETURN_TEXT_AND_PHOTO number 105 Return text and photo button type
PASSBOOK number 105 Passbook button type

Selligent.BroadcastEventType

Defines the type of a broadcast event.

Name Type Value Description
BUTTON_CLICKED string "ButtonClicked" A button was clicked
RECEIVED_IN_APP_MESSAGE string "ReceivedInAppMessage" An in-app message has been received
WILL_DISPLAY_NOTIFICATION string "WillDisplayNotification" A notification will be displayed
WILL_DISMISS_NOTIFICATION string "WillDismissNotification" A notification will be dismissed
Android.RECEIVED_GCM_TOKEN string "ReceivedGCMToken" A GCM token has been received (only on Android)
iOS.RECEIVED_REMOTE_NOTIFICATION string "ReceivedRemoteNotification" A remote notification has been received (only on iOS)

Notes: BroadcastEventType.Android.RECEIVED_GCM_TOKEN is only used on Android and can not be used on iOS. BroadcastEventType.iOS.RECEIVED_REMOTE_NOTIFICATION is only used on iOS and can not be used on Android.

You can’t perform that action at this time.