Sample: App Notifications C++ WinUI Unpackaged (#177)

* Initial empty sample

* Naming the sample to better express intent and differenciate from other samples

* Removing unused scenario and properly naming the initial scenario

* show toast working with hand made package

* Moved initialization to windowsmain

* re-activating bootstrap

* Adding windows 10+ compat

* Applying learnings from asklar

* Update the latest experimental package

* Updating with latest experiments

* Updating to latest SDK

* Set message according to design doc

* wip

* Trying independent scenarios

* Easier to get routing right with an extra scenario

* Retrieving input text from toast

* Moving init code to Onlaunch

* getting activation when not running

* Moving dialog boxes to their respective scenarios

* Adding launch debug support

* Adding a packaged project for testing only

* fixing icon issue

* wip

* Updating to preview1 rc1

* Code cleanup

* Couldn't find a better place to call Unregister()

* List app notification activation arguments

* Let's hack it for now

* Upon receiving a toast, navigate to the originator's page

* Route activation args to the right scenario

* Adding avatar image to toasts

* co-locationg code by scenarios

* Grouping duplicated code into helper functions

* good enough

* Removing old prototypes not intended to ship

* Sample depends on bug fixes in latest WInAppSDK package

* Adding link to ref docs

* better linking with the onecore libs

* Refactor to support detecting background activation early on

* Background experiment

* Updating to WAS preview2

* improve manage life time of registration

* A listview is better suited at storing notifications and keeping some form of history

* Visual improvments

* Adding toast user input to listview

* code cleanup

* Co-locating notification management code to same class

* Only util functions left are a better for for the App class

* generalize notification routing

* Creating readme

* file was a mistake

* Retrieving the activation args should really happen in onLaunch

* Removing dead code

* Use the actual action name instead of a made up one

* De-duplicating code

* Notes

* Ensure all files have a copyright message

* Hack not needed anymore as the SDK takes care of things now

* removing dead code

* Updating doc

* Updating SDK to Preview3

* Scenarios descriptions were flipped

* PR Feedback

* Code cleanup

* Doc update

* Doc update

* Group Notification code into same folder

* handle when user click background of a toast

* Bring app to foreground when a toast has been received

* Add launch arguments

Co-authored-by: Eric Langlois <[email protected]>

Author: loneursid

Samples/Notifications/App/CppUnpackagedAppNotifications/CppUnpackagedAppNotifications.sln

@@ -0,0 +1,43 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 17
+VisualStudioVersion = 17.1.32210.238
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "CppUnpackagedAppNotifications", "CppUnpackagedAppNotifications\CppUnpackagedAppNotifications.vcxproj", "{BA5623DE-515A-4D7E-9110-38D1641F5FE0}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|arm64 = Debug|arm64
+		Debug|x64 = Debug|x64
+		Debug|x86 = Debug|x86
+		Release|arm64 = Release|arm64
+		Release|x64 = Release|x64
+		Release|x86 = Release|x86
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{BA5623DE-515A-4D7E-9110-38D1641F5FE0}.Debug|arm64.ActiveCfg = Debug|arm64
+		{BA5623DE-515A-4D7E-9110-38D1641F5FE0}.Debug|arm64.Build.0 = Debug|arm64
+		{BA5623DE-515A-4D7E-9110-38D1641F5FE0}.Debug|arm64.Deploy.0 = Debug|arm64
+		{BA5623DE-515A-4D7E-9110-38D1641F5FE0}.Debug|x64.ActiveCfg = Debug|x64
+		{BA5623DE-515A-4D7E-9110-38D1641F5FE0}.Debug|x64.Build.0 = Debug|x64
+		{BA5623DE-515A-4D7E-9110-38D1641F5FE0}.Debug|x64.Deploy.0 = Debug|x64
+		{BA5623DE-515A-4D7E-9110-38D1641F5FE0}.Debug|x86.ActiveCfg = Debug|Win32
+		{BA5623DE-515A-4D7E-9110-38D1641F5FE0}.Debug|x86.Build.0 = Debug|Win32
+		{BA5623DE-515A-4D7E-9110-38D1641F5FE0}.Debug|x86.Deploy.0 = Debug|Win32
+		{BA5623DE-515A-4D7E-9110-38D1641F5FE0}.Release|arm64.ActiveCfg = Release|arm64
+		{BA5623DE-515A-4D7E-9110-38D1641F5FE0}.Release|arm64.Build.0 = Release|arm64
+		{BA5623DE-515A-4D7E-9110-38D1641F5FE0}.Release|arm64.Deploy.0 = Release|arm64
+		{BA5623DE-515A-4D7E-9110-38D1641F5FE0}.Release|x64.ActiveCfg = Release|x64
+		{BA5623DE-515A-4D7E-9110-38D1641F5FE0}.Release|x64.Build.0 = Release|x64
+		{BA5623DE-515A-4D7E-9110-38D1641F5FE0}.Release|x64.Deploy.0 = Release|x64
+		{BA5623DE-515A-4D7E-9110-38D1641F5FE0}.Release|x86.ActiveCfg = Release|Win32
+		{BA5623DE-515A-4D7E-9110-38D1641F5FE0}.Release|x86.Build.0 = Release|Win32
+		{BA5623DE-515A-4D7E-9110-38D1641F5FE0}.Release|x86.Deploy.0 = Release|Win32
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {5E99866A-9228-40FB-AC77-C637CA706017}
+	EndGlobalSection
+EndGlobal

Samples/Notifications/App/CppUnpackagedAppNotifications/CppUnpackagedAppNotifications/App.xaml

@@ -0,0 +1,21 @@
+<!-- Copyright (c) Microsoft Corporation.
+     Licensed under the MIT License. -->
+<Application
+    x:Class="CppUnpackagedAppNotifications.App"
+    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
+    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+    xmlns:local="using:CppUnpackagedAppNotifications">
+    
+    <Application.Resources>
+        <!-- Application-specific resources -->
+        <ResourceDictionary>
+            <ResourceDictionary.MergedDictionaries>
+                <!-- 
+                    Styles that define common aspects of the platform look and feel
+                    Required by Visual Studio project and item templates
+                 -->
+                <ResourceDictionary Source="ms-appx:///Styles.xaml"/>
+            </ResourceDictionary.MergedDictionaries>
+        </ResourceDictionary>
+    </Application.Resources>
+</Application>

Samples/Notifications/App/CppUnpackagedAppNotifications/CppUnpackagedAppNotifications/App.xaml.cpp

@@ -0,0 +1,101 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+#include "pch.h"
+#include "App.xaml.h"
+#include "MainWindow.xaml.h"
+#include "Notifications\NotificationManager.h"
+#include <wil/result.h>
+#include <Microsoft.UI.Xaml.Window.h>
+#include <winrt/Microsoft.Windows.AppLifecycle.h>
+#include <winrt/Microsoft.Windows.AppNotifications.h>
+
+namespace winrt
+{
+    using namespace Windows::Foundation;
+    using namespace Microsoft::UI::Xaml;
+    using namespace winrt::Microsoft::Windows::AppLifecycle;
+    using namespace winrt::Microsoft::Windows::AppNotifications;
+}
+
+// NotificationManager is responsible for registering and unregistering the Sample for App Notifications as well as
+// dispatching actionned notifications to the appropriate scenario.
+// Registration will happen when Init() is called and Unregistration will happen when this
+// instance variable goes out of scope, i.e.: when the App is terminated.
+static NotificationManager g_notificationManager;
+
+namespace winrt::CppUnpackagedAppNotifications::implementation
+{
+    static App* app{ nullptr };
+
+    App::App()
+    {
+        InitializeComponent();
+        app = this;
+
+#if defined _DEBUG && !defined DISABLE_XAML_GENERATED_BREAK_ON_UNHANDLED_EXCEPTION
+        UnhandledException([](winrt::IInspectable const&, winrt::UnhandledExceptionEventArgs const& e)
+            {
+                if (IsDebuggerPresent())
+                {
+                    auto errorMessage = e.Message();
+                    __debugbreak();
+                }
+            });
+#endif
+    }
+
+    void App::ToForeground()
+    {
+        assert(app != nullptr);
+
+        HWND hwnd;
+        auto WindowNative{ app->window.as<IWindowNative>() };
+        if (WindowNative != nullptr && WindowNative->get_WindowHandle(&hwnd) == S_OK)
+        {
+            SwitchToThisWindow(hwnd, TRUE);
+        }
+    }
+
+    std::wstring App::GetFullPathToExe()
+    {
+        TCHAR buffer[MAX_PATH] = { 0 };
+        GetModuleFileName(NULL, buffer, MAX_PATH);
+        std::wstring::size_type pos = std::wstring(buffer).find_last_of(L"\\/");
+        return std::wstring(buffer).substr(0, pos);
+    }
+
+    std::wstring App::GetFullPathToAsset(std::wstring const& assetName)
+    {
+        return GetFullPathToExe() + L"\\Assets\\" + assetName;
+    }
+
+    void App::OnLaunched(winrt::Microsoft::UI::Xaml::LaunchActivatedEventArgs const& /*args*/)
+    {
+        window = make<MainWindow>();
+
+        g_notificationManager.Init();
+
+        // NOTE: AppInstance is ambiguous between
+        // Microsoft.Windows.AppLifecycle.AppInstance and
+        // Windows.ApplicationModel.AppInstance
+        auto currentInstance{ winrt::AppInstance::GetCurrent() };
+        if (currentInstance)
+        {
+            // AppInstance.GetActivatedEventArgs will report the correct ActivationKind,
+            // even in WinUI's OnLaunched.
+            winrt::AppActivationArguments activationArgs{ currentInstance.GetActivatedEventArgs() };
+            if (activationArgs)
+            {
+                winrt::ExtendedActivationKind extendedKind{ activationArgs.Kind() };
+                if (extendedKind == winrt::Microsoft::Windows::AppLifecycle::ExtendedActivationKind::AppNotification)
+                {
+                    winrt::AppNotificationActivatedEventArgs notificationActivatedEventArgs{ activationArgs.Data().as<winrt::AppNotificationActivatedEventArgs>() };
+                    g_notificationManager.ProcessLaunchActivationArgs(notificationActivatedEventArgs);
+                }
+            }
+        }
+
+        window.Activate();
+    }
+}

Samples/Notifications/App/CppUnpackagedAppNotifications/CppUnpackagedAppNotifications/App.xaml.h

@@ -0,0 +1,23 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+#pragma once
+#include "App.xaml.g.h"
+#include "pch.h"
+
+namespace winrt::CppUnpackagedAppNotifications::implementation
+{
+    struct App : AppT<App>
+    {
+        App();
+
+        static std::wstring GetFullPathToExe();
+        static std::wstring GetFullPathToAsset(std::wstring const& assetName);
+        static void ToForeground();
+
+        void OnLaunched(Microsoft::UI::Xaml::LaunchActivatedEventArgs const&);
+
+    private:
+        Microsoft::UI::Xaml::Window window{ nullptr };
+    };
+}