Documentation

Hey friend! We are co-hosting a conference with Software Mansion, learn more.

BackgroundFetch

Provides API to perform background fetch tasks. This module uses TaskManager Native API under the hood. In order to use BackgroundFetch API in standalone and detached apps, your app has to include background mode in the Info.plist file. See background tasks configuration guide for more details.This module is implemented only on iOS.

Gets a status of background fetch.

Returns a promise resolving to one of these values:
  • BackgroundFetch.Status.Restricted — 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.
  • BackgroundFetch.Status.Denied - The user explicitly disabled background behavior for this app or for the whole system.
  • BackgroundFetch.Status.Available - Background updates are available for the app.

Registers background fetch task with given name. Registered tasks are saved in persistent storage and restored once the app is initialized. Remember to also call BackgroundFetch.setMinimumIntervalAsync as fetch operations will not be occurring with its default value.

  • taskName (string) -- Name of the task to register. The task needs to be defined first - see TaskManager.defineTask for more details.

Returns a promise that resolves once the task is registered and rejects in case of any errors.

Background fetch task receives no data, but your task should return a value that best describes the results of your background fetch work.
  • BackgroundFetch.Result.NoData - There was no new data to download.
  • BackgroundFetch.Result.NewData - New data was successfully downloaded.
  • BackgroundFetch.Result.Failed - An attempt to download data was made but that attempt failed.
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.
import { BackgroundFetch, TaskManager } from 'expo';

TaskManager.defineTask(YOUR_TASK_NAME, () => {
  try {
    const receivedNewData = // do your background fetch here
    return receivedNewData ? BackgroundFetch.Result.NewData : BackgroundFetch.Result.NoData;
  } catch (error) {
    return BackgroundFetch.Result.Failed;
  }
});

Unregisters background fetch task, so the application will no longer be executing this task.

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

A promise resolving when the task is fully unregistered.

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. It defaults to the number large enough to prevent fetch operations from occurring.
It is a global value which means that it can overwrite settings from another application opened through Expo Client.

  • minimumInterval (number) -- Number of seconds that must elapse before another background fetch can be called.

A promise resolving once the minimum interval is set.