sherif95 / android-library

Urban Airship Android SDK

Android Airship SDK

Airship SDK for Android.

Resources

• Getting started guide
• Javadocs
• Migration Guides

Requirements

• minSdkVersion 21
• compileSdkVersion 31

Quickstart

1. Include Airship into the build.gradle file:

   dependencies {
     def airshipVersion = "16.6.0"

     // FCM push provider
     implementation "com.urbanairship.android:urbanairship-fcm:$airshipVersion"

     // Message Center
     implementation "com.urbanairship.android:urbanairship-message-center:$airshipVersion"

     // In-App Automation
     implementation "com.urbanairship.android:urbanairship-automation:$airshipVersion"
   }

2. Add Firebase to your app.

3. 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

   # 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"

4. 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 Airship SDK. Before running the sample, copy the file in sample/src/main/assets/airshipconfig.properties.sample to sample/src/main/assets/airshipconfig.properties and modify the properties to match your application's config.