HeadlessEvent | React Native Background Geolocation

This is the event-object provided to Android headless-tasks registered via BackgroundGeolocation.registerHeadlessTask.

example

const BackgroundGeolocationHeadlessTask = async (event) => {
  const params = event.params;
  console.log("[BackgroundGeolocation HeadlessTask] -", event.name, params);

  switch (event.name) {
    case "terminate":
      // Use await for async tasks
      const location = await BackgroundGeolocation.getCurrentPosition({
        samples: 1,
        persist: false
      });
      console.log("[BackgroundGeolocation HeadlessTask] - getCurrentPosition:", location);
      break;
  }
  // You must await all work you do in your task.  
  // Headless-tasks are automatically terminated after executing the last line of your function.
  await doWork();
}

BackgroundGeolocation.registerHeadlessTask(BackgroundGeolocationHeadlessTask);

ℹ️ See also:

Hierarchy

HeadlessEvent

Index

Properties

name
params

Properties

name

name: Event

BackgroundGeolocation event name (eg: location, motionchange, terminate, http, etc).

params

params: Map

General event params according to the context of the event name.