Plugin.LocalNotification

The local notification plugin provides a way to display local notifications in .NET MAUI apps.

Setup

• Plugin.LocalNotification Available on
  • NuGet: https://www.nuget.org/packages/Plugin.LocalNotification
  • NuGet: https://www.nuget.org/packages/Plugin.LocalNotification.Geofence
  • NuGet: https://www.nuget.org/packages/Plugin.LocalNotification.Core

• .Net MAUI

  • Install Version 10.0.0 above
  • Install into your project

• Xamarin.Forms (Support ended on May 1, 2024)

  • Install Version 11.0.0 below
  • Install into your platform-specific projects (iOS/Android), and any .NET Standard 2.0/2.1 projects required for your app.

Platform Support

| Feature | net10.0-ios | net10.0-android | | ----------------------------- | ----------- | --------------- | | Build SDK | >= 15 | >= API 36 | | Supported OS Version | >= 15 | >= API 21 | | Title | ✅ | ✅ | | Description | ✅ | ✅ | | Subtitle | ✅ | ✅ | | Schedule | ✅ | ✅ | | Repeat | ✅ | ✅ | | Custom Sounds | ✅ | ✅ | | Images | ✅ | ✅ | | Notification Actions | ✅ | ✅ | | Clear Delivered Notifications | ✅ | ✅ | | Get Pending Notifications | ✅ | ✅ | | Get Delivered Notifications | ✅ | ✅ | | Location Notifications | ✅ | ✅ | | App Launch Detection | ✅ | ✅ | | Notification Channels | ❌ | ✅ | | Notification Styles (Inbox, Messaging, BigText, BigPicture) | ❌ | ✅ | | Chronometer / Timer Display | ❌ | ✅ | | Colorized Notifications | ❌ | ✅ | | Audio Attribute (sound routing control) | ❌ | ✅ | | LED Lighting (colour + blink timing) | ❌ | ✅ | | Foreground Service (persistent background-work notification) | ❌ | ✅ |

Usage

• .Net MAUI

Android-Specific Features

| Guide | Description | |-------|-------------| | Notification Channels | Create and manage notification channels (API 26+) | | Notification Styles | Inbox, Messaging, Chronometer, Colorized, Audio Attributes, LED | | Notification Groups | Group related notifications under a summary | | Icon Customisation | Custom small and large notification icons | | Foreground Service | Persistent notification while background work is running |

Screen Record

<img src="https://raw.githubusercontent.com/thudugala/Plugin.LocalNotification/60c9342ba866b1af1278c273f3d41a168901e4ff/Screenshots/screenRecord.gif" alt="Screen Record" width="512px" >

Video

.Net MAUI

Xamarin.Forms (Support ended on May 1, 2024)

SourceLink Support

In Visual Studio, confirm that SourceLink is enabled. Also, turn off "Just My Code" since, well, this isn't your code.

https://docs.microsoft.com/en-us/dotnet/standard/library-guidance/sourcelink

Limitations

Only support <b>iOS</b> and <b>Android</b> for the moment.

Contributing

Contributions are welcome. Feel free to file issues and pull requests on the repo and they'll be reviewed as time permits.

Thank you

• Thank you for the Icons by DinosoftLabs and Iconic Hub
• Thank you for the sound file by Notification sounds
• Thank you for the tutorial video by Gerald Versluis