|
1 | | -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). |
| 1 | +# UWP Notifications |
| 2 | + |
| 3 | +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`). |
2 | 4 |
|
3 | 5 | ## Where should I add new code? |
4 | | -Any code for generating notifications should be written in the Microsoft.Toolkit.Uwp.Notifications project. |
| 6 | + |
| 7 | +Any code for generating notifications should be written in the `Microsoft.Toolkit.Uwp.Notifications` project. |
5 | 8 |
|
6 | 9 | If there's UWP-specific code, use the appropriate `#ifdef`, `WINDOWS_UWP` or `WINRT`. |
7 | 10 |
|
8 | 11 | ## What are all the projects for? |
9 | | -All the code is contained on the Microsoft.Toolkit.Uwp.Notifications project. |
10 | | - |
11 | | -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++. |
12 | 12 |
|
| 13 | +All the code is contained on the `Microsoft.Toolkit.Uwp.Notifications` project. |
13 | 14 |
|
14 | | -| C# | C++ | |
15 | | -| ---------------- | ------------------- | |
16 | | -| NET Standard 1.4 | UWP WinRT Component | |
17 | | -| UWP C# DLL | | |
18 | | -| .Net Core DLL | | |
19 | | - |
| 15 | +It outputs `netstandard1.4`, `uap10.0`, `native` for WinRT, and `netcoreapp3.1` for .NET Core projects. The UWP library is only for C#, while the WinRT library is a Windows Runtime Component for C++. |
20 | 16 |
|
| 17 | +| C# | C++ | |
| 18 | +| --------------------- | ------------------- | |
| 19 | +| .NET Standard Library | UWP WinRT Component | |
| 20 | +| .NET Core Library | | |
| 21 | +| UWP C# Library | | |
21 | 22 |
|
22 | 23 | ## Scenarios we want to support |
23 | 24 |
|
24 | | -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. |
| 25 | +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 .NET Standard DLL. Your UWP project will receive the UWP DLL. |
25 | 26 |
|
26 | 27 | ## How are the test projects organized? |
27 | 28 |
|
28 | | -If you look in the UnitTests folder of the repo, you'll notice that there's three projects... |
29 | | - - UnitTests.Notifications.Shared |
30 | | - - UnitTests.Notifications.NetCore |
31 | | - - UnitTests.Notifications.UWP |
32 | | - - UnitTests.Notifications.WinRT |
| 29 | +If you look in the `UnitTests` folder of the repo, you'll notice that there are three projects... |
| 30 | + |
| 31 | +- `UnitTests.Notifications.Shared` |
| 32 | +- `UnitTests.Notifications.NetCore` |
| 33 | +- `UnitTests.Notifications.UWP` |
| 34 | +- `UnitTests.Notifications.WinRT` |
33 | 35 |
|
34 | | -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. |
| 36 | +That's because in our source code, we have some `#ifdef` for switching between the different types of reflection that C# uses, since it's different between a .NET Standard and WinRT code. |
35 | 37 |
|
36 | | -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. |
| 38 | +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. |
0 commit comments