Last Updated:




This is an Android SDK for handling push integration with the Vibes Platform APIs.

The compiled Android SDK is available on the Vibes GitHub Repository.

Note: You can reference the Android SDK code here.

Installing the Android SDK

  1. Click Add Firebase and follow the instructions on the Firebase website. This will include setting up the Google Services plugin and downloading the google-services.json into your App folder.

  2. Click Add Firebase Cloud Messaging and follow the instructions. This will include adding two services to your app to handle app token refresh and incoming push notifications.

  3. Add the Vibes SDK by doing the following:

    1. Add the following to your project-level build.gradle file:

      maven {
          url "https://raw.githubusercontent.com/vibes/android-sdk-repository/releases/"
      }


    2. Add the following to your app-level build.gradle file:

      dependencies {
         // other dependencies here
         compile "com.vibes.vibes:vibes:4.0.0"
      }

       

  4. Sync your project in Android Studio.

Configuring Multiple Environments 

Build Variants

To support a separate test build from your production build in android, we recommend creating build variants for your different environments. Follow this documentation to learn more and configure build variants.

Once you have the build variants created, you can edit your build.gradle file to include your global constants for Vibes app ID and Vibes API URL.


FCM Setup 

Vibes uses Firebase Cloud Messaging (FCM) as the push transport method for Android devices that have access to the Google Play store.


Creating FCM Server Key

  1. Log in to the Firebase console.
  2. Either create a new project or open an existing project that you want to configure with Vibes.
  3. In the left side menu, click on the gear icon and select Project settings.


  4. Select Cloud Messaging tab from the the top of the screen, then copy the Server key which you will provide to Vibes for configuration of your application. You may also add a new server key if it is not automatically created for you or if you wish to use a different one.