Beacon Android SDK Samples

This repository contains two sample apps that showcase how to integrate the Beacon Android SDK.

Sample Kotlin - A simple and concise demo that shows how to install, initialise, and two different ways to open your Help Scout Beacon.
Sample Customisation - Java based sample illustrates some of the key features you can use to customise the Beacon SDK to add additional data about the user and how to override certain Beacon settings.

Beacon SDK version

Release notes and changelog

You can subscribe to receive release updates by following these steps:

At the top right-hand corner, click on “Watch”
Choose “Custom”
Check the “Releases” option

Requirements

minSdkVersion: 21
compileSdkVersion:35
Java 11 language feature support (compile with Java 17 as of version 5.0.0)
Android X as of version SDK 2.0.0
A Beacon Id created on Help Scout

Supported platform and language versions

Android 11.0 to 15.0 (as noted above the “minSdkVersion: 21 (Android 5.0)” for greater compatibility however we only offer support for issues on Android 11+)
Kotlin 1.8.20
Java 11
Koin 3.4.2

Installation

The Beacon Android SDK is distributed as AAR and available from Maven Central, so add the following lines to your app’s build.gradle file.

Groovy

repositories {
    mavenCentral()
    …
}
dependencies {
  implementation 'com.helpscout:beacon:<beaconVersion>'
}

Kotlin DSL

repositories {
    mavenCentral()
    …
}
dependencies {
    implementation("com.helpscout:beacon:<beaconVersion>")
}

Once you sync the Gradle project, you’ll be ready to initialize Beacon.

Initialize Beacon

After following the steps above, your app is ready to integrate with the Beacon SDK. Before you can continue any further, you’ll need to get a hold of the ID of the Beacon that you’d like to use.

You can find your Beacon ID by logging into Help Scout and navigating to the Beacon you’d like to use. Inside the Installation section, you’ll see an Android tab that highlights the Beacon ID and a code snippet.

Once you’ve located the Beacon ID, you are ready to initialize the library. If you only display one Beacon, the Application.onCreate() method of your Application class
class is a great place to initialize the SDK. If you won’t know the Beacon ID at Application start or run multiple Beacons, you’ll need to make sure of adding the following call to the Beacon.Builder() before you launch BeaconActivity.

Beacon beacon = new Beacon.Builder()
  .withBeaconId("YOUR_BEACON_ID_HERE")       
  .build();

Beacon ID field is mandatory. Failing to provide it throws an SDKInitException
when interacting with the Beacon object.

Opening Beacon

Once you’ve initialized Beacon, you’re ready to interact with it. Whenever you want
to invoke Beacon, use the code below to display the Beacon user interface.

BeaconActivity.open(context);

Developer options

It’s possible to launch the Beacon SDK in developer mode. By doing so, you’ll be able to read
the HTTP requests and other actions that happen with the SDK realm.

To activate this mode, you have to tell the Beacon Builder like so:

Beacon beacon = Beacon.Builder()
  .withBeaconId("YOUR_BEACON_ID_HERE")       
  .withLogsEnabled(true)       
  .build();

To verify, take a peek in your Logcat.

Documentation

Support

For issues or questions, contact Help Scout support at help@helpscout.com