AppNotificationContent Builder Core Features - part II

dev/AppNotifications/AppNotificationBuilder/AppNotificationBuilder.cpp

@@ -17,6 +17,11 @@ using namespace winrt::Windows::Globalization::DateTimeFormatting;
 
 namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
 {
+    void AppNotificationBuilder::ThrowIfMaxInputItemsExceeded()
+    {
+        THROW_HR_IF_MSG(E_INVALIDARG, m_textBoxList.size() + m_comboBoxList.size() >= c_maxTextInputElements, "Maximum number of input elements added");
+    }
+
     bool AppNotificationBuilder::IsUrgentScenarioSupported()
     {
         return WindowsVersion::IsWindows10_20H1OrGreater();
@@ -195,6 +200,25 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
         return *this;
     }
 
+    winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationBuilder AppNotificationBuilder::AddTextBox(hstring id)
+    {
+        ThrowIfMaxInputItemsExceeded();
+        THROW_HR_IF_MSG(E_INVALIDARG, id.empty(), "You must provide an id for the TextBox");
+
+
+        m_textBoxList.push_back(wil::str_printf<std::wstring>(L"<input id='%ls' type='text'/>", id.c_str()));
+        return *this;
+    }
+
+    winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationBuilder AppNotificationBuilder::AddTextBox(hstring id, hstring placeHolderText, hstring title)
+    {
+        ThrowIfMaxInputItemsExceeded();
+        THROW_HR_IF_MSG(E_INVALIDARG, id.empty(), "You must provide an id for the TextBox");
+
+        m_textBoxList.push_back(wil::str_printf<std::wstring>(L"<input id='%ls' type='text' placeHolderContent='%ls' title='%ls'/>", id.c_str(), placeHolderText.c_str(), title.c_str()));
+        return *this;
+    }
+
     winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationBuilder AppNotificationBuilder::AddButton(AppNotificationButton const& value)
     {
         THROW_HR_IF_MSG(E_INVALIDARG, m_buttonList.size() >= c_maxButtonElements, "Maximum number of buttons added");
@@ -203,6 +227,15 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
         return *this;
     }
 
+    winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationBuilder AppNotificationBuilder::AddComboBox(AppNotificationComboBox const& value)
+    {
+        ThrowIfMaxInputItemsExceeded();
+
+        m_comboBoxList.push_back(value);
+
+        return *this;
+    }
+
     winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationBuilder AppNotificationBuilder::SetTag(hstring const& value)
     {
         m_tag = value;
@@ -281,30 +314,34 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
         return wil::str_printf<std::wstring>(L"%ls%ls%ls", m_inlineImage.c_str(), m_heroImage.c_str(), m_appLogoOverride.c_str());
     }
 
-    std::wstring AppNotificationBuilder::GetButtons()
+    std::wstring AppNotificationBuilder::GetActions()
     {
-        if (m_buttonList.size())
-        {
-            std::wstring result{};
-            for (auto input : m_buttonList)
-            {
-                if (input.ButtonStyle() != AppNotificationButtonStyle::Default)
-                {
-                    m_useButtonStyle = true;
-                }
 
-                result.append(input.as<winrt::Windows::Foundation::IStringable>().ToString().c_str());
-            }
+        std::wstring result{};
+        for (auto input : m_textBoxList)
+        {
+            result.append(input.c_str());
+        }
 
-            return wil::str_printf<std::wstring>(L"<actions>%ls</actions>", result.c_str());
+        for (auto input : m_comboBoxList)
+        {
+            result.append(input.as<winrt::Windows::Foundation::IStringable>().ToString().c_str());
         }
-        else
+
+        for (auto input : m_buttonList)
         {
-            return {};
+            if (input.ButtonStyle() != AppNotificationButtonStyle::Default)
+            {
+                m_useButtonStyle = true;
+            }
+
+            result.append(input.as<winrt::Windows::Foundation::IStringable>().ToString().c_str());
         }
+
+        return (result.empty()) ? result : wil::str_printf<std::wstring>(L"<actions>%ls</actions>", result.c_str());
     }
 
-    // You must call GetButtons first to retrieve this value.
+    // You must call GetActions first to retrieve this value.
     std::wstring AppNotificationBuilder::GetButtonStyle()
     {
         return m_useButtonStyle ? L" useButtonStyle='true'" : L"";
@@ -316,7 +353,7 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
         xmlResult.reserve(c_maxAppNotificationPayload);
 
         // Build the button string and fill m_useButtonStyle
-        std::wstring buttons{ GetButtons() };
+        std::wstring actions{ GetActions() };
 
         xmlResult.append(L"<toast");
         xmlResult.append(m_timeStamp);
@@ -330,7 +367,7 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
         xmlResult.append(GetImages());
         xmlResult.append(L"</binding></visual>");
         xmlResult.append(m_audio.c_str());
-        xmlResult.append(buttons);
+        xmlResult.append(actions);
         xmlResult.append(L"</toast>");
 
         winrt::Microsoft::Windows::AppNotifications::AppNotification appNotification{ xmlResult };

dev/AppNotifications/AppNotificationBuilder/AppNotificationBuilder.h

@@ -48,9 +48,14 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
 
         winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationBuilder MuteAudio();
 
+        winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationBuilder AddTextBox(hstring id);
+        winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationBuilder AddTextBox(hstring id, hstring placeHolderText, hstring title);
+
         // Adds a button to the AppNotificationBuilder
         winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationBuilder AddButton(AppNotificationButton const& value);
 
+        winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationBuilder AddComboBox(AppNotificationComboBox const& value);
+
         winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationBuilder SetTag(winrt::hstring const& value);
         winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationBuilder SetGroup(winrt::hstring const& value);
 
@@ -59,13 +64,14 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
         static bool IsUrgentScenarioSupported();
 
     private:
+        void ThrowIfMaxInputItemsExceeded();
         std::wstring GetDuration();
         std::wstring GetScenario();
         std::wstring GetArguments();
         std::wstring GetButtonStyle();
         std::wstring GetText();
         std::wstring GetImages();
-        std::wstring GetButtons();
+        std::wstring GetActions();
 
         std::wstring m_timeStamp{};
         AppNotificationDuration m_duration{ AppNotificationDuration::Default };
@@ -79,6 +85,8 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
         winrt::hstring m_audio{};
         winrt::Windows::Foundation::Collections::IMap<winrt::hstring, winrt::hstring> m_arguments{ winrt::single_threaded_map<winrt::hstring, winrt::hstring>() };
         std::vector<AppNotificationButton> m_buttonList{};
+        std::vector<std::wstring> m_textBoxList{};
+        std::vector<AppNotificationComboBox> m_comboBoxList{};
         winrt::hstring m_tag{};
         winrt::hstring m_group{};
     };

dev/AppNotifications/AppNotificationBuilder/AppNotificationBuilder.idl

@@ -65,6 +65,24 @@ namespace Microsoft.Windows.AppNotifications.Builder
         AppNotificationButton SetInvokeUri(Windows.Foundation.Uri protocolUri, String targetAppId);
     };
 
+    runtimeclass AppNotificationComboBox
+    {
+        AppNotificationComboBox(String id);
+
+        Windows.Foundation.Collections.IMap<String, String> Items;
+        String Title;
+        String SelectedItem;
+
+        // Add a selection to the AppNotificationComboBox. The id parameter identifies the item the user selected.
+        AppNotificationComboBox AddItem(String id, String content);
+
+        // Adds a title to display on top
+        AppNotificationComboBox SetTitle(String value);
+
+        // Sets the default selection to be displayed by the AppNotificationComboBox
+        AppNotificationComboBox SetSelectedItem(String id);
+    };
+
     enum AppNotificationSoundEvent
     {
         Default,
@@ -167,9 +185,14 @@ namespace Microsoft.Windows.AppNotifications.Builder
 
         AppNotificationBuilder MuteAudio();
 
+        AppNotificationBuilder AddTextBox(String id);
+        AppNotificationBuilder AddTextBox(String id, String placeHolderText, String title);
+
         // Adds a button to the AppNotificationBuilder
         AppNotificationBuilder AddButton(AppNotificationButton value);
 
+        AppNotificationBuilder AddComboBox(AppNotificationComboBox value);
+
         // Constructs a WindowsAppSDK AppNotification object with the XML payload
         Microsoft.Windows.AppNotifications.AppNotification BuildNotification();
 

dev/AppNotifications/AppNotificationBuilder/AppNotificationBuilder.vcxitems

@@ -19,12 +19,14 @@
   <ItemGroup>
     <ClCompile Include="$(MSBuildThisFileDirectory)AppNotificationBuilder.cpp" />
     <ClCompile Include="$(MSBuildThisFileDirectory)AppNotificationButton.cpp" />
+    <ClCompile Include="$(MSBuildThisFileDirectory)AppNotificationComboBox.cpp" />
     <ClCompile Include="$(MSBuildThisFileDirectory)AppNotificationTextProperties.cpp" />
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="$(MSBuildThisFileDirectory)AppNotificationBuilder.h" />
     <ClInclude Include="$(MSBuildThisFileDirectory)AppNotificationBuilderUtility.h" />
     <ClInclude Include="$(MSBuildThisFileDirectory)AppNotificationButton.h" />
+    <ClInclude Include="$(MSBuildThisFileDirectory)AppNotificationComboBox.h" />
     <ClInclude Include="$(MSBuildThisFileDirectory)AppNotificationTextProperties.h" />
   </ItemGroup>
 </Project>

dev/AppNotifications/AppNotificationBuilder/AppNotificationBuilderUtility.h

@@ -8,6 +8,8 @@
 constexpr size_t c_maxAppNotificationPayload{ 5120 };
 constexpr uint8_t c_maxTextElements{ 3 };
 constexpr uint8_t c_maxButtonElements{ 5 };
+constexpr uint8_t c_maxTextInputElements{ 5 };
+constexpr uint8_t c_maxSelectionElements{ 5 };
 
 namespace AppNotificationBuilder
 {

dev/AppNotifications/AppNotificationBuilder/AppNotificationComboBox.cpp

@@ -0,0 +1,64 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+#include "pch.h"
+#include "AppNotificationComboBox.h"
+#include "Microsoft.Windows.AppNotifications.Builder.AppNotificationComboBox.g.cpp"
+#include "AppNotificationBuilderUtility.h"
+
+namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
+{
+    AppNotificationComboBox::AppNotificationComboBox(hstring const& id) : m_id(id)
+    {
+        THROW_HR_IF_MSG(E_INVALIDARG, id.empty(), "You must provide an id for the ComboBox");
+    };
+
+    winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationComboBox AppNotificationComboBox::AddItem(winrt::hstring const& id, winrt::hstring const& content)
+    {
+        THROW_HR_IF_MSG(E_INVALIDARG, m_items.Size() >= c_maxSelectionElements, "Maximum number of items added");
+        THROW_HR_IF_MSG(E_INVALIDARG, id.empty(), "You must provide an id for the item");
+
+        m_items.Insert(id, content);
+
+        return *this;
+    }
+
+    winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationComboBox AppNotificationComboBox::SetTitle(winrt::hstring const& value)
+    {
+        m_title = value;
+
+        return *this;
+    }
+
+    winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationComboBox AppNotificationComboBox::SetSelectedItem(winrt::hstring const& id)
+    {
+        THROW_HR_IF_MSG(E_INVALIDARG, id.empty(), "You must provide an id for the selected item");
+
+        m_selectedItem = id;
+
+        return *this;
+    }
+
+    std::wstring AppNotificationComboBox::GetSelectionItems()
+    {
+        std::wstring items{};
+
+        for (auto pair : m_items)
+        {
+            items.append(wil::str_printf<std::wstring>(L"<selection id='%ls' content='%ls'/>", pair.Key().c_str(), pair.Value().c_str()));
+        }
+
+        return items;
+    }
+
+    winrt::hstring AppNotificationComboBox::ToString()
+    {
+        std::wstring xmlResult{ wil::str_printf<std::wstring>(L"<input id='%ls' type='selection'%ls%ls>%ls</input>",
+            m_id.c_str(),
+            m_title.empty() ? L"" : wil::str_printf<std::wstring>(L" title='%ls'", m_title.c_str()).c_str(),
+            m_selectedItem.empty() ? L"" : wil::str_printf<std::wstring>(L" defaultInput='%ls'", m_selectedItem.c_str()).c_str(),
+            GetSelectionItems().c_str()) };
+
+        return xmlResult.c_str();
+    }
+}

dev/AppNotifications/AppNotificationBuilder/AppNotificationComboBox.h

@@ -0,0 +1,48 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+#pragma once
+#include "Microsoft.Windows.AppNotifications.Builder.AppNotificationComboBox.g.h"
+
+namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
+{
+    struct AppNotificationComboBox : AppNotificationComboBoxT<AppNotificationComboBox, winrt::Windows::Foundation::IStringable>
+    {
+        AppNotificationComboBox(winrt::hstring const& id);
+
+        // Properties
+        void Items(winrt::Windows::Foundation::Collections::IMap<winrt::hstring, winrt::hstring> const& value) { m_items = value; };
+        winrt::Windows::Foundation::Collections::IMap<winrt::hstring, winrt::hstring> Items() { return m_items; };
+
+        void Title(winrt::hstring const& value) { m_title = value; };
+        winrt::hstring Title() { return m_title; };
+
+        void SelectedItem(winrt::hstring const& value) { m_selectedItem = value; };
+        winrt::hstring SelectedItem() { return m_selectedItem; };
+
+        // Fluent Setters
+        winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationComboBox AddItem(winrt::hstring const& id, winrt::hstring const& content);
+
+        winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationComboBox SetTitle(winrt::hstring const& value);
+
+        winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationComboBox SetSelectedItem(winrt::hstring const& id);
+
+        // IStringable
+        winrt::hstring ToString();
+
+    private:
+        winrt::hstring m_id{};
+        winrt::Windows::Foundation::Collections::IMap<winrt::hstring, winrt::hstring> m_items{ winrt::single_threaded_map<winrt::hstring, winrt::hstring>() };
+        winrt::hstring m_title{};
+        winrt::hstring m_selectedItem{};
+
+        std::wstring GetSelectionItems();
+    };
+}
+
+namespace winrt::Microsoft::Windows::AppNotifications::Builder::factory_implementation
+{
+    struct AppNotificationComboBox : AppNotificationComboBoxT<AppNotificationComboBox, implementation::AppNotificationComboBox>
+    {
+    };
+}