WindowsCommunityToolkit/Microsoft.Toolkit.Uwp.Notif...
Sergio Pedri ba85e32275 Remove file-scoped namespaces to fix CI issues
Also fix a non matching filename
2022-05-25 23:28:08 +02:00
..
Adaptive Remove leftover attributes 2022-05-25 23:28:08 +02:00
Badges Clean-up trailing white-spaces 2021-05-17 12:43:06 -07:00
Common Remove file-scoped namespaces to fix CI issues 2022-05-25 23:28:08 +02:00
Tiles Remove leftover attributes 2022-05-25 23:28:08 +02:00
Toasts Remove leftover attributes 2022-05-25 23:28:08 +02:00
Microsoft.Toolkit.Uwp.Notifications.csproj Remove .rd.xml file (as it's no longer needed) 2022-05-25 23:28:08 +02:00
Microsoft.Toolkit.Uwp.Notifications.nuspec Rename Package Icon file only when packing 2021-07-20 21:45:22 +05:30
Microsoft.Toolkit.Uwp.Notifications.targets Remove redundant xml meta-tag 2021-05-17 12:43:06 -07:00
ReadMe.md Convert Design projects to Sdk-style 2021-09-01 06:43:35 +05:30

ReadMe.md

Welcome to the Notifications section of the toolkit! This contains the Notifications library, including the object model for tile, toast, and badge XML (previously called NotificationsExtensions).

Where should I add new code?

Any code for generating notifications should be written in the Microsoft.Toolkit.Uwp.Notifications project.

If there's UWP-specific code, use the appropriate #ifdef, WINDOWS_UWP or WINRT.

What are all the projects for?

All the code is contained on the Microsoft.Toolkit.Uwp.Notifications project.

It outputs netstandard1.4, uap10.0, native for WinRT, and netcoreapp for .Net Core projects. The UWP library is only for C#, while the WinRT library is a Windows Runtime Component for C++.

C# C++
NET Standard 1.4 UWP WinRT Component
UWP C# DLL
.Net Core DLL

Scenarios we want to support

Imagine you add this library to a .NET Standard class library, and you also add it to your UWP app. In this case, your .NET Standard class library will receive the NETStandard dll. Your UWP project will receive the UWP dll.

How are the test projects organized?

If you look in the UnitTests folder of the repo, you'll notice that there's three projects...

  • UnitTests.Notifications.Shared
  • UnitTests.Notifications.NetCore
  • UnitTests.Notifications.UWP
  • UnitTests.Notifications.WinRT

That's because in our source code, we have some #IF defs for switching between the different types of reflection that C# uses, since it's different between a .NET Standard and WinRT code.

Therefore, there are two different code paths, one path for NETFX_CORE, and another for when that isn't present. The two test projects exercise both code paths.