notifications 0.0.2

  • README.md
  • CHANGELOG.md
  • Example
  • Installing
  • Versions
  • new45

notifications

pub package

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

Notifications notifications = new Notifications();
StreamSubscription<NotificationEvent> events;
events = notifications.noiseStream.listen(onData);

Where the onData() method handles the incoming NotificationEvents. An example could be:

void onData(NotificationEvent event) => print(event.toString());

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.

0.0.1

  • TODO: Describe initial release.

example/README.md

notifications_example

Demonstrates how to use the notifications plugin.

Getting Started

For help getting started with Flutter, view our online documentation.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  notifications: ^0.0.2

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter packages get

Alternatively, your editor might support flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:notifications/notifications.dart';
  
Version Uploaded Documentation Archive
0.0.2 Nov 23, 2018 Go to the documentation of notifications 0.0.2 Download notifications 0.0.2 archive
0.0.1 Nov 23, 2018 Go to the documentation of notifications 0.0.1 Download notifications 0.0.1 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
90
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
90
Overall:
Weighted score of the above. [more]
45
Learn more about scoring.

We analyzed this package on Dec 5, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.1.0
  • pana: 0.12.7
  • Flutter: 1.0.0

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Health issues and suggestions

Document public APIs (-10 points)

6 out of 6 API elements (library, class, field or method) have no adequate dartdoc content. Good documentation improves code readability and discoverability through search.

Maintenance suggestions

Package is pre-v0.1 release. (-10 points)

While there is nothing inherently wrong with versions of 0.0.*, it usually means that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.68.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11
meta 1.1.6
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8