@magiclane/maps-sdk
    Preparing search index...

    Class AlarmService

    Alarm service class

    Hierarchy

    • GemAutoreleaseObject
      • AlarmService
    Index

    Constructors

    constructor

    Accessors

    alarmDistance alarmListener insideAreas landmarkAlarms landmarkAlarmsPassedOver landmarks monitoredAreas monitorWithoutRoute outsideAreas overlayItemAlarms overlayItemAlarmsPassedOver overlays pointerId referencePosition trackedPositionSource isSafetyCameraEnabled isSocialReportsEnabled

    Methods

    dispose getOverSpeedThreshold monitorArea registerAutoReleaseObject setOverSpeedThreshold unmonitorAllAreas unmonitorArea unmonitorAreasByIds create disableSafetyCamera disableSocialReports disableSocialReportsWithCategory enableSafetyCamera enableSocialReports enableSocialReportsWithCategory isSocialReportsEnabledWithCategory

    Constructors

    • Parameters

      • id: any

      Returns AlarmService

    Accessors

    • get alarmDistance(): number

      Gets the distance in meters for alarming.

      Returns number

      Distance in meters

      An exception if it fails.

    • set alarmDistance(distance: number): void

      Sets the distance in meters for alarming.

      Parameters

      • distance: number

        Distance in meters

      Returns void

      An exception if it fails.

    • set alarmListener(listener: AlarmListener): void

      Sets the alarm listener.

      Parameters

      Returns void

      An exception if it fails.

    • get insideAreas(): AlarmMonitoredArea[]

      Gets areas containing current referenced position

      Returns AlarmMonitoredArea[]

      List of AlarmMonitoredArea objects.

      An exception if it fails.

    • get landmarkAlarms(): LandmarkAlarmsList

      Provides the list of active landmark alarms.

      Returns LandmarkAlarmsList

      The list of landmark alarms

      An exception if it fails.

    • get landmarkAlarmsPassedOver(): LandmarkAlarmsList

      Provides the list of passed over landmark alarms.

      Returns LandmarkAlarmsList

      The list of passed over landmark alarms

      An exception if it fails.

    • get monitoredAreas(): AlarmMonitoredArea[]

      Get all monitored areas

      Returns AlarmMonitoredArea[]

      List of AlarmMonitoredArea objects.

      An exception if it fails.

    • get monitorWithoutRoute(): boolean

      Gets the status of the "alarming without route" flag.

      Returns boolean

      True if monitoring without route is enabled, false otherwise.

      An exception if it fails.

    • set monitorWithoutRoute(value: boolean): void

      Select if alarms should be provided when navigating without route.

      Parameters

      • value: boolean

        Enable or disable monitoring without route.

      Returns void

      An exception if it fails.

    • get outsideAreas(): AlarmMonitoredArea[]

      Gets areas not containing current referenced position

      Returns AlarmMonitoredArea[]

      List of AlarmMonitoredArea objects.

      An exception if it fails.

    • get overlayItemAlarms(): OverlayItemAlarmsList

      Provides the list of active overlay item alarms.

      Returns OverlayItemAlarmsList

      The list of overlay item alarms

      An exception if it fails.

    • get overlayItemAlarmsPassedOver(): OverlayItemAlarmsList

      Provides the list of passed over overlay item alarms.

      Returns OverlayItemAlarmsList

      The list of passed over overlay item alarms.

      An exception if it fails.

    • get pointerId(): any

      Returns any

    • get referencePosition(): GemPosition | null

      Gets alarm current reference position.

      Returns GemPosition | null

      The reference position

      An exception if it fails.

    • get trackedPositionSource(): DataSource

      Gets the tracking position source.

      Returns DataSource

      The DataSource.

      An exception if it fails.

    • get isSafetyCameraEnabled(): boolean

      Check if the safety camera overlay is enabled.

      Returns boolean

      True if the safety camera overlay is enabled, false otherwise.

      An exception if it fails

    • get isSocialReportsEnabled(): boolean

      Check if the social reports overlay is enabled.

      Returns boolean

      True if the social reports overlay is enabled, false otherwise.

      An exception if it fails

    Methods

    • Dispose the AlarmService instance.

      Returns void

    • Get the alarm overspeed threshold value, in meters per second.

      Parameters

      • insideCityArea: boolean

        Specify whether the given threshold is for inside city area or for outside city area.

      Returns number

      An exception if it fails.

    • Add new geographic area to monitor.

      Parameters

      • area: GeographicArea

        The geographic area to monitor.

      • id: string = ''

        An unique identifier for the area

      Returns void

      An exception if it fails.

    • Registers an object for auto release. When the object is not used anymore, it will be released automatically from C++.

      Parameters

      • pointerId: any

        The pointer ID to register

      Returns void

    • Set the alarm overspeed threshold value, in meters per second.

      Parameters

      • threshold: number

        The overspeed threshold value, in meters per second.

      • insideCityArea: boolean

        Specify whether the given threshold is for inside city area or for outside city area.

      Returns void

      An exception if it fails.

    • Remove the all geographic areas from monitor.

      Returns void

      An exception if it fails.

    • Remove the given geographic area from monitor.

      Parameters

      Returns void

      An exception if it fails.

    • Remove the given geographic areas ids from monitor.

      Parameters

      • ids: string[]

        The ids of the areas to monitor.

      Returns void

      An exception if it fails.

    • Creates a new instance of the AlarmService class.

      Parameters

      • listener: AlarmListener

        AlarmListener that gets notified of the alarm events.

      Returns AlarmService

      An exception if it fails.

    • Disables the safety camera overlay.

      Returns GemError

      GemError.success on success, GemError.notFound if the overlay is not found

      An exception if it fails.

    • Disables the social reports overlay.

      Returns GemError

      GemError.success on success, GemError.notFound if the overlay is not found

      An exception if it fails.

    • Disables the social reports overlay for a specified category.

      Parameters

      • categoryId: number

        The overlay category id

      Returns GemError

      GemError.success on success, GemError.notFound if the overlay is not found

      An exception if it fails.

    • Enables the safety camera overlay.

      Returns GemError

      GemError.success on success, GemError.notFound if the overlay is not found

      An exception if it fails.

    • Enables the social reports overlay.

      Returns GemError

      GemError.success on success, GemError.notFound if the overlay is not found

      An exception if it fails.

    • Enables the social reports overlay for a specified category.

      Parameters

      • categoryId: number

        The overlay category id

      Returns GemError

      GemError.success on success, GemError.notFound if the overlay is not found

      An exception if it fails.

    • Check if the social reports overlay for a specified category is enabled.

      Parameters

      • categoryId: number

        The overlay category id

      Returns boolean

      True if the social reports overlay for the category is enabled, false otherwise.

      An exception if it fails.

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods