From bf1ca1ba497ab936c8fb1ef02726805b4c788fbb Mon Sep 17 00:00:00 2001 From: Salvatore Giordano Date: Mon, 30 Aug 2021 11:20:41 +0200 Subject: [PATCH 1/2] docs(doc): add foreground push notification --- ...ions.mdx => adding_push_notifications.mdx} | 27 ++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) rename docusaurus/docs/Flutter/guides/{adding_push_notifcations.mdx => adding_push_notifications.mdx} (87%) diff --git a/docusaurus/docs/Flutter/guides/adding_push_notifcations.mdx b/docusaurus/docs/Flutter/guides/adding_push_notifications.mdx similarity index 87% rename from docusaurus/docs/Flutter/guides/adding_push_notifcations.mdx rename to docusaurus/docs/Flutter/guides/adding_push_notifications.mdx index 36da1373..6e5cbf1d 100644 --- a/docusaurus/docs/Flutter/guides/adding_push_notifcations.mdx +++ b/docusaurus/docs/Flutter/guides/adding_push_notifications.mdx @@ -187,8 +187,33 @@ StreamChat( As you can see we generate a local notification whenever a message.new or notification.message_new event is received. +### Foreground notifications + +Sometimes you want to show a notification when the app is in the foreground. +For example, when you're typing a message in a channel and you receive a new message from someone in another channel, you want to get notified about it. + +Even in this case you can use the `flutter_local_notifications` package to show a notification. + +You need to listen for new events using `StreamChatClient.on` and handle them accordingly. + +Here we're checking if the event is a `message.new` or `notification.message_new` event, and if the message is from a different user than the current user. In that case we'll show a notification. + +```dart +client.on( + EventType.messageNew, + EventType.notificationMessageNew, +).listen((event) { + if (event.message?.user?.id == client.state.currentUser?.id) { + return; + } + showLocalNotification(event, client.state.currentUser!.id, context); +}); +``` + :::note -Using `flutter_local_notifications` is a great way to implement notifications while the is in foreground too! You can generate a local notification listening to events using the method `streamChatClient.on()` and react to the events you want. +You should also check that the channel of the message is different than the channel in foreground. +How you can do this depends on your app infrastructure and how you handle navigation. +Take a look at the [Stream Chat v1 sample app](https://github.com/GetStream/flutter-samples/blob/main/packages/stream_chat_v1/lib/home_page.dart#L11) to see how we're doing it over there. ::: ### Saving notification messages to the offline storage From de8f0d9f938982231016e0f31fe7f092c0385334 Mon Sep 17 00:00:00 2001 From: Salvatore Giordano Date: Tue, 31 Aug 2021 09:11:27 +0200 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Gordon --- .../docs/Flutter/guides/adding_push_notifications.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docusaurus/docs/Flutter/guides/adding_push_notifications.mdx b/docusaurus/docs/Flutter/guides/adding_push_notifications.mdx index 6e5cbf1d..c90f6814 100644 --- a/docusaurus/docs/Flutter/guides/adding_push_notifications.mdx +++ b/docusaurus/docs/Flutter/guides/adding_push_notifications.mdx @@ -189,10 +189,10 @@ As you can see we generate a local notification whenever a message.new or notifi ### Foreground notifications -Sometimes you want to show a notification when the app is in the foreground. -For example, when you're typing a message in a channel and you receive a new message from someone in another channel, you want to get notified about it. +Sometimes you may want to show a notification when the app is in the foreground. +For example, when you're in a channel and you receive a new message from someone in another channel. -Even in this case you can use the `flutter_local_notifications` package to show a notification. +For this scenario, you can also use the `flutter_local_notifications` package to show a notification. You need to listen for new events using `StreamChatClient.on` and handle them accordingly. @@ -211,8 +211,8 @@ client.on( ``` :::note -You should also check that the channel of the message is different than the channel in foreground. -How you can do this depends on your app infrastructure and how you handle navigation. +You should also check that the channel of the message is different than the channel in the foreground. +How you do this depends on your app infrastructure and how you handle navigation. Take a look at the [Stream Chat v1 sample app](https://github.com/GetStream/flutter-samples/blob/main/packages/stream_chat_v1/lib/home_page.dart#L11) to see how we're doing it over there. :::