AlarmService - @magiclane/maps-sdk API Reference

Home > @magiclane/maps-sdk > AlarmService

AlarmService class

Provides monitoring and notification for navigation-related alarm events.

The AlarmService manages a variety of alarm types including speed limit violations, landmark proximity alerts, overlay item notifications (such as safety cameras and social reports), geographic boundary crossings, tunnel entry/exit events, and day/night mode transitions. Configure the service with an AlarmListener to receive callbacks for these events.

Multiple AlarmService and AlarmListener instances can operate simultaneously, enabling concurrent monitoring of different events or areas.

Make sure to keep a reference to both the AlarmService and AlarmListener instances for as long as you want to receive alarm notifications. If either instance is garbage collected, alarm callbacks will stop being triggered.

Routes & Navigation

Signature:

export declare class AlarmService extends GemAutoreleaseObject

Extends: GemAutoreleaseObject

Constructors

Constructor	Modifiers	Description
(constructor)(id)		Constructs a new instance of the `AlarmService` class

Properties

Property	Modifiers	Type	Description
alarmDistance		number	Distance threshold in meters for triggering landmark and overlay item alarms. Alarms are triggered when the device approaches within this distance of a monitored landmark or overlay item. The default threshold depends on the SDK configuration.
alarmListener		AlarmListener	Updates the alarm listener for this service. The listener can be changed at any time to dynamically reconfigure which callbacks receive alarm event notifications. Only one listener is active per AlarmService instance.
insideAreas	`readonly`	AlarmMonitoredArea[]	Gets areas containing current referenced position
isSafetyCameraEnabled	`static` `readonly`	boolean	Check if the safety camera overlay is enabled.
isSocialReportsEnabled	`static` `readonly`	boolean	Check if the social reports overlay is enabled.
landmarkAlarms	`readonly`	LandmarkAlarmsList	Provides the list of active landmark alarms.
landmarkAlarmsPassedOver	`readonly`	LandmarkAlarmsList	Provides the list of passed over landmark alarms.
landmarks	`readonly`	LandmarkStoreCollection	Gets access to the alarm settings for the landmark stores.
monitoredAreas	`readonly`	AlarmMonitoredArea[]	Get all monitored areas
monitorWithoutRoute		boolean	Whether alarms are triggered when navigating without an active route. When `true`, landmark and overlay item alarms are triggered while freely exploring the map. When `false`, alarms are only triggered during active navigation or simulation on a route.
outsideAreas	`readonly`	AlarmMonitoredArea[]	Gets areas not containing current referenced position
overlayItemAlarms	`readonly`	OverlayItemAlarmsList	Provides the list of active overlay item alarms.
overlayItemAlarmsPassedOver	`readonly`	OverlayItemAlarmsList	Provides the list of passed over overlay item alarms.
overlays	`readonly`	OverlayMutableCollection	Gets access to the collection of overlays to use for alarm.
pointerId	`readonly`	any
referencePosition	`readonly`	GemPosition \| null	Gets alarm current reference position.
trackedPositionSource	`readonly`	DataSource	Gets the tracking position source.

Methods

Method	Modifiers	Description
create(listener)	`static`	Creates a new instance of the AlarmService class.
disableSafetyCamera()	`static`	Disables the safety camera overlay.
disableSocialReports()	`static`	Disables the social reports overlay.
disableSocialReportsWithCategory(categoryId)	`static`	Disables the social reports overlay for a specified category.
dispose()		Dispose the AlarmService instance.
enableSafetyCamera()	`static`	Enables the safety camera overlay.
enableSocialReports()	`static`	Enables the social reports overlay.
enableSocialReportsWithCategory(categoryId)	`static`	Enables the social reports overlay for a specified category.
getOverSpeedThreshold(insideCityArea)		Get the alarm overspeed threshold value, in meters per second.
isSocialReportsEnabledWithCategory(categoryId)	`static`	Check if the social reports overlay for a specified category is enabled.
monitorArea(area, id)		Add new geographic area to monitor.
setOverSpeedThreshold(threshold, insideCityArea)		Set the alarm overspeed threshold value, in meters per second.
unmonitorAllAreas()		Remove the all geographic areas from monitor.
unmonitorArea(area)		Remove the given geographic area from monitor.
unmonitorAreasByIds(ids)		Remove the given geographic areas ids from monitor.