Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(push-notifications): use id and tag for canceling active notification #1041

Merged
merged 11 commits into from
Jun 16, 2022
Merged

fix(push-notifications): use id and tag for canceling active notification #1041

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
fcf5f76
returning tag in notification object
theproducer Jun 14, 2022
6f318a2
using tag to cancel notifications
theproducer Jun 14, 2022
2212014
using correct tag property
theproducer Jun 14, 2022
0dca86a
Updating definitions
theproducer Jun 15, 2022
175b65e
using id only cancel if tag is null
theproducer Jun 15, 2022
37edb9c
adding default value for id
theproducer Jun 15, 2022
0d22e64
Updating tag property version
theproducer Jun 15, 2022
8681003
Merge branch 'capacitor-4' into push-notifications-delete-active
theproducer Jun 15, 2022
1ae78ce
fmt
theproducer Jun 16, 2022
27a29c1
Building docs, removing unneeded default id value
theproducer Jun 16, 2022
f7b15a0
Merge branch 'capacitor-4' into push-notifications-delete-active
jcesarmobile Jun 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions push-notifications/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -452,6 +452,7 @@ Remove all native listeners for this plugin.
| **`subtitle`** | <code>string</code> | The notification subtitle. | 1.0.0 |
| **`body`** | <code>string</code> | The main text payload for the notification. | 1.0.0 |
| **`id`** | <code>string</code> | The notification identifier. | 1.0.0 |
| **`tag`** | <code>string</code> | The notification tag. Only available on Android (from push notifications). | 1.0.9 |
| **`badge`** | <code>number</code> | The number to display for the app icon badge. | 1.0.0 |
| **`notification`** | <code>any</code> | It's not being returned. | 1.0.0 |
| **`data`** | <code>any</code> | Any additional data that was included in the push notification payload. | 1.0.0 |
Expand Down
14 changes: 8 additions & 6 deletions ...roid/src/main/java/com/capacitorjs/plugins/pushnotifications/PushNotificationsPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ public void getDeliveredNotifications(PluginCall call) {
JSObject jsNotif = new JSObject();

jsNotif.put("id", notif.getId());
jsNotif.put("tag", notif.getTag());

Notification notification = notif.getNotification();
if (notification != null) {
Expand Down Expand Up @@ -128,13 +129,18 @@ public void getDeliveredNotifications(PluginCall call) {
public void removeDeliveredNotifications(PluginCall call) {
JSArray notifications = call.getArray("notifications");

List<Integer> ids = new ArrayList<>();
try {
for (Object o : notifications.toList()) {
if (o instanceof JSONObject) {
JSObject notif = JSObject.fromJSONObject((JSONObject) o);
String tag = notif.getString("tag");
jcesarmobile marked this conversation as resolved.
Show resolved Hide resolved
Integer id = notif.getInteger("id");
ids.add(id);

if (tag == null) {
notificationManager.cancel(id);
} else {
notificationManager.cancel(tag, id);
}
} else {
call.reject("Expected notifications to be a list of notification objects");
}
Expand All @@ -143,10 +149,6 @@ public void removeDeliveredNotifications(PluginCall call) {
call.reject(e.getMessage());
}

for (int id : ids) {
notificationManager.cancel(id);
}

call.resolve();
}

Expand Down
9 changes: 9 additions & 0 deletions push-notifications/src/definitions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,15 @@ export interface PushNotificationSchema {
*/
id: string;

/**
* The notification tag.
*
* Only available on Android (from push notifications).
*
* @since 1.0.9
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* @since 1.0.9
* @since 4.0.0

This will be available on version 4.0.0 of the plugin

*/
tag?: string;

/**
* The number to display for the app icon badge.
*
Expand Down