Bluedot SDK Docs/au.com.bluedot.point.net.engine

Package au.com.bluedot.point.net.engine

Contains main classes to use Bluedot SDK as ServiceManager, GeoTriggerService and TempoService classes

Types

@JsonClass(generateAdapter = true)

data class AppState( val locationPermission: LocationPermission, val notificationPermission: NotificationPermission, val batteryLevel: Int, val lastRuleUpdate: Instant?, val viewState: ViewState, val foregroundServiceEnabled: Boolean) : Parcelable

AppState stores the state of the Application when the event(Entry/Exit) was triggered by the SDK

BDError

abstract class BDError : Parcelable

BluedotServiceReceiver

abstract class BluedotServiceReceiver : BroadcastReceiver

A receiver for Bluedot SDK service events.

FenceInfo

data class FenceInfo( val id: String?, val name: String?, val applicationId: String?, val geometry: Geometry?, val description: String?) : Parcelable

FenceInfo contains details of each fence created inside a zone

GeoTriggeringEventReceiver

abstract class GeoTriggeringEventReceiver : BroadcastReceiver

A receiver for GeoTriggering events.

GeoTriggeringService

class GeoTriggeringService

GeoTriggeringService class is used to use GeoTriggering feature from bluedot SDK which includes reporting zone entry and exit events

GeoTriggeringStatusListener

fun interface GeoTriggeringStatusListener

Provides callbacks on ServiceManager.startGeoTriggering&ServiceManager.stopGeoTriggering

InitializationResultListener

fun interface InitializationResultListener

Provides callbacks on ServiceManager.initialize

LocationInfo

data class LocationInfo( val latitude: Double, val longitude: Double, speed: Float, bearing: Float, val timeStamp: Long) : Parcelable

NotificationPermission

enum NotificationPermission : Enum<NotificationPermission>

ResetResultReceiver

fun interface ResetResultReceiver

Provides callbacks on ServiceManager.reset

ServiceManager

class ServiceManager

Service manager is used to interact with Bluedot Point Service

TempoService

class TempoService

TempoService class is used to use Tempo feature from bluedot SDK which includes reporting tempo update and tempo stop events on a defined interval

TempoServiceStatusListener

fun interface TempoServiceStatusListener

Provides callbacks on TempoService.start

TempoTrackingReceiver

abstract class TempoTrackingReceiver : BroadcastReceiver

A receiver for Tempo events.

ViewState

enum ViewState : Enum<ViewState>

ZoneInfo

class ZoneInfo( val zoneId: String?, val zoneName: String?, val isCheckOut: Boolean?, val destination: Destination? = null, fences: HashSet<FenceInfo> = HashSet(), enabled: Boolean = true, customData: Map<String, String>? = null, val description: String? = null) : Parcelable

ZoneInfo stores zone details for every zone downloaded by SDK from Rule Download.