Introduce Register Overload for assets

dev/AppNotifications/AppNotificationManager.cpp

@@ -168,9 +168,9 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
         {
             THROW_HR_IF_MSG(E_ILLEGAL_METHOD_CALL, AppModel::Identity::IsPackagedProcess(), "Not applicable for packaged applications");
 
-            THROW_HR_IF(E_INVALIDARG, (displayName == winrt::hstring{}) || (iconUri == nullptr));
+            THROW_HR_IF(E_INVALIDARG, displayName.empty() || (iconUri == nullptr));
 
-            AppNotificationAssets assets{ GetAssets(displayName.c_str(), iconUri.RawUri().c_str()) };
+            AppNotificationAssets assets{ ValidateAssets(displayName, iconUri.RawUri().c_str()) };
 
             {
                 auto lock{ m_lock.lock_exclusive() };

dev/AppNotifications/AppNotificationUtility.cpp

@@ -286,13 +286,13 @@ AppNotificationAssets Microsoft::Windows::AppNotifications::Helpers::GetAssets()
     return assets;
 }
 
-AppNotificationAssets Microsoft::Windows::AppNotifications::Helpers::GetAssets(std::wstring displayName,std::wstring iconFilePath)
+AppNotificationAssets Microsoft::Windows::AppNotifications::Helpers::ValidateAssets(winrt::hstring const& displayName, std::filesystem::path const& iconFilePath)
 {
     winrt::check_bool(std::filesystem::exists(iconFilePath));
 
-    THROW_HR_IF_MSG(E_INVALIDARG, !IsIconFileExtensionSupported(std::filesystem::path{ iconFilePath }), "Icon format not supported");
+    THROW_HR_IF_MSG(E_INVALIDARG, !IsIconFileExtensionSupported(iconFilePath), "Icon format not supported");
 
-    return AppNotificationAssets{ std::move(displayName), std::move(iconFilePath) };
+    return AppNotificationAssets{ displayName.c_str(), iconFilePath.wstring() };
 }
 
 void Microsoft::Windows::AppNotifications::Helpers::RegisterAssets(std::wstring const& appId, std::wstring const& clsid, AppNotificationAssets const& assets)

dev/AppNotifications/AppNotificationUtility.h

@@ -66,5 +66,5 @@ namespace Microsoft::Windows::AppNotifications::Helpers
 
     Microsoft::Windows::AppNotifications::ShellLocalization::AppNotificationAssets GetAssets();
 
-    Microsoft::Windows::AppNotifications::ShellLocalization::AppNotificationAssets GetAssets(std::wstring displayName, std::wstring iconFilePath);
+    Microsoft::Windows::AppNotifications::ShellLocalization::AppNotificationAssets ValidateAssets(winrt::hstring const& displayName, std::filesystem::path const& iconFilePath);
 }

dev/AppNotifications/AppNotifications.idl

@@ -4,7 +4,7 @@ import "..\AppLifecycle\AppLifecycle.idl";
 
 namespace Microsoft.Windows.AppNotifications
 {
-    [contractversion(1)]
+    [contractversion(2)]
     apicontract AppNotificationsContract {}
 
     // Event args for the Notification Activation
@@ -123,7 +123,8 @@ namespace Microsoft.Windows.AppNotifications
         // For Unpackaged apps, the caller process will be registered as the COM server. And assets like displayname and icon will be gleaned from Shell and registered as well.
         void Register();
 
-        // For Unpackaged apps only, the caller process will be registered as the COM server.
+        // Unpackaged Apps can call this API to register custom displayname and icon for AppNotifications and register themselves as a COM server.
+        [contract(AppNotificationsContract, 2)]
         void Register(String displayName, Windows.Foundation.Uri iconUri);
 
         // Unregisters the COM Service so that a subsequent activation will launch a new process

dev/AppNotifications/ShellLocalization.cpp

@@ -259,7 +259,7 @@ HRESULT Microsoft::Windows::AppNotifications::ShellLocalization::DeleteIconFromC
     std::path iconFilePath{ RetrieveLocalFolderPath() / (notificationAppId + c_pngExtension) };
 
     // If DeleteFile returned FALSE, then deletion failed and we should return the corresponding error code.
-    winrt::check_bool(DeleteFileW(iconFilePath.c_str()) != FALSE);
+    RETURN_IF_WIN32_BOOL_FALSE(DeleteFileW(iconFilePath.c_str()));
 
     return S_OK;
 }

specs/AppNotifications/AppNotifications-spec.md

@@ -139,6 +139,31 @@ int main()
 }
 ```
 
+## Registering for App Notifications using assets
+
+For Unpackaged applications, the developer can Register using a custom Display Name and Icon.
+WinAppSDK will register the application and display these assets when an App Notification is received.
+The developer should provide both the assets or not provide them at all. Icon provided by the developer
+should be a valid supported format. The API supports the formats - png, bmp, jpg. The icon
+should reside on the local machine only otherwise the API throws an exception. For Packaged applications,
+this API is not applicable and will throw an exception.
+
+```cpp
+int main()
+{
+    auto manager = winrt::AppNotificationManager::Default();
+
+    std::wstring iconFilepath{ std::filesystem::current_path() / "icon.ico" };
+    manager.Register(L"AppNotifications", winrt::Windows::Foundation::Uri {iconFilepath});
+
+    // other app init and then message loop here
+
+    // Call Unregister() before exiting main so that subsequent invocations will launch a new process
+    manager.Unregister();
+    return 0;
+}
+```
+
 ## Displaying an App Notification
 
 To display a Notification, an app needs to define a payload in xml. In the example below, the
@@ -451,6 +476,9 @@ namespace Microsoft.Windows.AppNotifications
         // For Unpackaged apps, the caller process will be registered as the COM server. And assets like displayname and icon will be gleaned from Shell and registered as well.
         void Register();
 
+         // For Unpackaged apps only, the caller process will be registered as the COM server.
+        void Register(String displayName, Windows.Foundation.Uri iconUri);
+
         // Unregisters the COM Service so that a subsequent activation will launch a new process
         void Unregister();
 

test/TestApps/ToastNotificationsTestApp/main.cpp

@@ -26,6 +26,7 @@ namespace winrt
 const std::wstring c_localWindowsAppSDKFolder{ LR"(\Microsoft\WindowsAppSDK\)" };
 const std::wstring c_pngExtension{ LR"(.png)" };
 const std::wstring c_appUserModelId{ LR"(TaefTestAppId)" };
+const std::wstring c_iconFilepath{ std::filesystem::current_path() / "icon1.ico" };
 
 bool BackgroundActivationTest() // Activating application for background test.
 {
@@ -1328,10 +1329,7 @@ bool VerifyRegisterWithNullDisplayNameFail_Unpackaged()
     winrt::AppNotificationManager::Default().UnregisterAll();
     try
     {
-        winrt::AppNotificationManager::Default().Register(winrt::hstring{}, winrt::Uri{ LR"(C:\Windows\System32\WindowsSecurityIcon.png)" });
-
-
-        winrt::AppNotificationManager::Default().UnregisterAll();
+        winrt::AppNotificationManager::Default().Register(winrt::hstring{}, winrt::Uri{ c_iconFilepath });
     }
     catch (...)
     {
@@ -1348,8 +1346,6 @@ bool VerifyRegisterWithNullIconFail_Unpackaged()
     try
     {
         winrt::AppNotificationManager::Default().Register(L"AppNotificationApp", nullptr);
-
-        winrt::AppNotificationManager::Default().UnregisterAll();
     }
     catch (...)
     {
@@ -1366,9 +1362,6 @@ bool VerifyRegisterWithNullDisplayNameAndNullIconFail_Unpackaged()
     try
     {
         winrt::AppNotificationManager::Default().Register(winrt::hstring{}, nullptr);
-
-
-        winrt::AppNotificationManager::Default().UnregisterAll();
     }
     catch (...)
     {
@@ -1378,15 +1371,15 @@ bool VerifyRegisterWithNullDisplayNameAndNullIconFail_Unpackaged()
     return true;
 }
 
-bool VerifyRegisterWithDisplayNameAndIcon_Unpackaged()
+bool VerifyShowToastWithCustomDisplayNameAndIcon_Unpackaged()
 {
     // Register is already called in main with an explicit appusermodelId
     winrt::AppNotificationManager::Default().UnregisterAll();
     try
     {
-        winrt::AppNotificationManager::Default().Register(L"AppNotificationApp", winrt::Uri{ LR"(C:\Windows\System32\WindowsSecurityIcon.png)" });
+          winrt::AppNotificationManager::Default().Register(L"AppNotificationApp", winrt::Uri{ c_iconFilepath });
 
-        winrt::AppNotificationManager::Default().UnregisterAll();
+          winrt::check_bool(VerifyShowToast_Unpackaged());
     }
     catch (...)
     {
@@ -1403,8 +1396,6 @@ bool VerifyRegisterWithDisplayNameAndInvalidIconPathFail_Unpackaged()
     try
     {
         winrt::AppNotificationManager::Default().Register(L"AppNotificationApp", winrt::Uri{ LR"(C:\InvalidPath\)" });
-
-        winrt::AppNotificationManager::Default().UnregisterAll();
     }
     catch (...)
     {
@@ -1421,9 +1412,7 @@ bool VerifyRegisterWithEmptyDisplayNameFail_Unpackaged()
     try
     {
         // hstring treats L"" as assigning nullptr
-        winrt::AppNotificationManager::Default().Register(L"", winrt::Uri{ LR"(C:\Windows\System32\WindowsSecurityIcon.png)" });
-
-        winrt::AppNotificationManager::Default().UnregisterAll();
+        winrt::AppNotificationManager::Default().Register(L"", winrt::Uri{ c_iconFilepath });
     }
     catch (...)
     {
@@ -1433,51 +1422,14 @@ bool VerifyRegisterWithEmptyDisplayNameFail_Unpackaged()
     return false;
 }
 
-bool VerifyRegisterWithEmptyIconFail_Unpackaged()
-{
-    // Register is already called in main with an explicit appusermodelId
-    winrt::AppNotificationManager::Default().UnregisterAll();
-    try
-    {
-        winrt::AppNotificationManager::Default().Register(L"AppNotificationApp", winrt::Uri{ L"" });
-
-        winrt::AppNotificationManager::Default().UnregisterAll();
-    }
-    catch (...)
-    {
-        return winrt::to_hresult() == E_POINTER;
-    }
-
-    return false;
-}
-
-bool VerifyRegisterWithEmptyDisplayNameAndEmptyIconFail_Unpackaged()
-{
-    // Register is already called in main with an explicit appusermodelId
-    winrt::AppNotificationManager::Default().UnregisterAll();
-    try
-    {
-        winrt::AppNotificationManager::Default().Register(L"", winrt::Uri{ L"" });
-
-        winrt::AppNotificationManager::Default().UnregisterAll();
-    }
-    catch (...)
-    {
-        return winrt::to_hresult() == E_POINTER;
-    }
-
-    return false;
-}
-
 bool VerifyRegisterWithAssetsFail()
 {
     // Register is already called in main with an explicit appusermodelId
     winrt::AppNotificationManager::Default().UnregisterAll();
     try
     {
+        // API fails for Packaged Scenario
         winrt::AppNotificationManager::Default().Register(L"AppNotificationApp", winrt::Uri{ LR"(C:\InvalidPath\)" });
-
-        winrt::AppNotificationManager::Default().UnregisterAll();
     }
     catch (...)
     {
@@ -1549,11 +1501,9 @@ std::map<std::string, bool(*)()> const& GetSwitchMapping()
         { "VerifyRegisterWithNullDisplayNameFail_Unpackaged", &VerifyRegisterWithNullDisplayNameFail_Unpackaged},
         { "VerifyRegisterWithNullIconFail_Unpackaged", &VerifyRegisterWithNullIconFail_Unpackaged},
         { "VerifyRegisterWithNullDisplayNameAndNullIconFail_Unpackaged", &VerifyRegisterWithNullDisplayNameAndNullIconFail_Unpackaged},
-        { "VerifyRegisterWithDisplayNameAndIcon_Unpackaged", &VerifyRegisterWithDisplayNameAndIcon_Unpackaged},
+        { "VerifyShowToastWithCustomDisplayNameAndIcon_Unpackaged", &VerifyShowToastWithCustomDisplayNameAndIcon_Unpackaged},
         { "VerifyRegisterWithDisplayNameAndInvalidIconPathFail_Unpackaged", &VerifyRegisterWithDisplayNameAndInvalidIconPathFail_Unpackaged},
         { "VerifyRegisterWithEmptyDisplayNameFail_Unpackaged", &VerifyRegisterWithEmptyDisplayNameFail_Unpackaged},
-        { "VerifyRegisterWithEmptyIconFail_Unpackaged", &VerifyRegisterWithEmptyIconFail_Unpackaged},
-        { "VerifyRegisterWithEmptyDisplayNameAndEmptyIconFail_Unpackaged", &VerifyRegisterWithEmptyDisplayNameAndEmptyIconFail_Unpackaged},
         { "VerifyRegisterWithAssetsFail", &VerifyRegisterWithAssetsFail},
       };
 

test/ToastNotificationTests/APITests.cpp

@@ -599,9 +599,9 @@ namespace Test::ToastNotifications
             RunTestUnpackaged(L"VerifyRegisterWithNullDisplayNameAndNullIconFail_Unpackaged", testWaitTime());
         }
 
-        TEST_METHOD(VerifyRegisterWithDisplayNameAndIcon_Unpackaged)
+        TEST_METHOD(VerifyShowToastWithCustomDisplayNameAndIcon_Unpackaged)
         {
-            RunTestUnpackaged(L"VerifyRegisterWithDisplayNameAndIcon_Unpackaged", testWaitTime());
+            RunTestUnpackaged(L"VerifyShowToastWithCustomDisplayNameAndIcon_Unpackaged", testWaitTime());
         }
 
         TEST_METHOD(VerifyRegisterWithDisplayNameAndInvalidIconPathFail_Unpackaged)
@@ -614,16 +614,6 @@ namespace Test::ToastNotifications
             RunTestUnpackaged(L"VerifyRegisterWithEmptyDisplayNameFail_Unpackaged", testWaitTime());
         }
 
-        TEST_METHOD(VerifyRegisterWithEmptyIconFail_Unpackaged)
-        {
-            RunTestUnpackaged(L"VerifyRegisterWithEmptyIconFail_Unpackaged", testWaitTime());
-        }
-
-        TEST_METHOD(VerifyRegisterWithEmptyDisplayNameAndEmptyIconFail_Unpackaged)
-        {
-            RunTestUnpackaged(L"VerifyRegisterWithEmptyDisplayNameAndEmptyIconFail_Unpackaged", testWaitTime());
-        }
-
         TEST_METHOD(VerifyRegisterWithAssetsFail)
         {
             RunTest(L"VerifyRegisterWithAssetsFail", testWaitTime());