AppNotificationBuilder - ProgressBar

dev/AppNotifications/AppNotificationBuilder/AppNotificationBuilder.cpp

@@ -200,6 +200,13 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
         return *this;
     }
 
+    winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationBuilder AppNotificationBuilder::AddProgressBar(AppNotificationProgressBar const& value)
+    {
+        m_progressBarList.push_back(value);
+
+        return *this;
+    }
+
     winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationBuilder AppNotificationBuilder::AddTextBox(hstring id)
     {
         ThrowIfMaxInputItemsExceeded();
@@ -347,6 +354,17 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
         return m_useButtonStyle ? L" useButtonStyle='true'" : L"";
     }
 
+    std::wstring AppNotificationBuilder::GetProgressBars()
+    {
+        std::wstring result{};
+        for (auto progressBar : m_progressBarList)
+        {
+            result.append(progressBar.as<winrt::Windows::Foundation::IStringable>().ToString());
+        }
+
+        return result;
+    }
+
     winrt::Microsoft::Windows::AppNotifications::AppNotification AppNotificationBuilder::BuildNotification()
     {
         std::wstring xmlResult{};
@@ -365,6 +383,7 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
         xmlResult.append(GetText());
         xmlResult.append(m_attributionText);
         xmlResult.append(GetImages());
+        xmlResult.append(GetProgressBars());
         xmlResult.append(L"</binding></visual>");
         xmlResult.append(m_audio.c_str());
         xmlResult.append(actions);

dev/AppNotifications/AppNotificationBuilder/AppNotificationBuilder.h

@@ -54,6 +54,8 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
         // Adds a button to the AppNotificationBuilder
         winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationBuilder AddButton(AppNotificationButton const& value);
 
+        winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationBuilder AddProgressBar(AppNotificationProgressBar const& value);
+
         winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationBuilder AddComboBox(AppNotificationComboBox const& value);
 
         winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationBuilder SetTag(winrt::hstring const& value);
@@ -72,6 +74,7 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
         std::wstring GetText();
         std::wstring GetImages();
         std::wstring GetActions();
+        std::wstring GetProgressBars();
 
         std::wstring m_timeStamp{};
         AppNotificationDuration m_duration{ AppNotificationDuration::Default };
@@ -85,6 +88,7 @@ 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<AppNotificationProgressBar> m_progressBarList{};
         std::vector<std::wstring> m_textBoxList{};
         std::vector<AppNotificationComboBox> m_comboBoxList{};
         winrt::hstring m_tag{};

dev/AppNotifications/AppNotificationBuilder/AppNotificationBuilder.idl

@@ -17,7 +17,7 @@ namespace Microsoft.Windows.AppNotifications.Builder
         AppNotificationTextProperties SetLanguage(String value);
         AppNotificationTextProperties SetIncomingCallAlignment();
         AppNotificationTextProperties SetMaxLines(Int32 value);
-    }
+    };
 
     enum AppNotificationButtonStyle
     {
@@ -65,6 +65,33 @@ namespace Microsoft.Windows.AppNotifications.Builder
         AppNotificationButton SetInvokeUri(Windows.Foundation.Uri protocolUri, String targetAppId);
     };
 
+    runtimeclass AppNotificationProgressBar
+    {
+        // AppNotificationProgressBar binds to AppNotificationProgressData so the AppNotification will
+        // receive every update to the status and value. In the WinAppSDK, these binding
+        // values are static, so developers won't need to define these binding values
+        // themselves.
+        AppNotificationProgressBar();
+
+        // Setting these properties will remove the data binding with a static value
+        String Title;
+        String Status;
+        Double Value;
+        String ValueStringOverride;
+
+        AppNotificationProgressBar SetTitle(String value);
+        AppNotificationProgressBar BindTitle();
+
+        AppNotificationProgressBar SetStatus(String value);
+        AppNotificationProgressBar BindStatus();
+
+        AppNotificationProgressBar SetValue(Double value);
+        AppNotificationProgressBar BindValue();
+
+        AppNotificationProgressBar SetValueStringOverride(String value);
+        AppNotificationProgressBar BindValueStringOverride();
+    };
+
     runtimeclass AppNotificationComboBox
     {
         AppNotificationComboBox(String id);
@@ -193,6 +220,8 @@ namespace Microsoft.Windows.AppNotifications.Builder
 
         AppNotificationBuilder AddComboBox(AppNotificationComboBox value);
 
+        AppNotificationBuilder AddProgressBar(AppNotificationProgressBar value);
+
         // Constructs a WindowsAppSDK AppNotification object with the XML payload
         Microsoft.Windows.AppNotifications.AppNotification BuildNotification();
 

dev/AppNotifications/AppNotificationBuilder/AppNotificationBuilder.vcxitems

@@ -19,14 +19,16 @@
   <ItemGroup>
     <ClCompile Include="$(MSBuildThisFileDirectory)AppNotificationBuilder.cpp" />
     <ClCompile Include="$(MSBuildThisFileDirectory)AppNotificationButton.cpp" />
+    <ClCompile Include="$(MSBuildThisFileDirectory)AppNotificationProgressBar.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)AppNotificationProgressBar.h" />
     <ClInclude Include="$(MSBuildThisFileDirectory)AppNotificationComboBox.h" />
     <ClInclude Include="$(MSBuildThisFileDirectory)AppNotificationTextProperties.h" />
   </ItemGroup>
-</Project>
+</Project>

dev/AppNotifications/AppNotificationBuilder/AppNotificationProgressBar.cpp

@@ -0,0 +1,106 @@
+// 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 "AppNotificationProgressBar.h"
+#include "Microsoft.Windows.AppNotifications.Builder.AppNotificationProgressBar.g.cpp"
+
+namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
+{
+    AppNotificationProgressBar::AppNotificationProgressBar()
+        :m_titleStatus{ BindMode::NotSet },
+         m_statusStatus{ BindMode::NotSet },
+         m_valueStatus{ BindMode::NotSet },
+         m_valueStringOverrideStatus{ BindMode::NotSet }
+    {};
+
+    void AppNotificationProgressBar::Title(winrt::hstring const& value)
+    {
+        m_title = value;
+        m_titleStatus = BindMode::Value;
+    }
+
+    void AppNotificationProgressBar::Status(winrt::hstring const& value)
+    {
+        m_status = value;
+        m_statusStatus = BindMode::Value;
+    }
+
+    void AppNotificationProgressBar::Value(double value)
+    {
+        THROW_HR_IF_MSG(E_INVALIDARG, value < 0.0 || value > 1.0, "You must provide a value between 0.0 and 1.0");
+
+        m_value = value; m_valueStatus = BindMode::Value;
+    }
+
+    void AppNotificationProgressBar::ValueStringOverride(winrt::hstring const& value)
+    {
+        m_valueStringOverride = value;
+        m_valueStringOverrideStatus = BindMode::Value;
+    }
+
+    winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationProgressBar AppNotificationProgressBar::SetTitle(winrt::hstring const& value)
+    {
+        Title(value);
+
+        return *this;
+    }
+
+    winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationProgressBar AppNotificationProgressBar::BindTitle()
+    {
+        m_titleStatus = BindMode::Bind;
+
+        return *this;
+    }
+
+    winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationProgressBar AppNotificationProgressBar::SetStatus(winrt::hstring const& value)
+    {
+        Status(value);
+
+        return *this;
+    }
+
+    winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationProgressBar AppNotificationProgressBar::BindStatus()
+    {
+        m_statusStatus = BindMode::Bind;
+
+        return *this;
+    }
+
+    winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationProgressBar AppNotificationProgressBar::SetValue(double value)
+    {
+        Value(value);
+
+        return *this;
+    }
+
+    winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationProgressBar AppNotificationProgressBar::BindValue()
+    {
+        m_valueStatus = BindMode::Bind;
+
+        return *this;
+    }
+
+    winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationProgressBar AppNotificationProgressBar::SetValueStringOverride(winrt::hstring const& value)
+    {
+        ValueStringOverride(value);
+
+        return *this;
+    }
+
+    winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationProgressBar AppNotificationProgressBar::BindValueStringOverride()
+    {
+        m_valueStringOverrideStatus = BindMode::Bind;
+
+        return *this;
+    }
+
+    winrt::hstring AppNotificationProgressBar::ToString()
+    {
+        return wil::str_printf<std::wstring>(L"<progress%ls%ls%ls%ls/>",
+            m_titleStatus == BindMode::NotSet ? L"" : wil::str_printf<std::wstring>(L" title='%ls'", m_titleStatus == BindMode::Value ? m_title.c_str() : L"{progressTitle}").c_str(),
+            wil::str_printf<std::wstring>(L" status='%ls'", m_statusStatus == BindMode::Value ? m_status.c_str() : L"{progressStatus}").c_str(),
+            wil::str_printf<std::wstring>(L" value='%ls'", m_valueStatus == BindMode::Value ? wil::str_printf<std::wstring>(L"%g", m_value).c_str() : L"{progressValue}").c_str(),
+            m_valueStringOverrideStatus == BindMode::NotSet ? L"" : wil::str_printf < std::wstring>(L" valueStringOverride='%ls'", m_valueStringOverrideStatus == BindMode::Value ? m_valueStringOverride.c_str() : L"{progressValueString}").c_str()).c_str();
+    }
+}

dev/AppNotifications/AppNotificationBuilder/AppNotificationProgressBar.h

@@ -0,0 +1,61 @@
+// 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.AppNotificationProgressBar.g.h"
+
+namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
+{
+
+    struct AppNotificationProgressBar : AppNotificationProgressBarT<AppNotificationProgressBar, winrt::Windows::Foundation::IStringable>
+    {
+        AppNotificationProgressBar();
+
+        // Properties
+        void Title(winrt::hstring const& value);
+        winrt::hstring Title() { return m_title; };
+
+        void Status(winrt::hstring const& value);
+        winrt::hstring Status() { return m_status; };
+
+        void Value(double value);
+        double Value() { return m_value; };
+
+        void ValueStringOverride(winrt::hstring const& value);
+        winrt::hstring ValueStringOverride() { return m_valueStringOverride; };
+
+        // Fluent setters
+        winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationProgressBar SetTitle(winrt::hstring const& value);
+        winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationProgressBar BindTitle();
+
+        winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationProgressBar SetStatus(winrt::hstring const& value);
+        winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationProgressBar BindStatus();
+
+        winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationProgressBar SetValue(double value);
+        winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationProgressBar BindValue();
+
+        winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationProgressBar SetValueStringOverride(winrt::hstring const& value);
+        winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationProgressBar BindValueStringOverride();
+
+        // IStringable
+        winrt::hstring ToString();
+
+    private:
+        enum class BindMode {NotSet, Bind, Value};
+
+        BindMode m_titleStatus;
+        winrt::hstring m_title;
+        BindMode m_statusStatus;
+        winrt::hstring m_status;
+        BindMode m_valueStatus;
+        double m_value;
+        BindMode m_valueStringOverrideStatus;
+        winrt::hstring m_valueStringOverride;
+    };
+}
+namespace winrt::Microsoft::Windows::AppNotifications::Builder::factory_implementation
+{
+    struct AppNotificationProgressBar : AppNotificationProgressBarT<AppNotificationProgressBar, implementation::AppNotificationProgressBar>
+    {
+    };
+}

test/AppNotificationBuilderTests/APITests.cpp

@@ -382,6 +382,86 @@ namespace Test::AppNotification::Builder
             VERIFY_ARE_EQUAL(builder.BuildNotification().Payload(), expected);
         }
 
+        TEST_METHOD(AppNotificationAddProgressBar)
+        {
+            auto builder{ AppNotificationBuilder()
+                .AddText(L"Downloading this week's new music...")
+                .AddProgressBar(AppNotificationProgressBar()
+                    .BindTitle()
+                    .BindValueStringOverride()) };
+            auto expected{ L"<toast><visual><binding template='ToastGeneric'><text>Downloading this week's new music...</text><progress title='{progressTitle}' status='{progressStatus}' value='{progressValue}' valueStringOverride='{progressValueString}'/></binding></visual></toast>" };
+
+            VERIFY_ARE_EQUAL(builder.BuildNotification().Payload(), expected);
+        }
+
+        TEST_METHOD(AppNotificationAddMoreThanOneProgressBar)
+        {
+            auto builder{ AppNotificationBuilder()
+                .AddText(L"Downloading this week's new music...")
+                .AddProgressBar(AppNotificationProgressBar()
+                    .BindTitle()
+                    .BindValueStringOverride())
+                .AddProgressBar(AppNotificationProgressBar()
+                    .SetValue(0.8)
+                    .SetStatus(L"Still downloading...")) };
+            auto expected{ L"<toast><visual><binding template='ToastGeneric'><text>Downloading this week's new music...</text><progress title='{progressTitle}' status='{progressStatus}' value='{progressValue}' valueStringOverride='{progressValueString}'/><progress status='Still downloading...' value='0.8'/></binding></visual></toast>" };
+
+            VERIFY_ARE_EQUAL(builder.BuildNotification().Payload(), expected);
+        }
+
+        TEST_METHOD(AppNotificationProgressBarDefaults)
+        {
+            auto progressBar{ AppNotificationProgressBar() };
+            auto expected{ L"<progress status='{progressStatus}' value='{progressValue}'/>" };
+
+            VERIFY_ARE_EQUAL(progressBar.as<winrt::Windows::Foundation::IStringable>().ToString(), expected);
+        }
+
+        TEST_METHOD(AppNotificationProgressBarSetSpecificValue)
+        {
+            auto progressBar{ AppNotificationProgressBar() };
+            progressBar.Value(0.8);
+            auto expected{ L"<progress status='{progressStatus}' value='0.8'/>" };
+
+            VERIFY_ARE_EQUAL(progressBar.as<winrt::Windows::Foundation::IStringable>().ToString(), expected);
+        }
+
+        TEST_METHOD(AppNotificationProgressBarSetValueLargerThanOne)
+        {
+            auto progressBar{ AppNotificationProgressBar() };
+            VERIFY_THROWS_HR(progressBar.Value(1.01), E_INVALIDARG);
+
+            VERIFY_THROWS_HR(AppNotificationProgressBar().SetValue(1.01), E_INVALIDARG);
+        }
+
+        TEST_METHOD(AppNotificationProgressBarSetValueSmallerThanZero)
+        {
+            auto progressBar{ AppNotificationProgressBar() };
+            VERIFY_THROWS_HR(progressBar.Value(-0.1), E_INVALIDARG);
+
+            VERIFY_THROWS_HR(AppNotificationProgressBar().SetValue(-0.1), E_INVALIDARG);
+        }
+
+        TEST_METHOD(AppNotificationProgressBarSetSpecificValueThenChangeToBind)
+        {
+            auto progressBar{ AppNotificationProgressBar() };
+            progressBar.Value(0.8);
+            progressBar.BindValue();
+            auto expected{ L"<progress status='{progressStatus}' value='{progressValue}'/>" };
+
+            VERIFY_ARE_EQUAL(progressBar.as<winrt::Windows::Foundation::IStringable>().ToString(), expected);
+        }
+
+        TEST_METHOD(AppNotificationProgressBarBindTitleThenChangeToSpecificText)
+        {
+            auto progressBar{ AppNotificationProgressBar()
+                .BindTitle()
+                .SetTitle(L"Specific title") };
+            auto expected{ L"<progress title='Specific title' status='{progressStatus}' value='{progressValue}'/>" };
+
+            VERIFY_ARE_EQUAL(progressBar.as<winrt::Windows::Foundation::IStringable>().ToString(), expected);
+        }
+
         TEST_METHOD(AppNotificationBuilderAddTextBox)
         {
             auto builder{ AppNotificationBuilder()

test/DynamicDependency/data/Microsoft.WindowsAppRuntime.Framework/appxmanifest.xml

@@ -87,6 +87,7 @@
             <ActivatableClass ActivatableClassId="Microsoft.Windows.AppNotifications.Builder.AppNotificationBuilder" ThreadingModel="both" />
             <ActivatableClass ActivatableClassId="Microsoft.Windows.AppNotifications.Builder.AppNotificationTextProperties" ThreadingModel="both" />
             <ActivatableClass ActivatableClassId="Microsoft.Windows.AppNotifications.Builder.AppNotificationButton" ThreadingModel="both" />
+            <ActivatableClass ActivatableClassId="Microsoft.Windows.AppNotifications.Builder.AppNotificationProgressBar" ThreadingModel="both" />
             <ActivatableClass ActivatableClassId="Microsoft.Windows.AppNotifications.Builder.AppNotificationComboBox" ThreadingModel="both" />
         </InProcessServer>
     </Extension>