From 8159b45d20c397c649e4d83b00dad0a7994fc270 Mon Sep 17 00:00:00 2001 From: David Tuite Date: Fri, 2 Feb 2018 04:05:54 +0000 Subject: [PATCH] Explain a known issue in APK 27 and greater Adds a new heading "known issues" to the readme. In this section, Issue 59 is explained along with a workaround to prevent fatal exceptions in Android >= 27. --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 7422d5e7..4b9ae9db 100644 --- a/README.md +++ b/README.md @@ -180,6 +180,19 @@ Ensure `compileSdkVersion` and `targetSdkVersion` are 25. Done! +## Known issues + +Android APK 27 and above require notifications to provide their own `NotificationChannel`. `react-native-background-upload` does not yet meet this requirement and thus [will cause crashes in Android 8.1 and above](https://github.com/Vydia/react-native-background-upload/issues/59#issuecomment-362476703). This issue can be avoided by electing not to use native notifications. + +```js +const options = { + // ... + notification: { + enabled: false, + }, +}; +``` + ## Gratitude