Skip to content

HeartbeatEvent

Periodic heartbeat delivered to BackgroundGeolocation.onHeartbeat.

The SDK fires this event on a fixed interval while running in the background, providing a regular opportunity to perform work even when no location events are occurring. Configure the interval with AppConfig.heartbeatInterval.


Members

location

Most recent location recorded by the SDK.

The heartbeat event does not actively request a fresh location fix. Call BackgroundGeolocation.getCurrentPosition if an up-to-date reading is required.