Jetpack Compose quick start

👍

Target Platforms

This quick start guide shows you how to get Heap setup in an Android application that primarily uses Jetpack Compose for creating the user interface.

After completing the setup process, you will be able to:

  • Take full advantage of the Heap API to track custom events and manage user identity.
  • Automatically capture changes to the installed app version when recording starts.

📘

If you're using Heap Classic and thinking of switching to our latest offerings, check out the full breakdown of the differences between our SDKs here.

Before you begin

📘

The below guide assumes a standard <project>/<app> configuration and use of the most up-to-date Gradle syntax. If you're using the legacy Gradle syntax in your project, visit our custom configuration guide here.

All Heap Android SDKs are distributed via Maven Central. To make sure your application can access the required artifacts, you'll need to add Maven Central as a dependency repository.

In your project-level settings.gradle file, add a reference to Maven Central:

dependencyResolutionManagement {  
  repositories {  
    ...  
    mavenCentral()  
  }  
}
dependencyResolutionManagement {  
  repositories {  
    ...  
    mavenCentral()  
  }  
}

Add the Heap SDK to your application

  1. In your app-level build.gradle file, add the dependency for the Heap Android Core SDK.
dependencies {  
  implementation 'io.heap.core:heap-android-core:0.5.+'  
}
dependencies {  
  implementation("io.heap.core:heap-android-core:0.3.+")
}
  1. Once the dependency has been added, sync Gradle and rebuild your application.

  2. To enable Heap, call startRecording. This can go anywhere in your app, but we recommend doing this in the onCreate method of your app’s Application object to make sure tracking starts, no matter how your app is opened.

import io.heap.core.Heap

class MyApplication : Application() {  
  override fun onCreate() {  
    super.onCreate()  
    // Replace YOUR_ENVIRONMENT_ID with the ID of the Heap environment you wish to send data to.  
    Heap.startRecording(this, "YOUR_ENVIRONMENT_ID")  
  }  
}
import io.heap.core.Heap;

public class MyApplication extends Application {
  @Override
	public void onCreate() {  
    super.onCreate();
    // Replace YOUR_ENVIRONMENT_ID with the ID of the Heap environment you wish to send data to.  
    Heap.startRecording(this, "YOUR_ENVIRONMENT_ID");  
  }  
}

Once recording has started, you’re able to take full advantage of Heap’s API to identify users, track custom events, and more. Heap will also automatically start tracking app version changes without any additional code.

What next?

Start capturing events! Learn all about Heap’s custom event tracking APIs here.

To find out how to take full advantage of the Heap API to enhance your data capture, check out our mobile tracking guides here.