Skip to content

HeadlessEvent Android only

Event delivered to a headless task registered via BackgroundGeolocation.registerHeadlessTask.

Headless tasks allow the app to handle SDK events while running in the background without a UI — including after the app has been terminated by the user. Each task invocation receives a HeadlessEvent describing which SDK event occurred and carrying the associated payload.


Members

name

The SDK event that triggered this headless task invocation (e.g. location, http, geofence, heartbeat, terminate).

params

Event payload corresponding to name. Cast this to the appropriate event type based on the value of name (e.g. Location for location, HttpEvent for http).