Intercom for Android, for integrating Intercom into your Android application.
Branch: master
Clone or download
nymerias Merge pull request #508 from intercom/nicolette/readme-update
Update README to use "implementation" rather than "compile" when adding dependencies
Latest commit c60b2d3 Feb 6, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Adding issue template Mar 7, 2016
aar Release 5.2.0 Dec 4, 2018
docs Release 5.2.0 Dec 4, 2018
samples Remove GCM sample Dec 4, 2018
.gitignore Removed OS-generated file and added a .gitignore file to ensure they … Apr 19, 2016
CHANGELOG.md Release 5.2.0 Dec 4, 2018
LICENSE Update LICENSE Mar 27, 2017
README.md Change configuration `compile` to `implementation` Feb 4, 2019

README.md

Intercom

Onboard, retain and support mobile users at scale

Engage customers with email, push, and in‑app messages and support them with an integrated knowledge base and help desk.

Intercom for Android supports API 15 and above.

Installation

There are 2 options for installing Intercom on your Android app.

Option 1: Install Intercom with Firebase Cloud Messaging (FCM)

Add the following dependency to your app's build.gradle file:

dependencies {
    implementation 'io.intercom.android:intercom-sdk-base:5.+'
    implementation 'io.intercom.android:intercom-sdk-fcm:5.+'
}

Option 2: Install Intercom without Push Messaging

If you'd rather not have push notifications in your app, you can use this dependency:

dependencies {
    implementation 'io.intercom.android:intercom-sdk-base:5.+'
}

Customer Support

👋 Contact us with any issues at Intercom Developer Hub available here. If you bump into any problems or need more support, just start a conversation using Intercom there and it will be immediately routed to our Customer Support Engineers.

Sample Apps

A project with some basic example integrations is provided here.

Setup and Configuration

  • Our installation guide contains full setup and initialisation instructions.
  • The configuration guide provides info on how to configure Intercom for Android.
  • Read our guide on Push Notifications for FCM.
  • Please contact us on Intercom with any questions you may have, we're only a message away!

ProGuard

If you are using ProGuard, add the following rules:

-keep class io.intercom.android.** { *; }
-keep class com.intercom.** { *; }

You might also need to add rules for OkHttp, Okio and Retrofit which are dependencies used in this library.

Cordova/Phonegap Support

Looking for Cordova/Phonegap support? We have a Cordova Plugin for Intercom 🎉

Permissions

We include the INTERNET permission by default as we need it to make network requests:

<uses-permission android:name="android.permission.INTERNET"/>

Optional permissions:

<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.MANAGE_DOCUMENTS"/>

READ_EXTERNAL_STORAGE and MANAGE_DOCUMENTS are used for attachments.

You can also include VIBRATE to enable vibration in push notifications:

<uses-permission android:name="android.permission.VIBRATE"/>

Dependency graph

Here is our complete dependency graph:

intercom-sdk-base

# Transitive (shared with your app)
com.android.support:design:28.0.0
com.android.support:appcompat-v7:28.0.0
com.android.support:animated-vector-drawable:28.0.0
com.android.support:support-vector-drawable:28.0.0
com.android.support:support-compat:28.0.0
com.android.support:support-core-utils:28.0.0
com.android.support:support-core-ui:28.0.0
com.android.support:support-fragment:28.0.0
com.android.support:support-annotations:28.0.0
com.android.support:recyclerview-v7:28.0.0

# Repackaged (not shared with your app)
com.squareup:otto:1.3.8
com.github.bumptech.glide:glide:4.4.0
com.github.bumptech.glide:gifdecoder:4.4.0
com.github.bumptech.glide:disklrucache:4.4.0
com.github.bumptech.glide:annotations:4.4.0
com.squareup.okio:okio:1.14.0
com.squareup.okhttp3:okhttp:3.9.1
com.squareup.retrofit2:retrofit:2.3.0
com.squareup.retrofit2:converter-gson:2.3.0
com.google.code.gson:gson:2.8.2

If you use some of the repackaged libraries in your app, you may want to use a build that depends on them transitively. A guide to using this build can be found here. Using this build involves more work as you need to make sure your app uses the correct version of each library.

intercom-sdk-fcm

com.google.firebase:firebase-messaging:17.3.4