add headless js guide

Summary:
**Test plan (required)**

Run the website, check everything renders.
Closes https://github.com/facebook/react-native/pull/10325

Differential Revision: D4008427

Pulled By: bestander

fbshipit-source-id: 2ba78d33efab2bf2267a806bfc8d3b0ec50f54f5
This commit is contained in:
Felix Oghina 2016-10-12 06:18:35 -07:00 committed by Facebook Github Bot
parent 47537183ec
commit d91a5c4ffb
3 changed files with 59 additions and 2 deletions

57
docs/HeadlessJSAndroid.md Normal file
View File

@ -0,0 +1,57 @@
---
id: headless-js-android
title: Headless JS
layout: docs
category: Guides (Android)
permalink: docs/headless-js-android.html
next: running-on-device-android
previous: native-components-android
---
Headless JS is a way to run tasks in JavaScript while your app is in the background. It can be used, for example, to sync fresh data, handle push notifications, or play music.
## The JS API
A task is a simple async function that you register on `AppRegistry`, similar to registering React applications:
```js
AppRegistry.registerHeadlessTask('SomeTaskName', () => require('SomeTaskName'));
```
Then, in `SomeTaskName.js`:
```js
module.exports = async (taskData) => {
// do stuff
}
```
You can do anything in your task as long as it doesn't touch UI: network requests, timers and so on. Once your task completes (i.e. the promise is resolved), React Native will go into "paused" mode (unless there are other tasks running, or there is a foreground app).
## The Java API
Yes, this does still require some native code, but it's pretty thin. You need to extend `HeadlessJsTaskService` and override `getTaskConfig`, e.g.:
```java
public class MyTaskService extends FbHeadlessJsTaskService {
@Override
protected @Nullable HeadlessJsTaskConfig getTaskConfig(Intent intent) {
Bundle extras = intent.getExtras();
if (extras != null) {
return new HeadlessJsTaskConfig(
"SomeTaskName",
Arguments.fromBundle(extras),
5000);
}
return null;
}
}
```
Now, whenever you [start your service](https://developer.android.com/reference/android/content/Context.html#startService(android.content.Intent)), e.g. as a periodic task or in response to some system event / broadcast, JS will spin up, run your task, then spin down.
## Caveats
* By default, your app will crash if you try to run a task while the app is in the foreground. This is to prevent developers from shooting themselves in the foot by doing a lot of work in a task and slowing the UI. There is a way around this.
* If you start your service from a BroadcastReceiver, make sure to call `HeadlessJsTaskService.acquireWakelockNow()` before returning from `onReceive()`.

View File

@ -4,7 +4,7 @@ title: Native UI Components
layout: docs
category: Guides (Android)
permalink: docs/native-components-android.html
next: running-on-device-android
next: headless-js-android
previous: native-modules-android
---

View File

@ -5,7 +5,7 @@ layout: docs
category: Guides (Android)
permalink: docs/running-on-device-android.html
next: signed-apk-android
props: native-components-android
previous: headless-js-android
---
## Prerequisite: USB Debugging