Last updated
Last updated
To use the Roam SDK,
Get yourself a free . No credit card is required.
Create a project and add an Android app to the project.
You need the PUBLISHABLE_KEY (available in your project settings) to initialize the SDK.
Now, you’re ready to integrate the SDK into your Android application.
Roam Android SDK requires Android Studio 2.0 or later and is compatible with apps targeting Android SDK Version 16 or above.
The Roam Example repository on GitHub includes sample applications that demonstrate the use of the v3 Roam SDK for Android.
To run an example app, clone this repository, navigate to the example app in paths Example/ , add your publishable YOUR-PUBLISHABLE-KEY key in MainApplication.java, and run the app.
Make sure the package name is the same as the one registered on our Roam dashboard.
To use the Android SDK in a project, add the SDK as a build dependency and sync the project.
Go to Android Studio > New Project > Minimum SDK
Select API 16: Android 4.1.0 (Jelly Bean) or higher and create a project
After you create a new project, open Gradle Scripts > build.gradle (Project: <your_project>) and do the following:
Add the following to the build script {repositories {}} section of the build.gradle (Project)file:
Sync and close build.gradle (Project: <your_project>)
To install the SDK for your project via Gradle in Android Studio, add the maven below to your project build.gradle file.
add the dependencies below to your app build.gradle file.
Then sync Gradle.
Open Android Studio and add the SDK Roam.aar as a module using File > New > New Module > Import .JAR/.AAR Package.
Once Gradle is finished, click File > Project Structure again.
Click on the Dependencies tab > click App > click the “+” icon in the top left of the Declared Dependencies section > select Module Dependency > click on Roam-release > press Ok and wait for Gradle to sync again.
Make sure to include the dependencies separately and sync your project.
Roam SDK offers a flexible method of initialization, allowing developers to seamlessly integrate our services into their applications. With our latest update, we've introduced a new initialization approach using Manifest file. This method provides an effortless way to set up your Roam SDK without the need for additional code.
Using Manifest file Initialization:
Optional Parameter: Publish Key
The publishKey parameter in the initialization method is now optional.
If you've added your Roam publish key to your project's Manifest file, there's no need to pass the publishKey parameter during initialization.
Configure Your Manifest File:
In your Manifest file, declare your Roam publish key as follows:
Replace ${ROAM_PUBLISH_KEY} with your actual Roam publish key.
Using local.properties (Optional):
Alternatively, you can use a local.properties file to feed the Roam publish key to the Manifest file.
In your local.properties file, add the following line, replacing XXXXXXXXXXXXXX with your Roam publish key:
To get Roam publish key from local.properties to Manifest, user must have to add following code in build.gradle(app)
Initialization Code:
Initialize Roam SDK in your application class as follows:
If the publish key is added to the Manifest file, the initialize method can be called without passing the publishable key.
By following these steps, you can seamlessly initialize Roam SDK using manifest file, simplifying the integration process and saving valuable development time.
Using Application class Initialization:
Before initializing the SDK, the below must be imported.
After importing, add the code below under the Application class onCreate() method. The SDK must be initialized before calling any of the other SDK methods.
To request the location for devices running both below/above Android 10, refer to the following piece of code.
Specify the tracking modes while you use the Roam.startTrackingmethod.
The SDK also provides a custom tracking mode that allows you to customize and build your own tracking modes.
With distance interval tracking you create a tracking mode with a distance interval in meters of your choice.
Distance between location updates example code:
With Time Interval Tracking you can create a tracking mode with the time interval (in seconds) of your choice.
Time between location updates example code:
You may see a delay if the user's device is in low power mode or has connectivity issues.
To stop tracking, use the method below.
Listeners are needed to consume the location or event data from the SDK. To enable listeners, ensure the following:
To listen to location updates, create a class that extends RoamReceiver.
Register the receiver by adding a receiver element to the application element in your manifest.
Note: For self-tracking, you can only listen to only location, error, and offline trips status data since the locations are not being sent to our servers for processing events.
Add the code to the receiver.
Batch configuration lets you control the number of location data updates being received in the location listener with the desired frequency and window.
As the name suggests, this method sets the configuration parameters.
The NetworkState.BOTH indicates the state in which the updates are to be received. It can either be set to online, offline, or both.
The batchCount indicates the size of the location batch.
The batchWindow indicates the time interval for every consecutive update (frequency of updates).
By default, the batch configuration values for both batch count and window are set to 1 and 0 respectively.
Consider the following call,
Roam.setBatchConfig("NetworkState.Both", 5 , 60)
The batch count value is the number of location updates sent in a batch. In the above case, the value is set to 5. Ideally, the SDK sends 5 updates per batch and the batch window (in the above case, 60) specifies the number of seconds the SDK waits to receive five location updates.
If the SDK receives 5 location updates in less than 60 seconds, the updates are pushed to the listener. If not, it waits for 60 seconds and pushes the location updates regardless of the batch count value.
Success Callback - We receive a list of BatchReceiveConfig objects.
Example response:
[{"batchCount":5,"batchWindow":10,"networkState":"OFFLINE"}, {"batchCount":5,"batchWindow":10,"networkState":"ONLINE"}]
Error Callback: We receive a RoamError object in the error callback.
The available details to get from the RoamError object are: error.getMessage() and error.getCode()
The get receiver config method allows the user to get the current batch configuration for the location listener.
The response for the above code is the same as that of the Set Receiver Config method.
The Reset Batch Configuration method allows the user to reset the batch config for the location listener.
and unzip the Roam SDK.
Roam has three default tracking modes along with a custom version. They differ based on the frequency of location updates and battery consumption. The higher the frequency, the higher the battery consumption. You must use the for continuous tracking.