ansergit / push-android-samples

Pivotal CF Mobile Services Push SDK Samples for Android

Push SDK Usage

For more information please visit the docs site

IMPORTANT: Please note that you should be able to build both of the apps below without any modification HOWEVER you will need to change the pivotal.properties file to point the SDK to your own PCF Push Notification Server install. The default build is usually set up to point to a test server and it will not likely work under your conditions.

Push Demo Application

The Push Demo Application is an example of the simplest application possible that uses the Pivotal CF Mobile Services Push Client SDK. At this time, it only demonstrates how to register for push notifications.

This demo application registers for push notifications in the Activity object in order to make it easier to display the output on the screen. It is probably more appropriate for you to register for push notifications in your Application object instead.

This application is set up to receive push messages via the PushService class. These messages are not displayed in the activity window, but they will display a status bar notification.

Push Sample Application

There is a small sample application included in this repository to demonstrate and exercise the features in the Push Client SDK.

You can use this sample application to test registration against Firebase Cloud Messaging (FCM) and the Pivotal CF Mobile Services server for push messages. Any push messages that are received are printed to the log window. Although not currently supported by the library itself, you can also send push messages with the sample application itself.

At this time, the sample application uses a dummy project on Firebase Console. It is recommend that you create your own test Firebase Project by following the directions at https://firebase.google.com/docs/android/setup.

You can build this project directly from the command line using Gradle or in Android Studio.

IMPORTANT: Before building this project you need to build Push Android SDK by

./gradlew --info printVersion clean uploadArchives

It will build and publish .aar and .pom to your local maven repository.

You can save your own project details by editing the values in the sample project's push_default_preferences.xml resource files.

Watch the log output in the sample application's display to see what the Push SDK is doing in the background. This log output should also be visible in the Android device log (for debug builds), but the sample application registers a "listener" with the Push Library's logger so it can show you what's going on.

Rotate the display to landscape mode to see the captions for the action bar buttons.

Press the Register button in the sample application action bar to ask the Push SDK to register the device. If the device is not already registered, then you should see a lot of output scroll by as the library registers Pivotal CF Mobile Services. If the device is already registered then the output should be shorter.

Press the Unregister button in the sample application action bar to ask the Push SDK to unregister the device. This unregister option will unregister with Pivotal CF Mobile Services.

You can clear all or parts of the saved registration data with the Clear Registration action bar option. Clearing part or all of the registration data will cause a partial or complete re-registration the next time you press the Register button. Unlike the Unregister button, the Clear Registration button simply causes the Push Client SDK to "forget" that it is registered. Both FCM and Pivotal CF Mobile Services will still think that the device is registered.

You can change the registration preferences at run-time by selecting the Edit Preferences action bar item. Selecting this item will load the Preferences screen. There's no space to describe the options on the Preferences screen itself, but you can look in the push_default_preferences.xml resource file for more details.

You can reset the registration preferences to the default values by selecting the Reset to Defaults action bar item in the Preferences screen.

The sample application is also set up to receive push messages once the device has been registered with FCM and the Pivotal CF Mobile Services. Any messages that are received are printed to the log window.

Although the Push Client SDK has no support for sending push messages, the Push Sample App can do it for you as long as it is set up with the correct FCM Server Key parameter (when sending messages via FCM), or the correct Environment UUID and Environment Key parameters (when sending messages via Pivotal CF Mobile Services). The application can not distinguish between messages sent via the two services.