Home

Plugin.LocalNotification

A comprehensive local notification plugin for .NET MAUI applications.

Overview

This plugin provides a simple and flexible way to implement local notifications in your .NET MAUI applications. It supports Android, iOS, MacCatalyst, and Windows platforms with features like scheduled notifications, custom sounds, notification actions, geofencing, and more.

Installation

The plugin is split into three NuGet packages:

• Plugin.LocalNotification — Main notification service (required)
• Plugin.LocalNotification.Core — Core types and interfaces (automatically referenced by the main package)
• Plugin.LocalNotification.Geofence — Optional geofence/location-based notification support (install separately if needed)

For .NET MAUI Applications

• Requires .NET 10
• Install Plugin.LocalNotification into your project
• Optionally install Plugin.LocalNotification.Geofence for location-based notifications

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

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

Features Matrix

Feature	iOS (≥ 15)	Android (≥ API 21)
Title	✅	✅
Description	✅	✅
Subtitle	✅	✅
Scheduled Notifications	✅	✅
Daily / Weekly / Monthly Repeat	✅	✅
Time Interval Repeat	✅	✅
Android Schedule Mode (Exact / Inexact / AlarmClock)	❌	✅
Custom Sounds	✅	✅
Images	✅	✅
Notification Actions	✅	✅
Inline Reply / Text Input Actions	✅	✅
iOS Category Options (AppleCategoryOptions)	✅	❌
Clear Delivered Notifications	✅	✅
Get Pending Notifications	✅	✅
Get Delivered Notifications	✅	✅
Location-Based Notifications (Geofence)	✅	✅
Notification Groups	✅	✅
Inbox Style Notifications	❌	✅
Messaging Style Notifications	❌	✅
Chronometer / Timer Display	❌	✅
Colorized Notifications	❌	✅
Audio Attribute (usage kind control)	❌	✅
LED Notification Lighting (colour + on/off timing)	❌	✅
Foreground Service (persistent background-work notification)	❌	✅

Documentation

Getting Started

1. .NET MAUI Usage Guide
2. Xamarin.Forms Usage Guide

Common Features

• Scheduled Notifications
• Repeat Notifications
• Notification Actions
• Location-Based Notifications (Geofence)
• Custom Sound

Platform-Specific Guides

• Android Notification Channels
• Android Notification Styles
• Android Foreground Service
• Android Notification Icon
• Android Notification Groups
• iOS Push Notifications

Advanced Topics

• Logging
• JSON Serializer Configuration
• Troubleshooting Guide
• Common Issues

Support

If you encounter any issues or have questions, please visit our GitHub Issues page.