A flutter package that using to create and manage Notification in Android
The fcm_channels_manager
is a flutter package that using to create and manage Notification in Android
Features
1. The plugin provide an API for Android to manage notification channels.
Support Android 8.0 (API level 26) and above. For more information, visit Create and Manage Notification Channels
- Create a new channel
- Get all channels that have been registered
- Delete a channel
2. Provide app notification settings in iOS
An option indicating the system should display a button for in-app notification settings. Support iOS 12.0 and above
Installation
In the pubspec.yaml
of your flutter project, add the following dependency:
dependencies:
fcm_channels_manager: <latest_version>
In your library add the following import:
import 'package:fcm_channels_manager/fcm_channels_manager.dart';
Usage
1. Create new channel
Return success message if channel registered successfully.
final result = await FcmChannelsManager().registerChannel(
id: "1001",
name: "Feedback notification",
description: "Receive new feedback and system's notification",
importance: NotificationImportance.importanceHight,
visibility: NotificationVisibility.public,
bubbles: true,
vibration: true,
sound: true,
badge: true,
);
- Notification importance level
Plugin value | Android Reference |
---|---|
NotificationImportance.disabled |
IMPORTANCE_NONE |
NotificationImportance.importanceMin |
IMPORTANCE_MIN |
NotificationImportance.importanceLow |
IMPORTANCE_LOW |
NotificationImportance.importanceDefault |
IMPORTANCE_DEFAULT |
NotificationImportance.importanceHight |
IMPORTANCE_HIGH |
- Notification visibility
Plugin value | Description |
---|---|
NotificationVisibility.public |
Show this notification in its entirety on all lockscreens |
NotificationVisibility.private |
Show this notification on all lockscreens, but conceal sensitive or private information on secure lockscreens |
NotificationVisibility.secret |
Do not reveal any part of this notification on a secure lockscreen |
2. Get all registered channels
You can get all registered channels with base informations about this channel: id
, name
, description
, importance
. You can check the importance level then handle your businesses.
final channesl = await FcmChannelsManager().getChannels();
3. Delete a channel
Remove registered channel by channel’s id. Return success message if channel deleted
final result = await FcmChannelsManager().unregisterChannel('1001')
4. Provide app notification settings
Return true if update .providesAppNotificationSettings
successfully. The function should call after request notification permission by using firebase_messaging
FcmChannelsManager()
.providesAppNotificationSettings()
.then((value) => log('Permission status: $value'));
Example
Follow the example: /example
Demo:
Contributions
Feel free to contribute to this project.
If you find a bug or want a feature, but don’t know how to fix/implement it, please fill an issue. If you fixed a bug or implemented a feature, please send a pull request.