flutter_notification_listener 1.1.1

Flutter Plugin to listen to all incoming notifications for Android.

flutter_notification_listener

Flutter Plugin to listen to all incoming notifications for Android.

---

Features

• Service: start a foreground service to listen the notifications.
• Easy: you can get the notifaction fields: id, timestamp, title, message, largeIcon and package.
• Backgrounded: execute the dart code in the background and auto start the service after reboot.

Get Start

0. 💻 Install package

In the dependencies: section of your pubspec.yaml, add the following line:

flutter_notification_listener: <latest_version>

1. Register the service in the manifest

The plugin uses an Android system service to track notifications. To allow this service to run on your application, the following code should be put inside the Android manifest, between the tags.

<service android:name="im.zoe.labs.flutter_notification_listener.NotificationsHandlerService"
    android:label="Flutter Notifications Handler"
    android:permission="android.permission.BIND_NOTIFICATION_LISTENER_SERVICE">
    <intent-filter>
        <action android:name="android.service.notification.NotificationListenerService" />
    </intent-filter>
</service>

If you want to start the service after reboot, also should put the following code.

<receiver android:name="im.zoe.labs.flutter_notification_listener.RebootBroadcastReceiver"
    android:enabled="true">
    <intent-filter>
        <action android:name="android.intent.action.BOOT_COMPLETED" />
    </intent-filter>
</receiver>

And don't forget to add the permissions to the manifest,

<uses-permission android:name="android.permission.WAKE_LOCK" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
<!-- this pemission is for auto start service after reboot -->
<uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED"/>

2. Init the plugin and add listen handler

We have a default static event handler which send event with a channel. So if you can listen the event in the ui logic simply.

// define the handler for ui
void onData(NotificationEvent event) {
    print(event.toString());
}

Future<void> initPlatformState() async {
    NotificationsListener.initialize();
    // register you event handler in the ui logic.
    NotificationsListener.receivePort.listen((evt) => onData(evt));
}

You should know that the function (evt) => onData(evt) would not be called if the ui thread is not running.

⚠️ It's recommended that you should register your own static function callbackHandle to handle the event which make sure events consumed.

That means the callbackHandle static function is guaranteed, while the channel handle function is not. This is every useful when you should persist the events to the database.

Future<void> initPlatformState() async {
    // register the static to handle the events
    NotificationsListener.initialize(callbackHandle: _callback);
}

static void _callback(NotificationEvent evt) {
    print("send evt to ui: $evt");
    // try to send the event to ui
    final SendPort send = IsolateNameServer.lookupPortByName("_listener_");
    if (send == null) print("can't find the sender");
    send?.send(evt);

    // persist data immediately
    // db.save(evt)
}

3. Check permission and start the service

void startListening() async {
    print("start listening");
    var hasPermission = await NotificationsListener.hasPermission;
    if (!hasPermission) {
        print("no permission, so open settings");
        NotificationsListener.openPermissionSettings();
        return;
    }

    var isR = await NotificationsListener.isRunning;

    if (!isR) {
        await NotificationsListener.startService();
    }

    setState(() => started = true);
}

Please check the ./example/lib/main.dart for more detail.

Issues

• If the service is not foreground, service will start failed after reboot.

APIs

NotificationsListener static methods or fields.

• hasPermission(): check if we have grant the listen notifaction permission.
• openPermissionSettings(): open the system listen notifactoin permission setting page.
• initialize(): int the service, this should be called at first.
• isRunning: check if the service is already running.
• startService(): start the listening service.
• stopService(): stop the listening service.
• registerEventHandle(Function callback): register the event handler which will be called from android service, shoube be static function.