hypertrack-sdk/com.hypertrack.sdk/HyperTrack

HyperTrack

open class HyperTrack

Main interface to use HyperTrack Android SDK in your app. SDK allows you to track current device in real-time in almost no effort while having ready to use dashboard and backend infrastructure already build for a bunch of existing use-cases.

Usage:


        HyperTrack sdk = HyperTrack.getInstance(myPublishableKey)
                                   .setDeviceName("Elvis")
                                   .allowMockLocations()
                                   .addTrackingListener(this);

        Log.d(TAG, "HyperTrack device id is " + sdk.getDeviceID());

        sdk.start();

See our awesome quickstart for details.

Functions

addAvailabilityListener

open fun addAvailabilityListener(@Nullable listener: AvailabilityStateObserver.OnAvailabilityStateChangeListener): HyperTrack

Sets listener that will be notified when availability changes.

open fun addGeotag(@NonNull payload: Map<String, out Any>): GeotagResult

Convenience alias to addGeotag with null expected location.

open fun addGeotag(@NonNull payload: Map<String, out Any>, @Nullable expected: Location): GeotagResult

Creates geotag with configurable payload.

addTrackingListener

open fun addTrackingListener(@Nullable listener: TrackingStateObserver.OnTrackingStateChangeListener): HyperTrack

Sets listener that will be notified when tracking starts/stops or significant error occurred.

allowMockLocations

open fun allowMockLocations(): HyperTrack

Allows you to use location mocking software (e.g.

backgroundTrackingRequirement

open fun backgroundTrackingRequirement(isRequired: Boolean): HyperTrack

Sets whether to request background location permission on Android 11 and later.

enableDebugLogging

open fun enableDebugLogging()

Enables debug log output.

getAvailability

open fun getAvailability(): Availability

Gets current Availability status

open fun getBlockers(): Set<Blocker>

getCurrentLocation

~~open~~ ~~fun~~ ~~getCurrentLocation~~(@NonNull receiver: AsyncResultReceiver<Location, OutageReason>)

Asynchronous access to the current device location.

open fun getDeviceID(): String

open fun getInstance(@NonNull publishableKey: String): HyperTrack

Entry point to SDK usage.

getLatestLocation

open fun getLatestLocation(): Result<Location, OutageReason>

Latest device location, that is known to HyperTrack SDK.

open fun isRunning(): Boolean

open fun isTracking(): Boolean

removeAvailabilityListener

open fun removeAvailabilityListener(@Nullable listener: AvailabilityStateObserver.OnAvailabilityStateChangeListener): HyperTrack

removeTrackingListener

open fun removeTrackingListener(@Nullable listener: TrackingStateObserver.OnTrackingStateChangeListener): HyperTrack

Removes listener or does nothing, if null was passed in as argument.

requestPermissionsIfNecessary

open fun requestPermissionsIfNecessary(): HyperTrack

Convenience method that will issue required permissions request dialog if necessary.

setAvailability

open fun setAvailability(availability: Availability)

Sets current Availability status

setDeviceMetadata

open fun setDeviceMetadata(@Nullable metaData: Map<String, Any>): HyperTrack

Sets current device data, that can be used for easier dashboard navigation or grouping of location data in tag groups style.

open fun setDeviceName(@Nullable name: String): HyperTrack

Sets current device name, that can be used for easier dashboard navigation.

setTrackingNotificationConfig

open fun setTrackingNotificationConfig(@Nullable config: ServiceNotificationConfig): HyperTrack

Allows to to customize persistent notification elements.

open fun start(): HyperTrack

Starts tracking, if all requirements are met (permissions are granted and publisahble Key is validated).

open fun stop(): HyperTrack

Stops current tracking session.

syncDeviceSettings

open fun syncDeviceSettings(): HyperTrack

This method checks with HyperTrack cloud whether to start or stop tracking.