WonderPush

Local intent broadcasted when the WonderPush SDK has been initialized and network is reachable.

Intent action for notification button action `method`.

Intent authority for notification button action `method`.

Intent query parameter key for the notification button action `method` argument.

Intent query parameter key for the notification button action `method` method name.

Intent scheme for notification button action `method`.

Local intent broadcasted when a push notification created by the WonderPush SDK has been opened.

The extra key for whether the user clicked the notification or it was automatically opened by the SDK in a INTENT_NOTIFICATION_OPENED intent.

The extra key for the original received push notification intent in a INTENT_NOTIFICATION_OPENED intent.

Local intent broadcasted when a push notification created by the WonderPush SDK is to be opened, but no activity is to be started. This let's you handle data notifications or any deep linking yourself.

The extra key denoting whether to automatically display a rich notification message in a INTENT_NOTIFICATION_WILL_OPEN intent. You can set this property to false in your BroadcastReceiver.

The extra key for whether the user clicked the notification or it was automatically opened by the SDK in a INTENT_NOTIFICATION_WILL_OPEN intent.

The extra key denoting the received push notification type, for a INTENT_NOTIFICATION_WILL_OPEN intent. You can test this property against INTENT_NOTIFICATION_WILL_OPEN_EXTRA_NOTIFICATION_TYPE_DATA in your BroadcastReceiver.

The value associated to data push notifications (aka silent notifications), corresponding to the extra key INTENT_NOTIFICATION_WILL_OPEN_EXTRA_NOTIFICATION_TYPE.

The extra key for the original received push notification intent in a INTENT_NOTIFICATION_WILL_OPEN intent.

Gets the device id, used to identify a single device across applications, and to correctly identify multiple users on a single device.

You should not call this method before initializing the SDK.

Because of the way our device id is build, it is populated asynchronously, so you may get a null response even a few moments after calling initialize(Context). You can either wait a bit (1 second should be enough on modern devices), or wait for isReady() to return true, which may take some more time on the first launch, especially is the network connection is bad.

Gets the device id, used to identify a single device across applications, and to correctly identify multiple users on a single device.

You should not call this method before the SDK is ready.

Gets the push token, used to send notification to this installation.

You should not call this method before initializing the SDK.

Gets the user id, used to identify a single identity across multiple devices, and to correctly identify multiple users on a single device.

You should not call this method before initializing the SDK.

Initialize WonderPush from your WonderPushInitializer implementation.

Prefer calling the simpler initialize(Context) function directly, as it will instantiate your WonderPushInitializer implementation which will in turn call this function. This way you concentrate the retrieval of your credentials from secure storage in a single location.

Initialize WonderPush.
Call this method before using WonderPush.

A good place to initialize WonderPush is in your main activity's onCreate(Bundle) method as follows:

protected void onCreate(Bundle savedInstance) {
    WonderPush.initialize(this);
}

This function will instantiate the WonderPushInitializer implementation you provided in your AndroidManifest.xml.
Please look at that interface documentation for detailed instruction.

Whether the SDK is ready to operate and the INTENT_INTIALIZED intent has been dispatched. The SDK is ready when it is initialized and has fetched an access token.

Method to be called in your own Google Cloud Messaging BroadcastReceiver to handle WonderPush push notifications.

Note: There is no need to call this method if you use WonderPushBroadcastReceiver, as advertised in the guide.

Implement your BroadcastReceiver.onReceive(Context, Intent) method as follows:

public void onReceive(Context context, Intent intent) {
    if (WonderPush.onBroadcastReceived(context, intent, R.drawable.icon, YourMainActivity.class)) {
        return;
    }
    // Do your own handling here
}

For more information about Google Cloud Messaging visit: http://developer.android.com/google/gcm/index.html.

Update the custom properties attached to the current installation object stored by WonderPush.

In order to remove a value, don't forget to use the JSONObject.NULL object as value.

Sets the user id, used to identify a single identity across multiple devices, and to correctly identify multiple users on a single device.

If not called, the last used user id it assumed. Defaulting to null if none is known.

Prefer calling this method just before calling initialize(Context), rather than just after.

Upon changing userId, the access token is wiped, so avoid unnecessary calls, like calling with null just before calling with a user id.

Method to call on your onNewIntent() and onCreate() methods to handle the WonderPush notification.

Starting from API 14, there is no need to call this method, but it won't hurt if you do.

This method is automatically called from within initialize(Context), so calling this method after calling initialize(Context) is useless.

Example:

 
 @Override
 protected void onCreate(Bundle savedInstance) {
     // In case you call WonderPush.initialize() from your custom Application class,
     // and you target API < 14, you can either call WonderPush.initialize() once again here
     // or call this method instead.
     WonderPush.showPotentialNotification(this, getIntent());
 }

 @Override
 protected void onNewIntent(Intent intent) {
     WonderPush.showPotentialNotification(this, intent);
 }
 
 

Send an event to be tracked to WonderPush.

Send an event to be tracked to WonderPush.