notifications

notifications

A plugin for tracking notifications on the device. Works exclusively for Android.

Installation

Add notifications as a dependency in pubspec.yaml. For help on adding as a dependency, view the documentation.

Usage

Android: Register service in the manifest

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

<service android:name="cachet.plugins.notifications.NotificationListener"
    android:label="notifications"
    android:permission="android.permission.BIND_NOTIFICATION_LISTENER_SERVICE">
    <intent-filter>
        <action android:name="android.service.notification.NotificationListenerService" />
    </intent-filter>
</service>

Flutter: Listen to notification events

All incoming data points are streamed with a StreamSubscription which is set up by calling the listen() method on the notificationStream stream object.

Given a method onData(NotificationEvent event) the subscription can be set up as follows:

Notifications _notifications;
StreamSubscription _subscription;
...
void onData(NotificationEvent event) {
    print(event.toString());
}

void startListening() {
    _notifications = new Notifications();
    try {
      _subscription = _notifications.notificationStream.listen(onData);
    } on NotificationException catch (exception) {
      print(exception);
    }
}

To stop listening, call cancel() on the subcription object:

void stopListening() {
  _subscription.cancel();
}

Notification Information

Every time a notification is registered a NotificationEvent is received in Flutter, containing the following attributes:

• packageName [String]: The name of the application which triggered the notification.
• timeStamp [DateTime]: The timestamp at which the notification was received.
  • Alternatively, timeStamp can be converted to a unix timestamp using timeStamp.millisecondsSinceEpoch.