https://github.com/nativescript/sample-android-background-services
Using Android Background Services in NativeScript
https://github.com/nativescript/sample-android-background-services
Last synced: 22 days ago
JSON representation
Using Android Background Services in NativeScript
- Host: GitHub
- URL: https://github.com/nativescript/sample-android-background-services
- Owner: NativeScript
- Created: 2016-08-08T09:11:52.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-07-26T11:45:43.000Z (over 6 years ago)
- Last Synced: 2024-10-29T15:51:57.615Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 12.7 MB
- Stars: 63
- Watchers: 32
- Forks: 10
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Notifications Scheduler
> **IMPORTANT**: In order to use the custom `com.pip3r4o.android.app.IntentService` implementation, you need to install the **nativescript-android-utils** package as a plugin in your application.
> **Note:**: This demo is using `android.app.NotificationChannel` which is available only for API 26+ (Android 8 and above).
---
To see an iOS version of this sample please check - https://github.com/NativeScript/sample-ios-background-execution
A sample project demonstrating how Android background services work in NativeScript, using the Android AlarmManager to schedule periodical calling of an IntentService, which should create Notifications even when the Application's Activities have been destroyed. (**Caution: Be very mindful when developing applications which send out notifications. Some users may find them annoying, if they get them too often, and as a result - delete your application.**)
# Running the sample
```shell
git clone https://github.com/NativeScript/sample-android-background-services
cd sample-android-background-services
tns run android
```
## Notes
- [IntentService](https://developer.android.com/reference/android/app/IntentService.html)’s `onHandleIntent` will execute on the main UI thread (versus on a dedicated worker Thread when implemented in pure Android)
IntentService’s implementation needs to use a constructor that takes no arguments, but that currently is not possible through Java.
- The [base Service class](https://developer.android.com/reference/android/app/Service.html) and all its descendants execute on the main UI thread by default in Android. Implementing a service that should run on a background thread must be managed in Java by the developer (see **Notes**).
- [BroadcastReceivers](http://www.tutorialspoint.com/android/android_broadcast_receivers.htm) should not be registered with the `android: process =":remote"` property in the AndroidManifest as the receiver will be unable to execute JavaScript in an independent process
- The suggested approach when you want to offload a long-running job on a different Thread is to write the implementation in Java classes and invoke the job in NativeScript.
- The current implementation utilizes the `NotificationChannel`, which was added in API Level 26. If you want to target lower API Levels, take a look at the older implementation [Alarm Manager Implementation](https://github.com/NativeScript/sample-android-background-services/tree/implementation-prior-apiLevel21). Have in mind, that this approaches is not supported with API Level 26 or newer due to limitations in the OS.