Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thomasgalliker/Plugin.FirebasePushNotifications

Receive and handle firebase push notifications in .NET MAUI apps
https://github.com/thomasgalliker/Plugin.FirebasePushNotifications

firebase maui notifications push

Last synced: about 1 month ago
JSON representation

Receive and handle firebase push notifications in .NET MAUI apps

Awesome Lists containing this project

README 

        
# Plugin.FirebasePushNotifications

[![Version](https://img.shields.io/nuget/v/Plugin.FirebasePushNotifications.svg)](https://www.nuget.org/packages/Plugin.FirebasePushNotifications)  [![Downloads](https://img.shields.io/nuget/dt/Plugin.FirebasePushNotifications.svg)](https://www.nuget.org/packages/Plugin.FirebasePushNotifications)



Plugin.FirebasePushNotifications provides a seamless way to engage users and keep them informed about important events in your .NET MAUI applications. This open-source C# library integrates Firebase Cloud Messaging (FCM) into your .NET MAUI projects, enabling you to receive push notifications effortlessly.



### Features

* Cross-platform Compatibility: Works seamlessly with .NET MAUI, ensuring a consistent push notification experience across different devices and platforms.

* Easy Integration: Simple setup process to incorporate Firebase Push Notifications into your .NET MAUI apps.

* Flexible Messaging: Utilize FCM's powerful features, such as targeted messaging, to send notifications based on user segments or specific conditions.



### Download and Install Plugin.FirebasePushNotifications

This library is available on NuGet: https://www.nuget.org/packages/Plugin.FirebasePushNotifications

Use the following command to install Plugin.FirebasePushNotifications using NuGet package manager console:



    PM> Install-Package Plugin.FirebasePushNotifications



You can use this library in any .NET MAUI project compatible to .NET 7 and higher.



### Setup

#### Setup Firebase Push Notifications

- Go to https://console.firebase.google.com and create a new project. The setup of Firebase projects is not (yet?) documented here. Contributors welcome!

- You have to download the resulting Firebase service files and integrate them into your .NET MAUI csproj file. `google-services.json` is used by Android while `GoogleService-Info.plist` is accessible to iOS. Make sure the Include and the Link paths match.

```



	



	



```

- iOS apps need to be enabled to support push notifications. Turn on the "Push Notifications" capability of your app in the [Apple Developer Portal](https://developer.apple.com).



#### App Startup



This plugin provides an extension method for MauiAppBuilder `UseFirebasePushNotifications` which ensure proper startup and initialization. Call this method within your `MauiProgram` just as demonstrated in the MauiSampleApp:



```csharp

var builder = MauiApp.CreateBuilder()

    .UseMauiApp()

    .UseFirebasePushNotifications();

```



`UseFirebasePushNotifications` has optional configuration parameters which are documented in another section of this document.



### API Usage

`IFirebasePushNotification` is the main interface which handles most of the desired Firebase push notification features. This interface is injectable via dependency injection or accessible as a static singleton instance `IFirebasePushNotification.Current`. We strongly encourage you to use the dependency injection approach in order to keep your code testable.



The following lines of code demonstrate how the `IFirebasePushNotification` instance is injected in `MainViewModel` and assigned to a local field for later use:

```csharp

public MainViewModel(

    ILogger logger,

    IFirebasePushNotification firebasePushNotification)

{

    this.logger = logger;

    this.firebasePushNotification = firebasePushNotification;

}

```



#### Managing Notification Permissions

Before we can receive any notification we need to make sure the user has given consent to receive notifications. `INotificationPermissions` is the service you can use to check the current authorization status or ask for notification permission.

You can either inject `INotificationPermissions` into your view models or access it via the the static singleton instance `INotificationPermissions.Current`.



- Check the current notification permission status:

```csharp

this.AuthorizationStatus = await this.notificationPermissions.GetAuthorizationStatusAsync();

```



- Ask the user for notification permission:

```csharp

await this.notificationPermissions.RequestPermissionAsync();

```



Notification permissions are handled by the underlying operating system (iOS, Android). This library just wraps the platform-specific methods and provides a uniform API for them.



#### Receive Notifications

The main goal of a push notification client library is to receive notification messages. This library provides a set of classic .NET events to inform your code about incoming push notifications.

Before any notification event is received, we have to inform the Firebase client library, that we're ready to receive notifications.

`RegisterForPushNotificationsAsync` registers our app with the Firebase push notification backend and receives a token. This token is used by your own server/backend to send push notifications directly to this particular app instance.

The token may change after some time. It is not controllable by this library if/when the token is going to be updated. The `TokenRefreshed` event will be fired whenever a new token is available.

See `Token` property and `TokenRefreshed` event provided by `IFirebasePushNotification` for more info.



```csharp

await this.firebasePushNotification.RegisterForPushNotificationsAsync();

```



If we want to turn off any incoming notifications, we can unregister from push notifications. The `Token` can no longer be used to send push notifications to.

```csharp

await this.firebasePushNotification.UnregisterForPushNotificationsAsync();

```



Following .NET events can be subscribed:

- `IFirebasePushNotification.TokenRefreshed` is raised whenever the Firebase push notification token is updated. You'll need to inform your server/backend whenever a new push notification token is available.



- `IFirebasePushNotification.NotificationReceived` is raised when a new push notification message was received.



- `IFirebasePushNotification.NotificationOpened` is raised when a received push notification is opened. This means, a user taps on a received notification listed in the notification center provided by the OS.



- `IFirebasePushNotification.NotificationAction` is raised when the user taps a notification action. Notification actions allow users to make simple decisions when a notification is received, e.g. "Do you like to take your medicine?" could be answered with "Take medicine" and "Skip medicine".



- `IFirebasePushNotification.NotificationDeleted` is raised when the user deletes a received notification.



#### Topics

The most common way of sending push notifications is by targeting notification message directly to push tokens.

Firebase allows to send push notifications to groups of devices, so-called topics.

If a user subscribes to a topic, e.g. "weather_updates" you can send push notifications to this topic instead of a list of push tokens.



##### Subscribe to Topics

Use method `SubscribeTopic` with the name of the topic.

```csharp

this.firebasePushNotification.SubscribeTopic("weather_updates");

```



Important:

- Make sure you did run `RegisterForPushNotificationsAsync` before you subscribe to topics.

- Topic names are case-sensitive: Registrations for topic `"weather_updates"` will not receive messages targeted to topic `"Weather_Updates"`.



##### Send Notifications to Topic Subscribers

Use the Firebase Admin SDK (or any other HTTP client) to send a push notification targeting subscribers of the "weather_updates" topic:



`HTTP POST https://fcm.googleapis.com/v1/projects/{{project_id}}/messages:send`

```

{

    "message": {

        "topic": "weather_updates",

        "notification": {

            "title": "Weather Update",

            "body": "Pleasant with clouds and sun"

        },

        "data": {

            "sunrise": "1684926645",

            "sunset": "1684977332",

            "temp": "292.55",

            "feels_like": "292.87"

        }

    }

}

```



![Notification Topic weather_updates](Docs/notificationtopic_weatherupdates.png?raw=true)



#### Notification Actions

Notification actions are special buttons which allow for immediate response to a particular notification. A list of `NotificationActions` is consolidated within a `NotificationCategory`.



##### Register Notification Actions

The following example demonstrates the registration of a notification category with identifier "medication_intake" and two actions "Take medicine" and "Skip medicine":

```csharp

var categories = new[]

{

    new NotificationCategory("medication_intake", new[]

    {

        new NotificationAction("take_medication", "Take medicine", NotificationActionType.Foreground),

        new NotificationAction("skip_medication", "Skip medicine", NotificationActionType.Foreground),

    })

};

```



Notification categories are usually registered at app startup time using the following method call:

```csharp

IFirebasePushNotification.Current.RegisterNotificationCategories(categories);

```



##### Subscribe to Notification Actions

Subscribe the event `IFirebasePushNotification.NotificationAction` to get notified if a user presses one of the notification action buttons.

The delivered event args `FirebasePushNotificationResponseEventArgs` will let you know which action was pressed.



##### Send Notification Actions

Use the Firebase Admin SDK (or any other HTTP client) to send a push notification with:



`HTTP POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send`

```

{

    "message": {

        "token": "XXXXXXXXXX",

        "notification": {

            "title": "Medication Intake",

            "body": "Do you want to take your medicine?"

        },

        "data": {

            "priority": "high"

        },

        "android": {

            "notification": {

                "click_action": "medication_intake"

            }

        },

        "apns": {

            "payload": {

                "aps": {

                    "category": "medication_intake"

                }

            }

        }

    }

}

```



If everything works fine, the mobile device with the given token displays the notification action as follows:



![Notification Category medication_intake](Docs/notificationcategory_takemedicine.png?raw=true)



#### More Push Notification Scenarios

There are a lot of features in this library that can be controlled via specific data flags. The most common scenarios

are end-to-end tested using postman calls. You can find an up-to-date postman collection in this repository:

[FCM Plugin.FirebasePushNotifications.postman_collection.json]()



- Import the collection in postman.

- Adjust the variables, especially the `project_id` and the `fcm_token` accordingly.

- Authenticate each call by selecting the Auth Type "Firebase Cloud Messaging API (Oauth 2.0)".

- Press "Authorize" and enter the credentials of a user which is allowed to send FCM messages for the configured FCM project.



### Options

> *to be documented*



### Contribution

Contributors welcome! If you find a bug or you want to propose a new feature, feel free to do so by opening a new issue on github.com.



### Links

- FCM messages, data format, concepts and options: https://firebase.google.com/docs/cloud-messaging/concept-options

- Set up a Firebase Cloud Messaging client app on Apple platforms: https://firebase.google.com/docs/cloud-messaging/ios/client

- Set up a Firebase Cloud Messaging client app on Android: https://firebase.google.com/docs/cloud-messaging/android/client

- Expandable notification on Android: https://developer.android.com/develop/ui/views/notifications/expanded