Git Product home page Git Product logo

appboy-android-sdk's Introduction

Appboy Logo

Android SDK

Successful marketing automation is essential to the future of your mobile app. Appboy helps you engage your users beyond the download. Visit the following links for details and we'll have you up and running in no time!

Components

  • android-sdk-ui - the Appboy SDK user interface containing the Appboy jar.
  • wear-library - a small library to support the Appboy SDK on Android Wear devices.
  • droidboy - a sample application which demonstrates how to use Appboy.
  • hello-appboy - a sample gradle application demonstrating a simple use case of Appboy.
  • wearboy - a sample Android Wear app demonstrating Appboy SDK support for Wear devices.

Building and Running the Sample Applications

  1. Make sure the ANDROID_HOME environment variable is set to the location of your installed SDK or you have a local.properties file which defines the sdk.dir property. You can check this by running echo $ANDROID_HOME, or echo %ANDROID_HOME% in Windows.
  2. When you run your first build, the android-sdk-manager plugin will automatically install the proper Android build tools, setup your Android Support Library repository, etc. If you don't have your ANDROID_HOME variable properly set or don't have a local.properties folder with a valid sdk.dir folder, this plugin will also install the base SDK for you. Other than a bit of wasted disk space, it isn't bad if the plugin re-installs your Android SDK (it'll put it in ~/.android-sdk if you want to move it or delete it later), but either way, it's cleaner to have your ANDROID_HOME properly set before running the build. See the plugin repo for more information.
  3. To assemble the UI library and the Droidboy APK, run ./gradlew assemble (use gradlew.bat on Windows). You can find assembled files in the build/ subdirectories of the android-sdk-ui and droidboy projects. You can also use the installDebug task if you have a device or emulator connected to adb and want to run Droidboy or Hello-Appboy. You can see other available tasks by running ./gradlew tasks.

Remote repository for gradle

The version should match the git version tag, or the most recent version noted in the changelog. An example dependency declaration is:

repositories {
   maven { url "http://appboy.github.io/appboy-android-sdk/sdk" }
   ...
}
dependencies {
   compile 'com.appboy:android-sdk-ui:1.13.+'
   ...
}

Installing android-sdk-ui to Your Local Maven Repository

To install the UI library as an AAR file to your local maven repository, run the install task with ./gradlew install. You can reference it with groupId com.appboy and artifactId android-sdk-ui. The version should match the git version tag, or the most recent version noted in the changelog. An example dependency declaration is:

repositories {
   mavenLocal()
   ...
}
dependencies {
  compile 'com.appboy:android-sdk-ui:1.13.+'
}

Using wear-library in Your Android Wear App

We have included a sample Wear app in this project. As a reference, the main app is Droidboy and the Wear App is wearboy.

  1. Copy the wear-library module into your project.
  2. Register the AppboyWearableListenerService in your main app's manifest (see Droidboy's manifest.xml).
  3. Obtain an instance of the AppboyWearableAdapter in your Wear app to use a subset of methods of the Appboy singleton. See the Wearboy sample app.
  4. The feature "android.hardware.type.watch" must be declared in your Wear app's manifest for sdk actions to be properly logged from the watch.

Version Support

The Android SDK supports Android 2.3+ (Gingerbread and up).

Appboy uses Font Awesome 4.3.0 for in-app message icons. Check out the cheat sheet to browse available icons.

Appboy requires Facebook's Fresco image library to display animated gif images. Fresco is not included nor enabled by default in the Appboy library, and must be included and enabled explicitly by the parent app. Appboy supports Fresco 0.6.0 through 0.9.0.

Questions?

If you have questions, please contact [email protected].

appboy-android-sdk's People

Contributors

briancaw avatar martinmcroyappboy avatar billmag avatar bucimis avatar radixdev avatar tobiblas avatar marchy avatar matrixy avatar

Watchers

James Cloos avatar Annika Dunaway avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.