Note the following cases. This commit is catering for case 3:
1. User is listening for onNotificationDisplayed and is manually calling
the completionHandler
- manually called completionHandler is removed
- automatically called completionHandler is guarded against on iOS
native side
2. User is listening for onNotificationDisplayed and is not calling the
completionHandler:
- automatically called completionHandler is removed
3. User is not listening for onNotificationDisplayed
- On rn side we can only automatically call completionHandler if the
user _is_ listening. This means we need to detect if the user is
listening or not.
There are some cases when local notification action should be handled in
background eg. snoozing the reminder. In case of it launching app UI is
not necessary and would be confusing for the end user.
Therefore there should be a way to handle local notification action in
background.
For this reason new property 'runInBackground' was added to the
AndroidAction class and TypeScript type.
Also new broadcast receiver and service were implemented to handle
properly background actions.
In order to run particular action in background API consumer need to set its
'runInBackground' property to 'true', eg:
...
.android.addAction(new firebase.notifications.Android.Action("snooze",
"ic_snooze", "Snooze").setRunInBackground(true))
...
Then, there are two cases that API consumer needs to handle.
First when app is in the foreground, standard notification and
notification action code path will be executed. This mean, that:
* onNotification() listener will be called (which should call
displayNotification(), in order to show it to the user),
* onNotificationOpen() listener will be called after the action is
tapped by the user
Secondly, when application is in background or it is not running new
'RNFirebaseBackgroundNotificationAction' handler will be called. To
properly handle this case API consumer should create a background
asynchronous handler:
const handleAsyncTask = async (notificationOpen: NotifficationOpen) => {
if (notificationOpen && notificationOpen.notification) {
const action = notificationOpen.action;
const notificationId = notificationOpen.notification.notificationId;
if (action === "snooze") {
console.log("Reschedule notification for later time", notificationId);
} else {
console.log("unsupported action", action);
}
// hide the notification
firebase.notifications().removeDeliveredNotification(notificationId);
}
}
Next hander should be registered to headless handler:
AppRegistry.registerHeadlessTask('RNFirebaseBackgroundNotificationAction', () => handleAsyncTask);
Finally AndroidManifest.xml file must be modified, to include receiver
and service definition:
<receiver
android:name="io.invertase.firebase.notifications.RNFirebaseBackgroundNotificationActionReceiver"
android:exported="true">
<intent-filter>
<action android:name="io.invertase.firebase.notifications.BackgroundAction"/>
</intent-filter>
</receiver>
<service android:name="io.invertase.firebase.notifications.RNFirebaseBackgroundNotificationActionsService"/>
Now when ever 'Snooze' action is pressed it will launch
'handleAsyncTask' function in the background or onNotificationOpen()
when app is in foreground. And reschedule the notification
for the later time.
Ryan Grey
Salakar
Chris Bianca
Ken Lim
Case Taintor
aMarCruz
sowdri
Dariusz Luksza