Utility Methods
The GeoSpark SDK is capable of sending push notifications to your users. Add Firebase to your Android project to get the device token.
GeoSpark.setDeviceToken("FCM DeviceToken")
GeoSpark.setDeviceToken("FCM DeviceToken");
To get the FCM DeviceToken from the SDK.
GeoSpark.getDeviceToken()
GeoSpark.getDeviceToken();
Check whether your App has location permission. Returns a boolean, which is true if the location permission has been granted, and false otherwise.
GeoSpark.checkLocationPermission()
GeoSpark.checkLocationPermission();
Check whether the device has location services enabled. Returns a boolean, which is true if the location services are on, and false otherwise.
GeoSpark.checkLocationServices()
GeoSpark.checkLocationServices();
Check whether your App has background location permission. Returns a boolean, which is true if the background location permission has been granted, and false otherwise.
GeoSpark.checkBackgroundLocationPermission()
GeoSpark.checkBackgroundLocationPermission();
Call this method to request the user to enable location permissions.
GeoSpark.requestLocationPermission(this)
GeoSpark.requestLocationPermission(this);
override fun onRequestPermissionsResult(requestCode: Int, permissions:Array<String>, grantResults:IntArray) {when (requestCode) {GeoSpark.REQUEST_CODE_LOCATION_PERMISSION->if (grantResults[0] ==PackageManager.PERMISSION_GRANTED) {....} else if (grantResults[0] ==PackageManager.PERMISSION_DENIED) {....}}}
//Callback from request location permission method.@Overridepublic void onRequestPermissionsResult(int requestCode, String permissions[], int[] grantResults) {switch (requestCode) {case GeoSpark.REQUEST_CODE_LOCATION_PERMISSION:if (grantResults[0] == PackageManager.PERMISSION_GRANTED) {...} else if (grantResults[0] == PackageManager.PERMISSION_DENIED) {...}break;}}
Call this method to enable location services.
GeoSpark.requestLocationServices(this)
GeoSpark.requestLocationServices(this);
override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {super.onActivityResult(requestCode, resultCode, data)if (requestCode == GeoSpark.REQUEST_CODE_LOCATION_ENABLED) {....}}
//Callback from request location services method.@Overrideprotected void onActivityResult(int requestCode, int resultCode, Intent data) {super.onActivityResult(requestCode, resultCode, data);if (requestCode == GeoSpark.REQUEST_CODE_LOCATION_ENABLED) {}}
Call this method to request the user to enable background location permissions.
GeoSpark.requestBackgroundLocationPermission(this)
GeoSpark.requestBackgroundLocationPermission(this);
override fun onRequestPermissionsResult(requestCode: Int, permissions:Array<String>, grantResults: IntArray) {when (requestCode) {GeoSpark.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.@Overridepublic void onRequestPermissionsResult(intrequestCode, Stringpermissions[],int[] grantResults) {switch (requestCode) {case GeoSpark.REQUEST_CODE_BACKGROUND_LOCATION_PERMISSION:if (grantResults[0] == PackageManager.PERMISSION_GRANTED) {...}else if (grantResults[0] == PackageManager.PERMISSION_DENIED) {...}break;}}
Check whether location tracking is started or not. This method returns a boolean value.
GeoSpark.isLocationTracking()
GeoSpark.isLocationTracking();
Using the updateCurrentLocation method, you can update the user's current location, you can set the accuracy from 10 to 100 meters (default is 10).
GeoSpark.updateCurrentLocation(DesiredAccuracy, accuracy)
GeoSpark.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 time. In some cases it could take up to 30 seconds depending on the GPS signal strength.
Parameter | Description |
DesiredAccuracy | GeoSparkTrackingMode.DesiredAccuracy.HIGH or GeoSparkTrackingMode.DesiredAccuracy.MEDIUM or GeoSparkTrackingMode.DesiredAccuracy.LOW |
Logout from GeoSpark SDK, using logout() method.
NOTE : You need to reinitialize the SDK in case you want to login again.
GeoSpark.logout(object : GeoSparkLogoutCallback {override fun onSuccess(message: String) {}override fun onFailure(geoSparkError: GeoSparkError) {geoSparkError.codegeoSparkError.message}})
GeoSpark.logout(new GeoSparkLogoutCallback() {@Overridepublic void onSuccess(String message) {​}​@Overridepublic void onFailure(GeoSparkError geoSparkError) {geoSparkError.getCode();geoSparkError.getMessage();}});
By using this method inside FirebaseMessagingService class, track the campaign impressions and counts.
override fun onMessageReceived(RemoteMessage remoteMessage) {super.onMessageReceived(remoteMessage)val notificationManager = getSystemService(Context.NOTIFICATION_SERVICE) asNotificationManager....intent.putExtra(GeoSpark.EXTRA, GeoSpark.notificationReceiveHandler(remoteMessage.getData()))....}
@Overridepublic void onMessageReceived(RemoteMessage remoteMessage) {super.onMessageReceived(remoteMessage);NotificationManager notificationManager = (NotificationManager) context.getSystemService(Context.NOTIFICATION_SERVICE);...intent.putExtra(GeoSpark.EXTRA, GeoSpark.notificationReceiveHandler(remoteMessage.getData()));...notificationManager.notify(NotificationID, builder.build());}
override fun onCreate(savedInstanceState: Bundle?) {super.onCreate(savedInstanceState)....GeoSpark.notificationOpenedHandler(intent))
@Overrideprotected void onCreate(Bundle savedInstanceState) {super.onCreate(savedInstanceState);...GeoSpark.notificationOpenedHandler(getIntent());}
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 GeoSpark class.
GeoSpark.disableBatteryOptimization()
GeoSpark.disableBatteryOptimization();
This will trigger a system dialog asking the user to allow disabling battery optimization for your app.
GeoSpark.isBatteryOptimizationEnabled()
GeoSpark.isBatteryOptimizationEnabled();
GeoSpark SDKs reject Mock Locations on the device by default.
GeoSpark.allowMockLocation(Boolean)
GeoSpark.allowMockLocation(Boolean);
Parameter | Description |
Boolean | false (default) -- Mock location disabled. true -- Mock location enabled |
GeoSpark.setTrackingInAppState(STATE)
GeoSpark.setTrackingInAppState(STATE);
Parameter | Description |
STATE | GeoSparkTrackingMode.AppState.FOREGROUND (or) GeoSparkTrackingMode.AppState.BACKGROUND (or) GeoSparkTrackingMode.AppState.ALWAYS_ON |
GeoSpark.offlineLocationTracking(Boolean)
GeoSpark.offlineLocationTracking(Boolean);
Parameter | Description |
Boolean | true (default) -- Offline location enabled. false -- Offline location disabled. |
For enabling accuracy engine for Passive, Active, and Balanced tracking
GeoSpark.enableAccuracyEngine()
GeoSpark.enableAccuracyEngine();
For disabling accuracy engine
GeoSpark.disableAccuracyEngine()
GeoSpark.disableAccuracyEngine();
