Utility Methods

Set Device Token

The Roam SDK is capable of sending push notifications to your users. Add Firebase to your Android project to get the device token.
Kotlin
Java
Roam.setDeviceToken("FCM DeviceToken")
Roam.setDeviceToken("FCM DeviceToken");

Get Device Token

This method gets the FCM DeviceToken from the SDK.
Kotlin
Java
Roam.getDeviceToken()
Roam.getDeviceToken();

Check location permission

Check whether your app has location permission. Returns a boolean, which is true if location permission has been granted or false otherwise.
Kotlin
Java
Roam.checkLocationPermission()
Roam.checkLocationPermission();

Check Location Services

Check if the device has location services enabled. This method returns a boolean, which is true if the location services are on and false otherwise.
Kotlin
Java
Roam.checkLocationServices()
Roam.checkLocationServices();

Check Background Location Permission

This utility method checks whether your app has background location permissions. It returns a boolean as true if background location permission has been granted, or false otherwise.
Kotlin
Java
Roam.checkBackgroundLocationPermission()
Roam.checkBackgroundLocationPermission();

Request Location Permissions

Call this method to request the user to enable location permissions.
Kotlin
Java
Roam.requestLocationPermission(this)
Roam.requestLocationPermission(this);
Kotlin
Java
override fun onRequestPermissionsResult(requestCode: Int, permissions:
Array<String>, grantResults:IntArray) {
when (requestCode) {
Roam.REQUEST_CODE_LOCATION_PERMISSION->
if (grantResults[0] ==PackageManager.PERMISSION_GRANTED) {
....
} else if (grantResults[0] ==PackageManager.PERMISSION_DENIED) {
....
}
}
}
//Callback from request location permission method.
@Override
public void onRequestPermissionsResult(int requestCode, String permissions[], int[] grantResults) {
switch (requestCode) {
case Roam.REQUEST_CODE_LOCATION_PERMISSION:
if (grantResults[0] == PackageManager.PERMISSION_GRANTED) {
...
} else if (grantResults[0] == PackageManager.PERMISSION_DENIED) {
...
}
break;
}
}

Request Location Services

Call this method to enable location services.
Kotlin
Java
Roam.requestLocationServices(this)
Roam.requestLocationServices(this);
Kotlin
Java
override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
super.onActivityResult(requestCode, resultCode, data)
if (requestCode == Roam.REQUEST_CODE_LOCATION_ENABLED) {
....
}
}
//Callback from request location services method.
@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
super.onActivityResult(requestCode, resultCode, data);
if (requestCode == Roam.REQUEST_CODE_LOCATION_ENABLED) {
}
}

Request Background Location Permission

Call this method to request the user to enable background location permissions.
Kotlin
Java
Roam.requestBackgroundLocationPermission(this)
Roam.requestBackgroundLocationPermission(this);
Kotlin
Java
override fun onRequestPermissionsResult(requestCode: Int, permissions:
Array<String>, grantResults: IntArray) {
when (requestCode) {
Roam.REQUEST_CODE_BACKGROUND_LOCATION_PERMISSION->
if (grantResults[0] == PackageManager.PERMISSION_GRANTED) {
...
}
else if (grantResults[0] == PackageManager.PERMISSION_DENIED) {
...
}
}
}
//Callback from request background location permission method.
@Override
public void onRequestPermissionsResult(intrequestCode, Stringpermissions[],
int[] grantResults) {
switch (requestCode) {
case Roam.REQUEST_CODE_BACKGROUND_LOCATION_PERMISSION:
if (grantResults[0] == PackageManager.PERMISSION_GRANTED) {
...
}
else if (grantResults[0] == PackageManager.PERMISSION_DENIED) {
...
}
break;
}
}

Check Location Tracking

Check whether location tracking has been started or not. This method returns a boolean value.
Kotlin
Java
Roam.isLocationTracking()
Roam.isLocationTracking();

Update Current Location

Using the updateCurrentLocation method, you can update the user's current location and set the accuracy ranging from 10 to 100 meters (default is 10).
Kotlin
Java
Roam.updateCurrentLocation(DesiredAccuracy, accuracy)
Roam.updateCurrentLocation(DesiredAccuracy, accuracy);
This method should be used only if you need to update the current location of the device with better accuracy. Using this method consistently will consume more battery.
The higher the accuracy, the longer the response time. In some cases, it can take up to 30 seconds depending on the GPS signal strength.
Parameter
Description
DesiredAccuracy
RoamTrackingMode.DesiredAccuracy.HIGH or RoamTrackingMode.DesiredAccuracy.MEDIUM or RoamTrackingMode.DesiredAccuracy.LOW

Logout

Logout from Roam SDK using the logout() method.
NOTE - You need to reinitialize the SDK to login again.
Kotlin
Java
Roam.logout(object : RoamLogoutCallback {
override fun onSuccess(message: String) {
}
override fun onFailure(roamError: RoamError) {
// Access Error code and message here
// roamError.code
// roamError.message
}
})
Roam.logout(new RoamLogoutCallback() {
@Override
public void onSuccess(String message) {
}
@Override
public void onFailure(RoamError roamError) {
// Access Error code and message here
// roamError.code;
// roamError.message;
}
});

Notification Opened Handler

By using this method inside FirebaseMessagingService class, track the campaign impressions and counts.
Kotlin
Java
override fun onMessageReceived(RemoteMessage remoteMessage) {
super.onMessageReceived(remoteMessage)
val notificationManager = getSystemService(Context.NOTIFICATION_SERVICE) as
NotificationManager
....
intent.putExtra(Roam.EXTRA, Roam.notificationReceiveHandler(remoteMessage.getData()))
....
}
@Override
public void onMessageReceived(RemoteMessage remoteMessage) {
super.onMessageReceived(remoteMessage);
NotificationManager notificationManager = (NotificationManager) context.getSystemService(Context.NOTIFICATION_SERVICE);
...
intent.putExtra(Roam.EXTRA, Roam.notificationReceiveHandler(remoteMessage.getData()));
...
notificationManager.notify(NotificationID, builder.build());
}
Kotlin
Java
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
....
Roam.notificationOpenedHandler(intent)
)
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
...
Roam.notificationOpenedHandler(getIntent());
}

Disable Battery Optimization (android 6+)

When running the SDK on Android 6 (and higher), it is recommended to ask the user to disable battery optimization for your application. This ensures that location tracking continues to work when the device is in Doze mode.
Moreover, on Android Pie, disabling battery optimization prevents Adaptive Battery from bucketing your app based on usage and restricting background processing, which can impact the detection quality of the SDK.
After explaining the benefits of disabling battery optimization, call the disableBatteryOptimization() method of the Roam class.
Kotlin
Java
Roam.disableBatteryOptimization()
Roam.disableBatteryOptimization();
This will trigger a system dialog asking the user to allow disabling battery optimization for your app.

Check Battery Optimization

Kotlin
Java
Roam.isBatteryOptimizationEnabled()
Roam.isBatteryOptimizationEnabled();
Export as PDF
Copy link
On this page
Set Device Token
Get Device Token
Check location permission
Check Location Services
Check Background Location Permission
Request Location Permissions
Request Location Services
Request Background Location Permission
Check Location Tracking
Update Current Location
Logout
Notification Opened Handler
Disable Battery Optimization (android 6+)
Check Battery Optimization