The WonderPush Developer Hub

Welcome to the WonderPush developer hub. You'll find comprehensive guides and documentation to help you start working with WonderPush as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Cordova SDK Reference

Cordova SDK Reference

### Configuration options
CLIENT_IDREQUIRED. The client ID found in your WonderPush dashboard.
CLIENT_SECRETREQUIRED. The client secret found in your WonderPush dashboard.
SENDER_IDThe sender ID found in your Firebase Cloud Messaging settings.
LOGGINGControls debug logging. Defaults to false.
REQUIRES_USER_CONSENTControls whether user consent is required for the SDK to operate. Defaults to false.
### Subscribing users
subscribeToNotificationsPrompts user to subscribe to web push notifications.
unsubscribeFromNotificationsUnsubscribes user from web push notifications.
isSubscribedToNotificationsTells whether user is subscribed to web push notifications.
### Segmentation
trackEventSends an event with a name and payload of your choice.
addTagAdds one or more tags to this installation.
removeTagRemoves one or more tags from this installation.
removeAllTagsRemoves all tags from this installation.
hasTagTests whether a given tag is attached to this installation.
getTagsReturns all the tags attached of this installation.
getPropertyValueReturns the value of a given property associated to this installation.
getPropertyValuesReturns an immutable list of the values of a given property associated to this installation.
addPropertyAdds the value to a given property associated to this installation.
removePropertyRemoves the value from a given property associated to this installation.
setPropertySets the value to a given property associated to this installation.
unsetPropertyRemoves the value of a given property associated to this installation.
putPropertiesAssociates the provided name/value pairs to this installation.
getPropertiesReturns all the name/value pairs associated to this installation using putProperties.
### User IDs
setUserIdAssigns your own user ID to an installation.
getUserIdReturns the user ID you've assigned to this installation if any.
### Installation info
getInstallationIdReturns the installationId identifying this installation in your application.
getPushTokenReturns the push token (also called registration id by FCM).
### Privacy
setUserConsentProvides privacy consent.
clearEventsHistoryClears all events recorded using trackEvent.
clearPreferencesClears all the name/value pairs associated to this installation using putProperties.
clearAllDataDeletes any event, installation and potential user objects associated with all installations present on the device.
downloadAllDataInitiates the download of all the WonderPush data related to the current installation, in JSON format.
### Debug
setLoggingEnables or disables verbose logging of WonderPush.

Configuration options

Configuring the WonderPush Cordova SDK is done when you add it to your Cordova project, like this:

cordova plugin add wonderpush-cordova-sdk --variable CONFIGURATION_OPTION=VALUE --variable OTHER_CONFIGURATION_OPTION=OTHER_VALUE

🚧

Make sure you specify all the required options at once. That means CLIENT_ID and CLIENT_SECRET at least.

CLIENT_ID

REQUIRED. The client id is used to identify the WonderPush project to work on.

cordova plugin add wonderpush-cordova-sdk --variable CLIENT_ID=VALUE

CLIENT_SECRET

REQUIRED. The client secret used to secure network calls.

cordova plugin add wonderpush-cordova-sdk --variable CLIENT_SECRET=VALUE

SENDER_ID

The Firebase FCM Sender ID used to register to push notifications.
By default, the SDK will use the Sender ID of the Firebase account integrated into your app if any, or will fall back to WonderPush own Sender ID, which is convenient but cannot offer push token portability.

cordova plugin add wonderpush-cordova-sdk --variable SENDER_ID=VALUE

LOGGING

Controls debug logging.
The default is false.

cordova plugin add wonderpush-cordova-sdk --variable LOGGING=VALUE

📘

You can set this at runtime using the setLogging() method.

REQUIRES_USER_CONSENT

Controls whether user consent is required before doing anything.
The default is false.

cordova plugin add wonderpush-cordova-sdk --variable REQUIRES_USER_CONSENT=true

Subscribing users

subscribeToNotifications

Subscribes to push notifications. Accepts an optional callback argument, called upon successful subscription.

WonderPush.subscribeToNotifications(function() {
  console.log("User subscribed to notifications");
});

unsubscribeFromNotifications

Unsubscribes from push notifications. Accepts an optional callback argument, called upon successful unsubscription.
This method marks the user as soft opt-out.

WonderPush.unsubscribeFromNotifications(function() {
  console.log("User unsubscribed");
});

isSubscribedToNotifications

Accepts a callback argument called with a boolean, true meaning that the user is subscribed to notifications, false if user hasn't subscribed, has unsubscribed or if consent is required and not granted.

WonderPush.isSubscribedToNotifications(function(isSubscribed) {
  console.log(isSubscribed ? "User is subscribed" : "User is not subscribed");
});

Segmentation

Segmentation functions allow you to mark installations so they can be added to segments and you can send them targeted notifications later.

There are many ways of performing segmentation:

Tags are like labels you can stick on users. Use tags to create segments in your dashboard and send targeted push notifications. Example: all users that have the "customer" tag.

Events have a date, a type of your choice and attributes. Use events to create segments in your dashboard and send targeted push notifications. Example: all users that purchased in the last hour is a typical event-based segment.

Installation properties represent traits of the user. That's a good place to store age, gender and other data traditionally used for segmentation. Create property-based segments in your dashboard. Example: all users above 18 is a typical property-based segment.

trackEvent

Tracks a custom event of your choice. E.g. purchase.

ParameterTypeDescription
typeStringRequired The type of the event to track. Event names starting with @ are reserved for internal use and cannot be used here.
attributesObjectOptional. Attributes associated with this event. See format of property names for detailed syntax.
callbackFunctionOptional. A success callback.

Example:

var attributes = {
  string_product: "Some product",
  float_price: 1.99,
};
WonderPush.trackEvent("purchase", attributes, function() {
  console.log("Event tracked");
});

addTag

Adds one or more tags to the current installation.

ParameterTypeDescription
tagString or Array of stringsA single tag, or an array of tags to be added.
callbackFunctionOptional. A success callback.
WonderPush.addTag("customer", function() {
    console.log("Success");
});

WonderPush.addTag(["economics", "sport", "politics"], function() {
    console.log("Success");
});

removeTag

Removes one or more tags from the current installation.

ParameterTypeDescription
tagString or Array of stringsA tag, or list of tags, to be removed.
callbackFunctionOptional. A success callback.
WonderPush.removeTag("customer", function() {
    console.log("Success");
});

WonderPush.removeTag(["economics", "sport", "politics"], function() {
    console.log("Success");
});

removeAllTags

Removes all tags from the current installation.

ParameterTypeDescription
callbackFunctionOptional. A success callback.
WonderPush.removeAllTags(function() {
  console.log("Success");
});

hasTag

Tests whether a given tag is attached to the current installation.

ParameterTypeDescription
tagStringThe tag to test.
callbackFunctionA callback accepting a Boolean as single argument representing the result of the check.
WonderPush.hasTag("customer", function(hasTag) {
  console.log(hasTag ? "User is a customer" : "User is not a customer");
});

getTags

Accepts a callback and calls it with all the tags attached to the current installation as an array of strings.

ParameterTypeDescription
callbackFunctionA function accepting an array of strings as single argument.
WonderPush.getTags(function(tags) {
    console.log("User tags:", tags.join(', '));
});

getPropertyValue

Accepts a property name and a callback. Calls the callback with the value of the given property associated to the current installation.

If the property stores an array, only the first value is returned. This way you don't have to deal with potential arrays if that property is not supposed to hold one. Returns null if the property is absent or has an empty array value.

ParameterTypeDescription
propertyStringThe name of the property whose value we'll retrieve
callbackFunctionA callback accepting a single value argument
WonderPush.getPropertyValue("string_lastname", function(value) {
  console.log("Last name is", value);
});

getPropertyValues

Returns an list of the values of a given property associated to the current installation.

If the property does not store an array, an array is returned nevertheless. This way you don't have to deal with potential scalar values if that property is supposed to hold an array. Returns an empty array instead null if the property is absent. Returns an array wrapping any scalar value held by the property.

WonderPush.getPropertyValues("string_favoritePlayers", function(values) {
  console.log("Favorite players:", values.join(", "));
});

addProperty

Adds the value to a given property associated to the current installation.

The stored value is made an array if not already one. If the given value is an array, all its values are added. If a value is already present in the stored value, it won't be added.

See format of property names for detailed syntax.

ParameterTypeDescription
nameStringThe name of the property.
valueScalar or ArrayThe value to add
callbackFunctionOptional. A success callback.
// You can add a single value
WonderPush.addProperty("string_interests", "sports", function() {
  console.log("Success");
});

// You can add an array of values
WonderPush.addProperty("string_interests", ["sports", "entertainment"], function() {
  console.log("Success");
});

removeProperty

Removes the value from a given property associated to the current installation.

The stored value is made an array if not already one. If the given value is an array, all the given values are removed, even if it is present multiple times.

ParameterTypeDescription
nameStringThe name of the property
valueScalar or ArrayThe value to remove
callbackFunctionOptional. A success callback.
// You can remove a single value
WonderPush.removeProperty("string_interests", "sports", function() {
  console.log("Success");
});

// You can remove an array of values
WonderPush.removeProperty("string_interests", ["sports", "entertainment"], function() {
  console.log("Success");
});

setProperty

Sets the value to a given property associated to the current installation.

The previous value is replaced entirely. The value can be a String, Boolean, Number, Object, Array (which has the same effect as unsetProperty).

See format of property names for detailed syntax.

ParameterTypeDescription
nameStringThe name of the property
valueScalar or ArrayThe value to set
callbackFunctionOptional. A success callback.
// You can set a single value
WonderPush.setProperty("bool_isCustomer", true, function() {
  console.log("Success");
});

// You can remove a field using null
WonderPush.setProperty("int_age", null, function() {
  console.log("Success");
});

// You can set an array of values
WonderPush.setProperty("string_interests", ["sports", "entertainment"], function() {
  console.log("Success");
});

unsetProperty

Removes the value of a given property associated to the current installation.

The previous value is replaced with null.

ParameterTypeDescription
nameStringThe property to unset.
callbackFunctionOptional. A success callback.
WonderPush.unsetProperty("string_favoritePlayers", function() {
  console.log("Success");
});

putProperties

Updates the properties of the current installation. Omitting a previously set property leaves it untouched. To remove a property, you must pass it explicitly with a value of null.

ParameterTypeDescription
propertiesObjectProperties to add or update. See format of property names for detailed syntax.
callbackFunctionOptional. A success callback

Example:

var properties = {
  int_age: 34,
  string_name: "John Doe",
};
WonderPush.putProperties(properties, function() {
  console.log("Success");
});

getProperties

Accepts a callback, called with an object containing the properties of the current installation.

ParameterTypeDescription
callbackFunctionThe callback accepting a single object as argument containing the properties.

For example:

WonderPush.getProperties(function(properties) {
  console.log("Properties: ", properties);
});

setUserId

Assigns your own user ID to an installation. See User IDs.

ParameterTypeDescription
userIdStringThe user ID.
callbackFunctionOptional. A success callback.

Example:

WonderPush.setUserId("YOUR_OWN_USER_ID", function() {
  console.log("Success");
});

getUserId

Accepts a callback as unique argument, and calls it the user ID you've assigned to this installation if any.

ParameterTypeDescription
callbackFunctionA callback accepting a single argument of type String or null.

Example:

WonderPush.getUserId(function(userId) {
  console.log("User ID:", userId);
});

Installation info

getInstallationId

Accepts a callback as unique argument, and calls it the installation ID.

ParameterTypeDescription
callbackFunctionA callback accepting a single argument of type String.

Example:

WonderPush.getInstallationId(function(installationId) {
  console.log("Installation ID:", installationId);
});

getPushToken

Accepts a callback as unique argument, and calls it the push token (device token) of this installation if any.

ParameterTypeDescription
callbackFunctionA callback accepting a single argument of type String or null.

Example:

WonderPush.getPushToken(function(pushToken) {
  console.log("Push token:", pushToken);
});

Privacy

setUserConsent

Sets user privacy consent.

Works in conjunction with the REQUIRES_USER_CONSENT configuration option.

If user consent is required, the SDK takes no action until user consent it provided by calling setUserConsent(true). Calling setUserConsent(false) blocks the SDK again.

ParameterTypeDescription
consentBooleanWhether the user gave his/her consent.
callbackFunctionOptional. A success callback.

Example:

WonderPush.setUserConsent(true, function() {
  console.log("Success");
});

clearEventsHistory

Instructs to delete any event associated with the all installations present on the device, locally and on WonderPush servers.

ParameterTypeDescription
callbackFunctionOptional. A success callback.

Example:

WonderPush.clearEventsHistory(function() {
  console.log("Success");
});

clearPreferences

Instructs to delete any custom data (including installation properties) associated with the all installations present on the device, locally and on WonderPush servers.

ParameterTypeDescription
callbackFunctionOptional. A success callback.

Example:

WonderPush.clearPreferences(function() {
  console.log("Success");
});

clearAllData

Instructs to delete any event, installation and potential user objects associated with all installations present on the device, locally and on WonderPush servers.

ParameterTypeDescription
callbackFunctionOptional. A success callback.

Example:

WonderPush.clearAllData(function() {
  console.log("Success");
});

downloadAllData

Initiates the download of all the WonderPush data relative to the current installation, as JSON.

ParameterTypeDescription
callbackFunctionA callback accepting a single argument: the user data.

Example:

WonderPush.downloadAllData(function(userData) {
  console.log("User data:", userData);
});

Debug

setLogging

ParameterTypeDescription
enableBooleanWhether to enable verbose logging of the WonderPush SDK.
callbackFunctionOptional. A success callback.

Enables or disables verbose logging of WonderPush.

WonderPush.setLogging(true, function() {
  console.log("Success");
});

Updated about a month ago

Cordova SDK Reference


Cordova SDK Reference

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.