2.0.7 Documentation

• Please go to 2.0.7 Documentation, if you are referencing a version below 3.0.0.
• Version 3.* has breaking changes if upgrading from version 2.*

Plugin.LocalNotification

The local notification plugin provides a way to show local notifications from Xamarin.Forms apps.

Setup

• Plugin.LocalNotification Available on NuGet: https://www.nuget.org/packages/Plugin.LocalNotification
• Install into your platform-specific projects (iOS/Android), and any .NET Standard 2.0 projects required for your app.

Platform Support

Platform	Supported	Version	Notes
Xamarin.iOS	Yes	iOS 10+
Xamarin.Android	Yes	API 21+	Project should target Android framework 9.0+

Usage

Show local notification

var notification = new NotificationRequest
{
    NotificationId = 100,
    Title = "Test",
    Description = "Test Description",
    ReturningData = "Dummy data", // Returning data when tapped on notification.
    NotifyTime = DateTime.Now.AddSeconds(30) // Used for Scheduling local notification, if not specified notification will show immediately.
};
NotificationCenter.Current.Show(notification);

Cancel a local notification

NotificationCenter.Current.Cancel(100);

Receive local notification tap event

public partial class App : Application
{
	public App()
	{
		InitializeComponent();

		// Local Notification tap event listener
		NotificationCenter.Current.NotificationTapped += OnLocalNotificationTapped;

		MainPage = new MainPage();
	}
	
	private void OnLocalNotificationTapped(LocalNotificationTappedEvent e)
    	{
		// your code goes here
	}
}

Platform Specific Notes

Android

Notification Icon must be set for notification to appear.

You can set the notification Icon by setting the following property from inside your Android project:

NotificationCenter.NotificationIconId = Resource.Drawable.YOU_ICON_HERE

Scheduled local notifications will persist after device reboot, if permission is set and SDK more than 5.0 Lollipop (API 21)

<uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />

Setup

To receive Local Notification tap event. Include the following code in the OnNewIntent() method of MainActivity:

public class MainActivity : global::Xamarin.Forms.Platform.Android.FormsAppCompatActivity
{
	protected override void OnCreate(Bundle savedInstanceState)
	{
		.....	
		NotificationCenter.NotifyNotificationTapped(Intent);
	}

	protected override void OnNewIntent(Intent intent)
	{
		NotificationCenter.NotifyNotificationTapped(intent);
		base.OnNewIntent(intent);
	}
}

iOS

Setup

You must get permission from the user to allow the app to show local notifications. Also, To receive Local Notification tap event. Include the following code in the FinishedLaunching() method of AppDelegate:

public partial class AppDelegate : global::Xamarin.Forms.Platform.iOS.FormsApplicationDelegate
{        
	public override void WillEnterForeground(UIApplication uiApplication)
        {
            Plugin.LocalNotification.NotificationCenter.ResetApplicationIconBadgeNumber(uiApplication);
        }
}

Screen Record

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 iOS and Android 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.

Icon

Thank you for the Icon by DinosoftLabs (https://www.iconfinder.com/dinosoftlabs)