This is documentation for the next SDK version. For up-to-date documentation, see the latest version (SDK 52).
A universal library that provides API for performing background fetch tasks.
expo-background-fetch
provides an API to perform background fetch tasks, allowing you to run specific code periodically in the background to update your app. This module uses TaskManager Native API under the hood.
BackgroundFetch
only works when the app is backgrounded, not if the app was terminated or upon device reboot.
You can check out the relevant GitHub issue for more details.
On iOS the BackgroundFetch
library requires you to use a development build since Background Fetch is not enabled in the iOS Expo Go app.
-
npx expo install expo-background-fetch
If you are installing this in an existing React Native app, start by installing expo
in your project. Then, follow the additional instructions as mentioned by the library's README under "Installation in bare React Native projects" section.
To be able to run background fetch tasks on iOS, you need to add the fetch
value to the UIBackgroundModes
array in your app's Info.plist file. This is required for background fetch to work properly.
If you're using CNG, the required UIBackgroundModes
configuration will be applied automatically by prebuild.
If you're not using Continuous Native Generation (CNG) or you're using a native iOS project, then you'll need to add the following to your Expo.plist file:
<key>UIBackgroundModes</key>
<array>
<string>fetch</string>
</array>
</key>
Below is an example that demonstrates how to use expo-background-fetch
.
import { useState, useEffect } from 'react';
import { StyleSheet, Text, View, Button } from 'react-native';
import * as BackgroundFetch from 'expo-background-fetch';
import * as TaskManager from 'expo-task-manager';
const BACKGROUND_FETCH_TASK = 'background-fetch';
// 1. Define the task by providing a name and the function that should be executed
// Note: This needs to be called in the global scope (e.g outside of your React components)
TaskManager.defineTask(BACKGROUND_FETCH_TASK, async () => {
const now = Date.now();
console.log(`Got background fetch call at date: ${new Date(now).toISOString()}`);
// Be sure to return the successful result type!
return BackgroundFetch.BackgroundFetchResult.NewData;
});
// 2. Register the task at some point in your app by providing the same name,
// and some configuration options for how the background fetch should behave
// Note: This does NOT need to be in the global scope and CAN be used in your React components!
async function registerBackgroundFetchAsync() {
return BackgroundFetch.registerTaskAsync(BACKGROUND_FETCH_TASK, {
minimumInterval: 60 * 15, // 15 minutes
stopOnTerminate: false, // android only,
startOnBoot: true, // android only
});
}
// 3. (Optional) Unregister tasks by specifying the task name
// This will cancel any future background fetch calls that match the given name
// Note: This does NOT need to be in the global scope and CAN be used in your React components!
async function unregisterBackgroundFetchAsync() {
return BackgroundFetch.unregisterTaskAsync(BACKGROUND_FETCH_TASK);
}
export default function BackgroundFetchScreen() {
const [isRegistered, setIsRegistered] = useState(false);
const [status, setStatus] = useState(null);
useEffect(() => {
checkStatusAsync();
}, []);
const checkStatusAsync = async () => {
const status = await BackgroundFetch.getStatusAsync();
const isRegistered = await TaskManager.isTaskRegisteredAsync(BACKGROUND_FETCH_TASK);
setStatus(status);
setIsRegistered(isRegistered);
};
const toggleFetchTask = async () => {
if (isRegistered) {
await unregisterBackgroundFetchAsync();
} else {
await registerBackgroundFetchAsync();
}
checkStatusAsync();
};
return (
<View style={styles.screen}>
<View style={styles.textContainer}>
<Text>
Background fetch status:{' '}
<Text style={styles.boldText}>
{status && BackgroundFetch.BackgroundFetchStatus[status]}
</Text>
</Text>
<Text>
Background fetch task name:{' '}
<Text style={styles.boldText}>
{isRegistered ? BACKGROUND_FETCH_TASK : 'Not registered yet!'}
</Text>
</Text>
</View>
<View style={styles.textContainer}></View>
<Button
title={isRegistered ? 'Unregister BackgroundFetch task' : 'Register BackgroundFetch task'}
onPress={toggleFetchTask}
/>
</View>
);
}
const styles = StyleSheet.create({
screen: {
flex: 1,
justifyContent: 'center',
alignItems: 'center',
},
textContainer: {
margin: 10,
},
boldText: {
fontWeight: 'bold',
},
});
Background fetches can be difficult to test because they can happen inconsistently. Fortunately, you can trigger background fetches manually when developing your apps.
For iOS, you can use the Instruments
app on macOS to manually trigger background fetches:
/Applications/Xcode.app/Contents/Applications/Instruments.app
Time Profiler
Expo Go
appRecord
button in the top left cornerDocument
Menu and select Simulate Background Fetch - Expo Go
:For Android, you can set the minimumInterval
option of your task to a small number and background your application like so:
async function registerBackgroundFetchAsync() {
return BackgroundFetch.registerTaskAsync(BACKGROUND_FETCH_TASK, {
minimumInterval: 1 * 60, // task will fire 1 minute after app is backgrounded
});
}
import * as BackgroundFetch from 'expo-background-fetch';
Gets a status of background fetch.
Promise<BackgroundFetchStatus | null>
Returns a promise which fulfils with one of BackgroundFetchStatus
enum values.
Parameter | Type | Description |
---|---|---|
taskName | string | Name of the task to register. The task needs to be defined first - see |
options(optional) | BackgroundFetchOptions | An object containing the background fetch options. Default: {} |
Registers background fetch task with given name. Registered tasks are saved in persistent storage and restored once the app is initialized.
Promise<void>
Example
import * as BackgroundFetch from 'expo-background-fetch';
import * as TaskManager from 'expo-task-manager';
TaskManager.defineTask(YOUR_TASK_NAME, () => {
try {
const receivedNewData = // do your background fetch here
return receivedNewData ? BackgroundFetch.BackgroundFetchResult.NewData : BackgroundFetch.BackgroundFetchResult.NoData;
} catch (error) {
return BackgroundFetch.BackgroundFetchResult.Failed;
}
});
Parameter | Type | Description |
---|---|---|
minimumInterval | number | Number of seconds that must elapse before another background fetch can be called. |
Sets the minimum number of seconds that must elapse before another background fetch can be initiated. This value is advisory only and does not indicate the exact amount of time expected between fetch operations.
This method doesn't take any effect on Android. It is a global value which means that it can overwrite settings from another application opened through Expo Go.
Promise<void>
A promise which fulfils once the minimum interval is set.
Parameter | Type | Description |
---|---|---|
taskName | string | Name of the task to unregister. |
Unregisters background fetch task, so the application will no longer be executing this task.
Promise<void>
A promise which fulfils when the task is fully unregistered.
Property | Type | Description |
---|---|---|
minimumInterval(optional) | number | Inexact interval in seconds between subsequent repeats of the background fetch alarm. The final interval may differ from the specified one to minimize wakeups and battery usage.
|
startOnBoot(optional) | boolean | Only for: Android Whether to restart background fetch events when the device has finished booting. Default: false |
stopOnTerminate(optional) | boolean | Only for: Android Whether to stop receiving background fetch events after user terminates the app. Default: true |
This return value is to let iOS know what the result of your background fetch was, so the platform can better schedule future background fetches. Also, your app has up to 30 seconds to perform the task, otherwise your app will be terminated and future background fetches may be delayed.
BackgroundFetchStatus.Denied = 1
The user explicitly disabled background behavior for this app or for the whole system.
BackgroundFetchStatus.Restricted = 2
Background updates are unavailable and the user cannot enable them again. This status can occur when, for example, parental controls are in effect for the current user.
On Android, this module might listen when the device is starting up. It's necessary to continue working on tasks started with startOnBoot
. It also keeps devices "awake" that are going idle and asleep fast, to improve reliability of the tasks. Because of this both the RECEIVE_BOOT_COMPLETED
and WAKE_LOCK
permissions are added automatically.
Android Permission | Description |
---|---|
Allows an application to receive the Intent.ACTION_BOOT_COMPLETED that is broadcast after the system finishes booting.
| |
Allows using PowerManager WakeLocks to keep processor from sleeping or screen from dimming. |