Interfaces for "Enhanced UX Notification for Video and Audio Call Feature"

dev/AppNotifications/AppNotification.cpp

@@ -119,4 +119,16 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
         auto lock{ m_lock.lock_exclusive() };
         m_notificationId = id;
     }
+
+    winrt::Microsoft::Windows::AppNotifications::AppNotificationDevicesData AppNotification::DevicesData()
+    {
+        auto lock{ m_lock.lock_shared() };
+        return m_devicesData;
+    }
+
+    void AppNotification::DevicesData(winrt::Microsoft::Windows::AppNotifications::AppNotificationDevicesData const& devicesData)
+    {
+        auto lock{ m_lock.lock_exclusive() };
+        m_devicesData = devicesData;
+    }
 }

dev/AppNotifications/AppNotification.h

@@ -37,6 +37,9 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
         // IAppNotificationInternal
         void SetNotificationId(uint32_t id);
 
+        winrt::Microsoft::Windows::AppNotifications::AppNotificationDevicesData DevicesData();
+        void DevicesData(winrt::Microsoft::Windows::AppNotifications::AppNotificationDevicesData const& value);
+
     private:
         winrt::hstring m_tag{};
         winrt::hstring m_group{};
@@ -49,6 +52,8 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
         { winrt::Microsoft::Windows::AppNotifications::AppNotificationPriority::Default };
         bool m_suppressDisplay{ false };
         wil::srwlock m_lock;
+
+        winrt::Microsoft::Windows::AppNotifications::AppNotificationDevicesData m_devicesData{ nullptr };
     };
 }
 namespace winrt::Microsoft::Windows::AppNotifications::factory_implementation

dev/AppNotifications/AppNotificationDevicesData.cpp

@@ -0,0 +1,46 @@
+#include "pch.h"
+#include "AppNotificationDevicesData.h"
+#include "Microsoft.Windows.AppNotifications.AppNotificationDevicesData.g.cpp"
+#include <IsWindowsVersion.h>
+
+namespace winrt::Microsoft::Windows::AppNotifications::implementation
+{
+    hstring AppNotificationDevicesData::CameraDeviceId()
+    {
+        return m_cameraDeviceId;
+    }
+
+    void AppNotificationDevicesData::CameraDeviceId(hstring const& value)
+    {
+        m_cameraDeviceId = value;
+    }
+
+    hstring AppNotificationDevicesData::MicrophoneDeviceId()
+    {
+        return m_microphoneDeviceId;
+    }
+
+    void AppNotificationDevicesData::MicrophoneDeviceId(hstring const& value)
+    {
+        m_microphoneDeviceId = value;
+    }
+
+    hstring AppNotificationDevicesData::SpeakerDeviceId()
+    {
+        return m_speakerDeviceId;
+    }
+
+    void AppNotificationDevicesData::SpeakerDeviceId(hstring const& value)
+    {
+        m_speakerDeviceId = value;
+    }
+
+    /// <summary>
+    /// verifies if video calling is supported <TO DO>
+    /// </summary>
+    /// <returns>bool</returns>
+    bool AppNotificationDevicesData::IsVideoOrAudioCallingSupported()
+    {
+        return WindowsVersion::IsWindows11_23H1OrGreater(); // Windows 11 23H1 or greater
+    }
+}

dev/AppNotifications/AppNotificationDevicesData.h

@@ -0,0 +1,34 @@
+#pragma once
+#include "Microsoft.Windows.AppNotifications.AppNotificationDevicesData.g.h"
+
+namespace winrt::Microsoft::Windows::AppNotifications::implementation
+{
+    struct AppNotificationDevicesData : AppNotificationDevicesDataT<AppNotificationDevicesData>
+    {
+        AppNotificationDevicesData() = default;
+
+        // Getters
+        hstring CameraDeviceId();
+        hstring MicrophoneDeviceId();
+        hstring SpeakerDeviceId();
+
+        // Setters
+        void CameraDeviceId(hstring const& value);
+        void MicrophoneDeviceId(hstring const& value);
+        void SpeakerDeviceId(hstring const& value);
+
+        static bool IsVideoOrAudioCallingSupported();
+
+    private:
+
+        hstring m_cameraDeviceId{};
+        hstring m_microphoneDeviceId{};
+        hstring m_speakerDeviceId{};
+    };
+}
+namespace winrt::Microsoft::Windows::AppNotifications::factory_implementation
+{
+    struct AppNotificationDevicesData : AppNotificationDevicesDataT<AppNotificationDevicesData, implementation::AppNotificationDevicesData>
+    {
+    };
+}

dev/AppNotifications/AppNotifications.idl

@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation and Contributors.
+// Copyright (c) Microsoft Corporation and Contributors.
 // Licensed under the MIT License.
 import "..\AppLifecycle\AppLifecycle.idl";
 
@@ -111,6 +111,29 @@ namespace Microsoft.Windows.AppNotifications
 
         // Gets or sets whether a Notification's pop-up UI is displayed on the user's screen.
         Boolean SuppressDisplay;
+
+        // Gets or sets the Notification Device Data
+        AppNotificationDevicesData DevicesData;
+    }
+
+    // The Notification Device Data
+    [contract(AppNotificationsContract, 2)]
+    runtimeclass AppNotificationDevicesData
+    {
+        // Initializes a new Instance of NotificationDevicesData
+        AppNotificationDevicesData();
+
+        // Checks if Video or Audio Calling is supported
+        static Boolean IsVideoOrAudioCallingSupported();
+
+        // Gets or sets the Camera Device Id
+        String CameraDeviceId{ get; set; };
+
+        // Gets or sets the Microphone Device Id
+        String MicrophoneDeviceId{ get; set; };
+
+        // Gets or sets the Speaker Device Id
+        String SpeakerDeviceId{ get; set; };
     }
 
     // The manager class which encompasses all App Notification API Functionality

dev/AppNotifications/AppNotifications.vcxitems

@@ -24,6 +24,8 @@
     <ClInclude Include="$(MSBuildThisFileDirectory)NotificationTransientProperties.h" />
     <ClInclude Include="$(MSBuildThisFileDirectory)NotificationProgressData.h" />
     <ClInclude Include="$(MSBuildThisFileDirectory)ShellLocalization.h" />
+    <ClInclude Include="$(MSBuildThisFileDirectory)AppNotificationDevicesData.h" />
+    <ClInclude Include="$(MSBuildThisFileDirectory)NotificationDevicesData.h" />
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="$(MSBuildThisFileDirectory)AppNotificationActivatedEventArgs.cpp" />
@@ -35,6 +37,8 @@
     <ClCompile Include="$(MSBuildThisFileDirectory)NotificationTransientProperties.cpp" />
     <ClCompile Include="$(MSBuildThisFileDirectory)NotificationProgressData.cpp" />
     <ClCompile Include="$(MSBuildThisFileDirectory)ShellLocalization.cpp" />
+    <ClCompile Include="$(MSBuildThisFileDirectory)AppNotificationDevicesData.cpp" />
+    <ClCompile Include="$(MSBuildThisFileDirectory)NotificationDevicesData.cpp" />
   </ItemGroup>
   <ItemGroup>
     <Midl Include="$(MSBuildThisFileDirectory)AppNotifications.idl" />

dev/AppNotifications/NotificationDevicesData.cpp

@@ -0,0 +1,41 @@
+// Copyright (c) Microsoft Corporation and Contributors.
+// Licensed under the MIT License.
+
+#include "pch.h"
+
+#include "AppNotificationDevicesData.h"
+#include "NotificationDevicesData.h"
+#include "AppNotificationUtility.h"
+
+using namespace Microsoft::Windows::AppNotifications::Helpers;
+
+NotificationDevicesData::NotificationDevicesData(winrt::AppNotificationDevicesData const& devicesData)
+    : m_devicesData(devicesData)
+{
+}
+
+STDMETHODIMP NotificationDevicesData::get_CameraDeviceId(_Out_ HSTRING* value) noexcept try
+{
+    *value = safe_make_unique_hstring(m_devicesData.CameraDeviceId().c_str()).release();
+    return S_OK;
+}
+CATCH_RETURN()
+
+STDMETHODIMP NotificationDevicesData::get_MicrophoneDeviceId(_Out_ HSTRING* value) noexcept try
+{
+    *value = safe_make_unique_hstring(m_devicesData.MicrophoneDeviceId().c_str()).release();
+    return S_OK;
+}
+CATCH_RETURN() 
+
+
+STDMETHODIMP NotificationDevicesData::get_SpeakerDeviceId(_Out_ HSTRING* value) noexcept try
+{
+    *value = safe_make_unique_hstring(m_devicesData.SpeakerDeviceId().c_str()).release();
+    return S_OK;
+}
+CATCH_RETURN()
+
+
+
+

dev/AppNotifications/NotificationDevicesData.h

@@ -0,0 +1,31 @@
+// Copyright (c) Microsoft Corporation and Contributors.
+// Licensed under the MIT License.
+
+#pragma once
+
+#include <frameworkUdk/ToastNotificationsRT.h>
+
+namespace winrt
+{
+    using namespace winrt::Microsoft::Windows::AppNotifications;
+}
+
+namespace ToastABI
+{
+    using namespace ::ABI::Microsoft::Internal::ToastNotifications;
+}
+
+struct NotificationDevicesData : winrt::implements<NotificationDevicesData, ToastABI::IToastDevicesData>
+{
+    NotificationDevicesData(winrt::AppNotificationDevicesData const& devicesData);
+
+    STDMETHOD(get_CameraDeviceId)(_Out_ HSTRING* value) noexcept;
+
+    STDMETHOD(get_MicrophoneDeviceId)(_Out_ HSTRING* value) noexcept;
+
+    STDMETHOD(get_SpeakerDeviceId)(_Out_ HSTRING* value) noexcept;
+
+private:
+
+    winrt::AppNotificationDevicesData m_devicesData;
+};

dev/AppNotifications/NotificationProperties.cpp

@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation and Contributors.
+// Copyright (c) Microsoft Corporation and Contributors.
 // Licensed under the MIT License.
 
 #include "pch.h"
@@ -8,6 +8,8 @@
 #include "AppNotificationUtility.h"
 #include "../PushNotifications/PushNotificationUtility.h"
 #include "NotificationProgressData.h"
+#include "NotificationDevicesData.h"
+#include "AppNotificationDevicesData.h"
 
 namespace winrt
 {
@@ -47,6 +49,14 @@ NotificationProperties::NotificationProperties(winrt::AppNotification const& toa
     {
         m_toastProgressData = winrt::make_self<NotificationProgressData>(toastNotification.Progress());
     }
+
+    if (winrt::AppNotificationDevicesData::IsVideoOrAudioCallingSupported())
+    {
+        if (toastNotification.DevicesData() != nullptr)
+        {
+            m_toastDevicesData = winrt::make_self<NotificationDevicesData>(toastNotification.DevicesData());
+        }
+    }
 }
 
 STDMETHODIMP_(HRESULT __stdcall) NotificationProperties::get_NotificationId(_Out_ unsigned int* notificationId) noexcept
@@ -147,3 +157,15 @@ STDMETHODIMP_(HRESULT __stdcall) NotificationProperties::get_ActivityId(_Out_ GU
     *activityId = GUID_NULL;
     return S_OK;
 }
+
+STDMETHODIMP_(HRESULT __stdcall) NotificationProperties::get_ToastDevicesData(_Out_ ToastABI::IToastDevicesData** devicesData) noexcept
+{
+    *devicesData = nullptr;
+    auto lock{ m_lock.lock_shared() };
+    if (m_toastDevicesData != nullptr)
+    {
+        m_toastDevicesData.copy_to(devicesData);
+    }
+
+    return S_OK;
+}

dev/AppNotifications/NotificationProperties.h

@@ -1,11 +1,11 @@
-// Copyright (c) Microsoft Corporation and Contributors.
+// Copyright (c) Microsoft Corporation and Contributors.
 // Licensed under the MIT License.
 
 #pragma once
 
 #include <frameworkUdk/ToastNotificationsRT.h>
 
-struct NotificationProperties : winrt::implements<NotificationProperties, ::ABI::Microsoft::Internal::ToastNotifications::INotificationProperties>
+struct NotificationProperties : winrt::implements<NotificationProperties, ::ABI::Microsoft::Internal::ToastNotifications::INotificationProperties, ::ABI::Microsoft::Internal::ToastNotifications::INotificationProperties2>
 {
     NotificationProperties(winrt::Microsoft::Windows::AppNotifications::AppNotification const& toastNotification);
 
@@ -31,6 +31,8 @@ struct NotificationProperties : winrt::implements<NotificationProperties, ::ABI:
 
     STDMETHOD(get_ActivityId)(_Out_ GUID* activityId) noexcept;
 
+    STDMETHOD(get_ToastDevicesData)(_Out_ ABI::Microsoft::Internal::ToastNotifications::IToastDevicesData** devicesData) noexcept;
+
 private:
     wil::srwlock m_lock;
 
@@ -49,4 +51,5 @@ struct NotificationProperties : winrt::implements<NotificationProperties, ::ABI:
     bool m_expiresOnReboot = false;
 
     winrt::com_ptr<ABI::Microsoft::Internal::ToastNotifications::IToastProgressData> m_toastProgressData{ nullptr };
+    winrt::com_ptr<ABI::Microsoft::Internal::ToastNotifications::IToastDevicesData> m_toastDevicesData{ nullptr };
 };

test/AppNotificationTests/BaseTestSuite.cpp

@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
 #include "pch.h"
@@ -598,3 +598,42 @@ void BaseTestSuite::VerifyExplicitAppId()
     RegisterWithAppNotificationManager();
     AppNotificationManager::Default().Unregister();
 }
+
+void BaseTestSuite::VerifyToastDevicesDataAllDevicesSet()
+{
+    AppNotification toast{ CreateToastNotification() };
+
+    AppNotificationDevicesData devicesData{ nullptr };
+    devicesData.CameraDeviceId(L"CameraDeviceId");
+    devicesData.MicrophoneDeviceId(L"MicrophoneDeviceId");
+    devicesData.SpeakerDeviceId(L"SpeakerDeviceId");
+
+    toast.DevicesData(devicesData);
+
+    VERIFY_ARE_EQUAL(toast.DevicesData().CameraDeviceId(), L"CameraDeviceId");
+    VERIFY_ARE_EQUAL(toast.DevicesData().MicrophoneDeviceId(), L"MicrophoneDeviceId");
+    VERIFY_ARE_EQUAL(toast.DevicesData().SpeakerDeviceId(), L"SpeakerDeviceId");
+}
+
+void BaseTestSuite::VerifyToastDevicesDataNoDevicesSet()
+{
+    AppNotification toast{ CreateToastNotification() };
+
+    VERIFY_ARE_EQUAL(toast.DevicesData().CameraDeviceId(), L"");
+    VERIFY_ARE_EQUAL(toast.DevicesData().MicrophoneDeviceId(), L"");
+    VERIFY_ARE_EQUAL(toast.DevicesData().SpeakerDeviceId(), L"");
+}
+
+void BaseTestSuite::VerifyToastDevicesDataNotAllDevicesSet()
+{
+    AppNotification toast{ CreateToastNotification() };
+
+    AppNotificationDevicesData devicesData{ nullptr };
+    devicesData.CameraDeviceId(L"CameraDeviceId");
+
+    toast.DevicesData(devicesData);
+
+    VERIFY_ARE_EQUAL(toast.DevicesData().CameraDeviceId(), L"CameraDeviceId");
+    VERIFY_ARE_EQUAL(toast.DevicesData().MicrophoneDeviceId(), L"");
+    VERIFY_ARE_EQUAL(toast.DevicesData().SpeakerDeviceId(), L"");
+}

test/AppNotificationTests/BaseTestSuite.h

@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
 #include "pch.h"
@@ -54,6 +54,10 @@ class BaseTestSuite
         void VerifyToastProgressDataSequence0Fail();
         void VerifyIconPathExists();
         void VerifyExplicitAppId();
+        void VerifyToastDevicesDataAllDevicesSet();
+        void VerifyToastDevicesDataNotAllDevicesSet();
+        void VerifyToastDevicesDataNoDevicesSet();
+
     private:
         void RegisterWithAppNotificationManager();
         void UnregisterAllWithAppNotificationManager();