Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DevsOnFlutter/reflex
Flutter plugin to read notifications and auto reply with custom messages
https://github.com/DevsOnFlutter/reflex
android auto-reply flutter notifications plugin
Last synced: about 2 months ago
JSON representation
Flutter plugin to read notifications and auto reply with custom messages
- Host: GitHub
- URL: https://github.com/DevsOnFlutter/reflex
- Owner: DevsOnFlutter
- License: bsd-3-clause
- Created: 2021-12-17T02:11:58.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-02-13T02:39:39.000Z (almost 3 years ago)
- Last Synced: 2024-08-01T12:29:52.016Z (5 months ago)
- Topics: android, auto-reply, flutter, notifications, plugin
- Language: Java
- Homepage: https://pub.dev/packages/reflex
- Size: 135 KB
- Stars: 20
- Watchers: 0
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Reflex
Flutter plugin for notification read & reply.
       
## Compatibility
✅ Android
❌ iOS (active issue: [iOS support for reflex](https://github.com/DevsOnFlutter/reflex/issues/1))
## Show some :heart: and :star: the repo
## Why use Reflex?
Reflex Plugin is known for:
| Reflex |
| :--------------------------------- |
| Fast, performant & compatible |
| Free & Open-source |
| Production ready |
| Make App Reactive |
## Features
All the features listed below can be performed at the runtime.
✅ Get Notification Stream
✅ Read Notification
✅ Reply From Notification
✅ Auto Reply
## Demo
|
|
|---|
## Quick Start
### Step 1: Include plugin to your project
```yml
dependencies:
reflex:
```
Run `pub get` and get packages.
### Step 2: Add Service in `AndroidManifest.xml`
Add the following service inside the `application` tag of `AndroidManifest.xml`.
```xml
...
```
**Android 12+ Compatibility**
Add `android:exported="true"` field in the service tag to make it compatible with Android 12+.
```xml
...
```
### Step 3: Instantiate Reflex
Reflex must only be instantiated only once.
```dart
Reflex reflex = Reflex();
```
## Example
Go to example section in pub.dev to see the full example code.
In GitHub, head over to `example/lib/main.dart` to see the full example code.
### Import
This single import is enough for using reflex.
```dart
import 'package:reflex/reflex.dart';
```
### Listen & Reply
```dart
StreamSubscription? _subscription;
final List _notificationLogs = [];
final List _autoReplyLogs = [];
bool isListening = false;
Reflex reflex = Reflex(
debug: true,
packageNameList: ["com.whatsapp", "com.tyup"],
packageNameExceptionList: ["com.android.systemui"],
autoReply: AutoReply(
packageNameList: ["com.whatsapp"],
message: "[Reflex] This is an automated reply.",
),
);
@override
void initState() {
super.initState();
initPlatformState();
}
Future initPlatformState() async {
startListening();
}
void onData(ReflexEvent event) {
setState(() {
if (event.type == ReflexEventType.notification) {
_notificationLogs.add(event);
} else if (event.type == ReflexEventType.reply) {
_autoReplyLogs.add(event);
}
});
debugPrint(event.toString());
}
void startListening() {
try {
_subscription = reflex.notificationStream!.listen(onData);
setState(() {
isListening = true;
});
} on ReflexException catch (exception) {
debugPrint(exception.toString());
}
}
void stopListening() {
_subscription?.cancel();
setState(() => isListening = false);
}
```
## Quick Guide
A quick guide to **Flutter Reflex plugin**!
### Debugging
Debugging allows you to debug the plugin's functionality, logs are shown in the console.
By default debug logging is enabled. You can configure it using the debug field in the Reflex class.
```dart
Reflex reflex = Reflex(
debug: false,
);
```
### Listen notification permission
See if listening notification permission has been granted or not.
```dart
bool isPermissionGranted = await Reflex.isPermissionGranted;
```
### Request notification listening permission
Use the function to grant notification listening permission.
```dart
await Reflex.requestPermission();
```
### Notification Stream
Use the reflex object to get a notification stream to listen to notifications in your flutter application.
```dart
StreamSubscription? _subscription;
_subscription = reflex.notificationStream!.listen((event) {
// Application Logic
});
```
The stream is subscribed for `ReflexEvent` whenever a notification is received.
#### Reflex Event
The incoming reflex event contains:
* **type**: `ReflexEventType.notification` whenever a notification is received to flutter application, and `ReflexEventType.reply` whenever an automated reply is sent.
* **packageName**: Application's package name from which notifications are received and reply are sent.
* **title**: Notification title
* **message**: Message contained in the notification and while sending reply.
* **timestamp**: Timestamp of the notification received and reply sent.
### Listen notification from specific apps
Specify list of package names to listen to notifications from those applications.
If `packageNameList: null` plugin will listen to notifications from all packages.
```dart
Reflex reflex = Reflex(
debug: true,
packageNameList: ["com.whatsapp", "com.facebook"],
);
```
### Avoid notification from specific apps
Specify package name exception list to avoid listening notifications from those applications.
If `packageNameExceptionList: null`, the plugin will listen to notifications for `packageNameList` if not null.
```dart
Reflex reflex = Reflex(
debug: true,
packageNameExceptionList: ["com.whatsapp"],
);
```
### Auto Reply
Send an automated reply while listening notification.
```dart
AutoReply autoReply = AutoReply(
message: "[Reflex] This is an automated reply.",
),
```
#### Auto reply specific apps
Specify `packageNameList` in AutoReply to reply to specific applications.
```dart
AutoReply autoReply = AutoReply(
packageNameList: ["com.whatsapp"],
message: "[Reflex] This is an automated reply.",
),
```
The `AutoReply` object is used by the Reflex's `autoReply` field to automatically reply to applications.
```dart
Reflex reflex = Reflex(
debug: true,
packageNameList: ["com.whatsapp", "com.tyup"],
packageNameExceptionList: ["com.miui.securitycenter"],
autoReply: AutoReply(
packageNameList: ["com.whatsapp"],
message: "[Reflex] This is an automated reply.",
),
);
```
If the `autoReply` field is `null` in `Reflex` class, Auto reply feature will be disabled.
## Ambiguity
A `ReflexException` will be thrown if,
* `Reflex`'s `packageNameList` and `packageNameExceptionList` contains any similar package name.
* any package name in `AutoReply`'s `packageNameList` is contained in `Reflex`'s `packageNameExceptionList`.
## Project Created & Maintained By
### Divyanshu Shekhar
[](https://github.com/divshekhar/)
### Subham Praharaj
[](https://github.com/skpraharaj/)
## Contributions
Contributions are welcomed!
**If you feel that a hook is missing, feel free to open a pull-request.**
For a custom-hook to be merged, you will need to do the following:
* Describe the use-case.
* Open an issue explaining why we need this hook, how to use it, ...
This is important as a hook will not get merged if the hook doens't appeal to
a large number of people.
* If your hook is rejected, don't worry! A rejection doesn't mean that it won't
be merged later in the future if more people shows an interest in it.
In the mean-time, feel free to publish your hook as a package on [https://pub.dev](https://pub.dev).
* A hook will not be merged unles fully tested, to avoid breaking it inadvertendly in the future.
## Stargazers
[](https://github.com/DevsOnFlutter/reflex/stargazers)
## Forkers
[](https://github.com/DevsOnFlutter/reflex/network/members)
## Copyright & License
Code and documentation Copyright (c) 2021 [Divyanshu Shekhar](https://hackthedeveloper.com). Code released under the [BSD 3-Clause License](./LICENSE).