Home

Awesome

Android helloPush Sample Application for IBM Cloud Push Notifications Services

This Android helloPush sample contains an Android project that you can use to learn more about the IBM Cloud Push Notification Service.

Use the following steps to configure the helloPush sample for Android:

  1. Download the helloPush sample.
  2. Create and Configure Push Notification Service.
  3. Configure the helloPush sample.
  4. Run the Android app.

Requirements

Before you begin

Before you start, make sure you have the following:

Note: You'll need the project number (Sender ID) and API key to configure your credentials on the IBM Cloud Push Notification Dashboard.

Download the helloPush sample

Clone the sample from GitHub using the following command:

git clone https://github.com/ibm-bluemix-mobile-services/bms-samples-android-hellopush

Setup

Before you can run the helloPush application, you must set up an app on Bluemix. The following procedure shows you how to create a IBM Cloud push notifications Services.

Create and Configure Push Notification Service
  1. Go to Catalog page of IBM Cloud and create Puhs notifications service instance
  2. In the Configuration tab you will now need to configure your Push Notification Service.
  3. Navigate to the GCM/FCM Push Credentials section. Enter your GCM project credentials, project number (Sender ID) and API key, and click save.

Configure the helloPush sample

  1. In Android Studio, open the helloPush Android project.

  2. Download Firebase google-services.json for android, and place them in the root folder of the project.

  3. Run a Gradle sync (usually starts automatically) to import the required core and push SDKs. You can view the build.gradle file in the following directory:

    helloPush\app\build.gradle

  4. Open the MainActivity.java class.

  5. In the application onCreate method, add the corresponding App Guid and Client Secret that you saved earlier to your push.init function:

	@Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // initialize core SDK with IBM Cloud application Region, TODO: Update region if not using IBM Cloud US SOUTH
        BMSClient.getInstance().initialize(this, BMSClient.REGION_US_SOUTH);

        // Grabs push client sdk instance
        push = MFPPush.getInstance();
        push.initialize(this, "<APP_GUID>", "<CLIENT_SECRET>");

Note: If your IBM Cloud Push Service is not hosted in US_SOUTH, be sure to update the region parameter appropriately: BMSClient.REGION_SYDNEY or BMSClient.REGION_UK.

Other features

Run the Android app

You can register and receive push notifications on an Android simulator or physical device.

When you run the application, it displays the Register for Push button. When you click this button, the application attempts to register the device and application to the Push Notification Service. The app displays an alert showing the registration status (successful or failed).

To send a push notification from the IBM Cloud Push Sotifications Service dashboard. Follow Sending basic push notifications

When a push notification is received and the application is in the foreground, an alert is displayed showing the notification's content. The application uses the App Guid and Client Secret specified in the onCreate method to connect to the IBM Push Notification Service on IBM Cloud and associate a unigue User Id. The registration status and content is displayed in the logcat console and on screen.

Samples & videos

License

This package contains sample code provided in source code form. The samples are licensed under the under the Apache License, Version 2.0 (the "License"). You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 and may also view the license in the license.txt file within this package. Also see the notices.txt file within this package for additional notices.