Iterable's Android SDK

​

​ The Iterable Android SDK is a Java implementation of an Android client for Iterable.

​

​

# Table of contents

# Installing the SDK

1. Add Iterable Android SDK in your project

2. Add Firebase Messaging Service support for your project ​ To add Iterable SDK and Firebase messaging in your project, add the following dependencies to your application's build.gradle in dependencies block: ​

dependencies{
    implementation 'com.iterable:iterableapi:3.2.0'
    implementation 'com.google.firebase:firebase-messaging:X.X.X' // Min version 17.4.0 this is required for push notifications and in-app messaging features
}

​ See Bintray for the latest version of the Iterable Android SDK. ​

# Initialize the SDK

# Configure

1. In the onCreate method of the Application, initialize the Iterable SDK:

   IterableConfig config = new IterableConfig.Builder()
           .setPushIntegrationName("myPushIntegration")
           .build();
   IterableApi.initialize(context, "<your-api-key>", config);
   

   The apiKey should correspond to the API key of your project in Iterable. If you'd like, you can specify a different apiKey depending on whether you're building in DEBUG or PRODUCTION, and point the SDK to the relevant Iterable project.

   NOTES

   • Don't call IterableApi.initialize from Activity#onCreate; it is necessary for Iterable SDK to be initialized when the application is starting, to make sure everything is set up regardless of whether the app is launched to open an activity or is woken up in background as a result of an incoming push message.
   • You add your push notification integration in this step but we'll complete this in a later section which can be found here

2. Once you know the email (Preferred) or userId of the user, call setEmail or setUserId

   • EMAIL: IterableApi.getInstance().setEmail("email@example.com");
   • USERID: IterableApi.getInstance().setUserId("userId");

   NOTE

   Don't specify both email and userId in the same session, as they will be treated as different users by the SDK. Only use one type of identifier, email or userId, to identify the user. ​

# Multiple push providers

To learn how to work with multiple push notification providers, read Setting up Android Push Notifications.

# Troubleshooting

If you're having trouble installing or initializing the SDK, read Testing and Troubleshooting the Iterable SDK.

# Next Steps

After the SDK has been installed, read Identifying the User .