1.0.0 • Published 6 years ago

react-native-background-execution-ios v1.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
6 years ago

react-native-background-execution-ios

React Native Background Execution Management for iOS

Installation

yarn add react-native-background-execution-ios

Automatic linking

react-native link react-native-background-execution-ios

Manual linking

  1. In XCode, in the project navigator, right click LibrariesAdd Files to [your project's name]
  2. Go to node_modulesreact-native-background-execution-iosios and add RCTBackgroundExecutionIOS.xcodeproj
  3. In XCode, in the project navigator, select your project. Add libRCTBackgroundExecutionIOS.a to your project's Build PhasesLink Binary With Libraries

Usage

import BackgroundExecutionIOS from 'react-native-background-execution-ios';


const onExpiration = (remainingTime) => console.info(`Background execution time will end in ${remainingTime}s`);
const onError = (err) => console.warn(err);

const backgroundTimeRemaining = await BackgroundExecutionIOS.backgroundTimeRemaining;

if (backgroundTimeRemaining > 0) {
    BackgroundExecutionIOS.beginBackgroundTask(onExpiration, onError);
    //...
    BackgroundExecutionIOS.endBackgroundTask();
}

API

Properties

Property getters return a promise resolved with the property value.

PropertyTypeNotes
backgroundTimeRemainingdoublereadonly

Methods

MethodArgumentsReturnNotes
beginBackgroundTaskonExpiration: function, onError: functionvoid
endBackgroundTaskvoidautomatically called in case of expiration