Extends capacitor PushNotifications plugin to handle received data notification
npm install capacitor-notification-extensionslocalNotificationReceived event listener which is not working properly bash
npm i capacitor-notification-extensions --save
`
Android
1. Add NotificationExtension class to your MainActivity.
java
public class MainActivity extends BridgeActivity {
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// Initializes the Bridge
this.init(savedInstanceState, new ArrayList>() {{
add(YourAwesomePlugins.class);
...
add(NotificationExtension.class);
add(LocalNotificationExtension.class);
}});
}
}
`
2. Add meta data and intent filter to manifest inside application tag and add db_name to string values.
- AndroidManifest.xml
xml
...
`
- strings.xml
xml
TODO
`iOS
1. Add silent notification to your AppDelegate
swift
class AppDelegate: UIResponder, UIAppicationDelegate {
...
func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable : Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) {
NotificationCenter.default.post(name: Notification.Name("SilentNotification"), object: nil, userInfo: userInfo)
}
...
}
`
2. Add some data to your Info.plist
xml
...
LocalDatabase
TODO
...
UIBackgroundModes
remote-notification
...
`Electron
Have no plans to support yet.Documentation
NotificationExtension
>If you are new on firebase messaging, I recommend reading this documentation first to understand about two concepts of notification message.
>
NotificationExtension class is child of default plugin PushNotification. You can check arguments and return of methods from the link above.
This plugin creates a sqlite table with its own schema.$3
Message in both platform shouldn't contain notification key which makes message as alert message.
- Android
Get data from yourMessagePayload.data. (Check how payload parsed)
- iOS
Get data from yourMessagePayload.apns.payload.aps.custom_data. (Check how payload parsed)
---
Both platforms' payload should contain keys below.
- isShown: Optional, boolean string('true' or 'false'), always true if not exists.
- body: Optional, string, body of notification message
- title: Optional, string, title of notification message
- filter: Optional, comma-separated string, hide notification if matched filter with false value exists.
- Any other data you that want to use in your application$3
All key-value based filters which is added or removed by addFilters and removeFilters method will be saved in the local database.
There are two filters that specially checks before show notification, which is time-based filter and logged-in filter.
- logged-in filter
If you add a filter with key is_logged_in, this filter will always be checked on a message received even if payload doesn't contain filter key.
- time-based filter
If you add a filter with addTimeFilter method, three rows will be generated in the local database. (filter_start_from, filter_end_at, is_time_filter_on)
This filter will always be checked on a message received even if payload doesn't contain filter key.
addTimeFilter method only takes string with HH:mm format and will raise some validation error if is malformed.$3
In your js application,
`typescript
import { Plugins } from '@capacitor/core';const { NotificationExtension } = Plugins
NotificationExtension.addListener('pushNotificationActionPerformed', (notification: PushNotificationActionPerformed) => {
// Same as PushNotification plugin
// You can deal with your payload
});
NotificationExtension.addListener('pushNotificationReceived', (notification: YourPayloadType) => {
// Same as PushNotification plugin
// Only works when the app is on foreground
});
NotificationExtension.register();
NotificationExtension.addFilters({ filters: ['anyString', 'youPromised', 'withBackend'] });
// Any data notification that contains key named 'filter' with value matched above will be suppressed by plugin.
NotificationExtension.removeFilters({ filters: ['youPromised'] });
// filtering 'youPromised' stop working
NotificationExtension.getFilters().then((result) => {
// result will be { value: ['anyString', 'withBackend'] }
});
NotificationExtension.addTimeFilter({ startFrom: '23:00', endAt: '07:00' });
// every notification that received between 11PM to 7AM will be suppressed
`LocalNotificationExtension
doesn't work in android if you use capacitor 2.x,
this class just a bug fix that only overrides a receiver to notify a message received event to listener.
(This will be solved in capacitor 3.x, merged commit link)
Use this plugin for android only. (This class hasn't implemented for iOS) $3
`typescript
import { LocalNotification, Plugins } from '@capacitor/core';const { LocalNotifications, LocalNotificationExtension } = Plugins;
class YourServiceOrComponent {
constructor() {}
get localNotificationPlugin() {
return this.platform.is('android') ? LocalNotificationExtension : LocalNotifications;
}
yourMethod() {
this.LocalNotificationPlugin.addListener('localNotificationReceived', (localNotification: LocalNotification) => {
// Do what you want
});
}
}
``