Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove out dated caveat about using setTimeout from a headless js task #3847

Merged
merged 2 commits into from
Sep 7, 2023
Merged

Remove out dated caveat about using setTimeout from a headless js task #3847

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9d3a828
Remove out dated caveat about using setTimeout from a headless js task
jkells Sep 6, 2023
3980414
Backport setTimeout documentation fix to the versioned docs
jkells Sep 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/headless-js-android.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,6 @@ If you wish all errors to cause a retry attempt, you will need to catch them and

## Caveats

- The function passed to `setTimeout` does not always behave as expected. Instead the function is called only when the application is launched again. If you only need to wait, use the retry functionality.
- 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. You can pass a fourth `boolean` argument to control this behaviour.
- If you start your service from a `BroadcastReceiver`, make sure to call `HeadlessJsTaskService.acquireWakeLockNow()` before returning from `onReceive()`.

Expand Down