Expo

Documentation

TaskManager

expo-task-manager provides an API that allows you to manage long-running tasks, in particular those tasks that can run while your app is in the background. Some features of this module are used by other modules under the hood. Here is a list of Expo modules that use TaskManager:

Platform Compatibility

Android DeviceAndroid EmulatoriOS DeviceiOS SimulatorWeb
✅✅✅✅❌

Installation

For managed apps, you'll need to run expo install expo-task-manager. It is not yet available for bare React Native apps. If you're using the bare workflow, React Native's Headless JS might suit your needs.

Configuration for standalone apps

TaskManager works out of the box in the Expo client on Android, but on iOS you'll need to test using a custom Expo client.
Standalone apps need some extra configuration: on iOS, each background feature requires a special key in UIBackgroundModes array in your Info.plist file. In standalone apps this array is empty by default, so in order to use background features you will need to add appropriate keys to your app.json configuration. Example of app.json that enables background location and background fetch:
{
  "expo": {
    ...
    "ios": {
      ...
      "infoPlist": {
        ...
        "UIBackgroundModes": [
          "location",
          "fetch"
        ]
      }
    }
  }
}

API

import * as TaskManager from 'expo-task-manager';

TaskManager.defineTask(taskName, task)

Defines task function. It must be called in the global scope of your JavaScript bundle. In particular, it cannot be called in any of React lifecycle methods like componentDidMount. This limitation is due to the fact that when the application is launched in the background, we need to spin up your JavaScript app, run your task and then shut down — no views are mounted in this scenario.

Arguments

  • taskName (string) -- Name of the task.
  • task (function) -- A function that will be invoked when the task with given taskName is executed.

TaskManager.isTaskRegisteredAsync(taskName)

Determine whether the task is registered. Registered tasks are stored in a persistent storage and preserved between sessions.

Arguments

  • taskName (string) -- Name of the task.

Returns

Returns a promise resolving to a boolean value whether or not the task with given name is already registered.

TaskManager.getTaskOptionsAsync(taskName)

Retrieves options associated with the task, that were passed to the function registering the task (eg. Location.startLocationUpdatesAsync).

Arguments

  • taskName (string) -- Name of the task.

Returns

Returns a promise resolving to the options object that was passed while registering task with given name or null if task couldn't be found.

TaskManager.getRegisteredTasksAsync()

Provides information about tasks registered in the app.

Returns

Returns a promise resolving to an array of tasks registered in the app. Example:
[
  {
    taskName: 'location-updates-task-name',
    taskType: 'location',
    options: {
      accuracy: Location.Accuracy.High,
      showsBackgroundLocationIndicator: false,
    },
  },
  {
    taskName: 'geofencing-task-name',
    taskType: 'geofencing',
    options: {
      regions: [...],
    },
  },
]

TaskManager.unregisterTaskAsync(taskName)

Unregisters task from the app, so the app will not be receiving updates for that task anymore. It is recommended to use methods specialized by modules that registered the task, eg. Location.stopLocationUpdatesAsync.

Arguments

  • taskName (string) -- Name of the task to unregister.

Returns

Returns a promise resolving as soon as the task is unregistered.

TaskManager.unregisterAllTasksAsync()

Unregisters all tasks registered for the running app.

Returns

Returns a promise that resolves as soon as all tasks are completely unregistered.

Example

import React from 'react';
import { Text, TouchableOpacity } from 'react-native';
import * as TaskManager from 'expo-task-manager';
import * as Location from 'expo-location';

const LOCATION_TASK_NAME = 'background-location-task';

export default class Component extends React.Component {
  onPress = async () => {
    const { status } = await Location.requestPermissionsAsync();
    if (status === 'granted') {
      await Location.startLocationUpdatesAsync(LOCATION_TASK_NAME, {
        accuracy: Location.Accuracy.Balanced,
      });
    }
  };

  render() {
    return (
      <TouchableOpacity onPress={this.onPress}>
        <Text>Enable background location</Text>
      </TouchableOpacity>
    );
  }
}

TaskManager.defineTask(LOCATION_TASK_NAME, ({ data, error }) => {
  if (error) {
    // Error occurred - check `error.message` for more details.
    return;
  }
  if (data) {
    const { locations } = data;
    // do something with the locations captured in the background
  }
});