AlarmService

class AlarmService(address: Long) : GemNativeObj

AlarmService object. The alarm service informs the listener if certain landmarks and overlays are passing the registered geographic areas. The service also notifies the listener about the speed thresholds specified are crossed over.

Constructors

Link copied to clipboard
constructor(address: Long)

Types

Link copied to clipboard
object Companion

Alarm Service companion

Properties

Link copied to clipboard

Address of native referenced object. nullptr if not referencing any native allocated object. Note native allocation will happen only once.

Link copied to clipboard

Alarm distance in meters.

Link copied to clipboard

Alarm current boundary crossed The API client can check if the current position enters or exits a geographic area using GeographicArea.containsCoordinates.

Link copied to clipboard

List of active landmark alarms. When all alarms become inactive the list of landmark alarms is empty( const LandmarkAlarmsList.size() == 0).

Link copied to clipboard

List of passed over landmark alarms.

Link copied to clipboard

Gets access to the alarm settings for the landmark stores.

Link copied to clipboard

Select if alarms should be provided when navigating without route

Link copied to clipboard

List of active OverlayItem alarms. When all alarms become inactive the list of OverlayItem alarms is empty( const OverlayItemAlarmsListRef.size() == 0).

Link copied to clipboard

List of passed over OverlayItem alarms.

Link copied to clipboard

Collection of overlays to use for alarming.

Link copied to clipboard

Alarm current reference position

Link copied to clipboard

The position source to be tracked. By default the tracked position source is the current set in PositionService

Functions

Link copied to clipboard
fun finalize()

Overrides finalize that garbage collector will call when needed.

Link copied to clipboard
external fun getOverSpeedThreshold(insideCityArea: Boolean): Double

Get the alarm overspeed threshold value, in mps

Link copied to clipboard

True if keeps a reference to a C++ SDK object False if keeps a C++ SDK object

Link copied to clipboard
external fun monitorArea(value: GeographicArea)

Add new geographic area to monitor.

Link copied to clipboard
operator fun not(): Boolean

Checks if this object is valid.

Link copied to clipboard
fun release()

Releases the native referenced value of this object if:

Link copied to clipboard
external fun setAlarmListener(listener: AlarmListener?)

Sets the alarm listener. If the listener is empty then the alarm service will stop sending notifications.

Link copied to clipboard
external fun setOverSpeedThreshold(threshold: Double, insideBuildUpAreas: Boolean)

Set the alarm overspeed threshold value, in mps

Link copied to clipboard

Fetches available overlays from OverlayService then adds them to this.overlays()

Link copied to clipboard

Fetches available overlays from OverlayService then adds them to this.overlays()

Link copied to clipboard

Removes all overlays from existing collection by provided id list.

Link copied to clipboard

Removes all overlays from existing collection by provided id list.

Link copied to clipboard
external fun unmonitorArea(value: GeographicArea)

Remove the given geographic area from monitor.