Urban Airship Android SDK
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Android Urban Airship SDK

Urban Airship SDK for Android.

Resources

Contributing Code

We accept pull requests! If you would like to submit a pull request, please fill out and submit our Contributor License Agreement.

One of our engineers will verify receipt of the agreement before approving your pull request.

Requirements

  • minSdkVersion 16+
  • compileSdkVersion 27

Quickstart

  1. Include Urban Airship into the build.gradle file:
   dependencies {
     ...

     // Urban Airship SDK - FCM
     implementation 'com.urbanairship.android:urbanairship-fcm:9.5.1'
     implementation 'com.google.firebase:firebase-core:16.0.1'
   }
  1. Add Firebase to your app.

  2. Create a new airshipconfig.properties file with your application’s settings:

   developmentAppKey = Your Development App Key
   developmentAppSecret = Your Development App Secret

   productionAppKey = Your Production App Key
   productionAppSecret = Your Production Secret

   # Toggles between the development and production app credentials
   # Before submitting your application to an app store set to true
   inProduction = false

   # LogLevel is "VERBOSE", "DEBUG", "INFO", "WARN", "ERROR" or "ASSERT"
   developmentLogLevel = DEBUG
   productionLogLevel = ERROR

   # Notification customization
   notificationIcon = ic_notification
   notificationAccentColor = #ff0000

   # Optional - Set the default channel
   notificationChannel = "customChannel"
  1. Set the Autopilot meta-data in the AndroidManifest.xml file:
      <meta-data android:name="com.urbanairship.autopilot"
               android:value="com.urbanairship.Autopilot"/>

Sample Application

A sample application is available that showcases the majority of the features offered by the Urban Airship SDK. Before running the sample, copy the file in sample/src/main/assets/airshipconfig.properites.sample to sample/src/main/assets/airshipconfig.properties and modify the properties to match your application's config.

Sample Test

An automated test is available to test basic pushes, message center and in-app messages with the Sample application.

To run the test suite on an emulator or device with API 21+:

./gradlew connectedAndroidTest -Pandroid.testInstrumentationRunnerArguments.appKey="APP_KEY" -Pandroid.testInstrumentationRunnerArguments.masterSecret="MASTER_SECRET"