Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/CarterChen247/AlarmScheduler
A library that helps to schedule time-exact tasks(calendar reminders, alarms, etc.)
https://github.com/CarterChen247/AlarmScheduler
android android-application background-jobs job-scheduler
Last synced: 26 days ago
JSON representation
A library that helps to schedule time-exact tasks(calendar reminders, alarms, etc.)
- Host: GitHub
- URL: https://github.com/CarterChen247/AlarmScheduler
- Owner: CarterChen247
- Created: 2020-03-07T14:53:45.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2023-01-31T14:34:24.000Z (over 1 year ago)
- Last Synced: 2023-08-07T23:03:29.930Z (11 months ago)
- Topics: android, android-application, background-jobs, job-scheduler
- Language: Kotlin
- Homepage:
- Size: 337 KB
- Stars: 10
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Lists
- awesome-list - CarterChen247/AlarmScheduler - A library that helps to schedule time-exact tasks(calendar reminders, alarms, etc.) (Kotlin)
README
# AlarmScheduler
**AlarmScheduler is a tool to schedule time exact tasks, even in very short period of time.**
**AlarmScheduler provides various supports:**
- Easy-to-use API
- Android 12+ (Android S+) support
- Alarms survive after device reboot
- debuggable with built-in logger
**AlarmScheduler** is built on top of **AlarmManager** + **Kotlin Coroutines** + **Room** and ❤️ !!
## Add AlarmScheduler **to your project**
### Gradle 
Add the dependency to your **module**'s `build.gradle` file:
```groovy
dependencies {
implementation 'com.carterchen247:alarm-scheduler:x.x.x'
}
```
## How to Use
To see the complete usage of AlarmScheduler, please build and refer to the [demo app](https://github.com/CarterChen247/AlarmScheduler/tree/develop/app).
### Schedule an Alarm
#### 1️⃣ Define a AlarmTask callback
```kotlin
AlarmScheduler.setAlarmTaskFactory(object : AlarmTaskFactory {
override fun createAlarmTask(alarmType: Int): AlarmTask {
return MyAlarmTask()
}
})
```
```kotlin
class MyAlarmTask : AlarmTask {
override fun onAlarmFires(alarmId: Int, dataPayload: DataPayload) {
// do something with dataPayload you set
}
companion object {
const val TYPE = 1
}
}
```
#### 2️⃣ And then just schedule it!
```kotlin
val config = AlarmConfig(
Date().time + 10000L, // trigger time
MyAlarmTask.TYPE
) {
dataPayload("reminder" to "have a meeting")
}
AlarmScheduler.schedule(config){ ... }
```
#### 3️⃣ Handle the result on your own
```kotlin
AlarmScheduler.schedule(config) { result: ScheduleResult ->
when (result) {
is ScheduleResult.Success -> {
// alarm scheduling success!
}
is ScheduleResult.Failure -> {
when (result) {
ScheduleResult.Failure.CannotScheduleExactAlarm -> {
// handle scenarios like user disables exact alarm permission
}
is ScheduleResult.Failure.Error -> {
// handle error
}
}
}
}
}
```
### For Android 12+
When receiving a `CannotScheduleExactAlarm` failure result, it means the user disable the exact alarm permission. Try to use `openExactAlarmSettingPage()` extension function with prompts to guide your user.
```kotlin
fun Activity.openExactAlarmSettingPage() {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S) {
startActivity(Intent(Settings.ACTION_REQUEST_SCHEDULE_EXACT_ALARM))
}
}
```
get notified once user grants the exact alarm permission.
```kotlin
AlarmSchedulerEventObserver { event ->
if (event is ScheduleExactAlarmPermissionGrantedEvent) {
// get notified
}
}
```
### Debugging
If something is not working, enable the built-in logger to see what’s going on.
```kotlin
AlarmScheduler.setLogger(AlarmSchedulerLogger.DEBUG)
```
### Other Features
```kotlin
AlarmScheduler.getScheduledAlarmsAsync { scheduledAlarms: List ->
// list the scheduled alarms
}
```
There are more! refer to [AlarmSchedulerContract](https://github.com/CarterChen247/AlarmScheduler/blob/develop/alarmscheduler/src/main/java/com/carterchen247/alarmscheduler/AlarmSchedulerContract.kt) see full APIs.
```kotlin
internal interface AlarmSchedulerContract {
fun setAlarmTaskFactory(alarmTaskFactory: AlarmTaskFactory)
fun setLogger(loggerImpl: AlarmSchedulerLogger)
fun setErrorHandler(errorHandler: AlarmSchedulerErrorHandler)
fun isAlarmTaskScheduled(alarmId: Int): Boolean
fun cancelAlarmTask(alarmId: Int)
fun cancelAllAlarmTasks()
fun getScheduledAlarmsAsync(callback: ScheduledAlarmsCallback)
fun addEventObserver(observer: AlarmSchedulerEventObserver)
fun removeEventObserver(observer: AlarmSchedulerEventObserver)
fun schedule(config: AlarmConfig, callback: ScheduleResultCallback?)
fun canScheduleExactAlarms(): Boolean
}
```
## Apps using AlarmScheduler
- [吉時倒垃圾(GarbageTruckAlarm)](https://play.google.com/store/apps/details?id=com.carterchen247.garbagetruckalarm&hl=zh_TW)
## License
```
MIT License
Copyright (c) 2020 Carter Chen
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```