API Spec for Badge Notifications in WindowsAppSdk

[SatwikKrSharma]

This is the API Spec for the Badge Notifications in WindowsAppSdk. Issue - #138

A microsoft employee must use /azp run to validate using the pipelines below.

WARNING:
Comments made by azure-pipelines bot maybe inaccurate.
Please see pipeline link to verify that the build is being ran.

For status checks on the main branch, please use TransportPackage-Foundation-PR
(https://microsoft.visualstudio.com/ProjectReunion/_build?definitionId=81063&_a=summary)
and run the build against your PR branch with the default parameters.

[jonwis]

Thinking about this more, is the BadgeNotification class necessary? It seems like it's "in the way" - providing little additional value over just calling methods directly. You could imagine a model like:

void SetNotificationCount(UInt32 notificationCount);
void SetNotificationCount(UInt32 notificationCount, DateTime expiration);
void SetNotificationGlyph(BadgeNotificationGlyph glyph);
void SetNotificationGlyph(BadgeNotificationGlyph glyph, DateTime expiration);

[SatwikKrSharma]

1. Encapsulation: By having a separate BadgeNotification class, I have encapsulate all the properties and behaviors related to the badge's appearance and data. This makes the class easier to understand and maintain. The BadgeNotificationManager then focuses solely on the management tasks, such as updating and clearing the badge.

2. Extensibility: In the future, the BadgeNotification class may need to support additional properties or methods (e.g., badge color, expiration time, or animation). Having a dedicated class for the badge notification makes it easier to extend its functionality without cluttering the management class or violating SRP.

3. Testability: With a separate BadgeNotification class, I can test the badge's functionality in isolation from the management logic. This leads to more focused and reliable unit tests, as each test can concentrate on a single aspect of the system.

4. Reusability: If the badge notification logic is encapsulated in its own class, it's possible to reuse the BadgeNotification class in different contexts within the application or across different applications, without needing to bring along the management logic.

5. Separation of Concerns: By keeping the BadgeNotification and BadgeNotificationManager classes separate, I have adhered to the principle of separation of concerns. Each class addresses a distinct concern: one for representing the badge notification data and another for handling the lifecycle of badge notifications.

6. Maintainability: As the application grows and evolves, having a clear separation between the representation of a badge notification and its management will make the codebase more maintainable. Changes to the notification appearance or data structure will not impact the management logic, and vice versa.

7. Collaboration: In a team environment, different developers might work on different aspects of the badge notifications. Having separate classes allows for clearer ownership and reduces the likelihood of merge conflicts when multiple developers are working on the same codebase.

In summary, keeping the BadgeNotification class separate from the BadgeNotificationManager class adheres to good object-oriented design principles and sets a strong foundation for a maintainable, extensible, and testable codebase.

[jonwis]

OK, thanks. Next up is API review with the reps group. I'll get something on the calendar for us. You are welcome to make a child branch now and start implementation if you'd like, just be aware that there may be interface-changing feedback.

[FrankC-msft]

Why create a new namespace for .BadgeNotifications instead of putting these enum and classes into Microsoft.Windows.AppNotifications? Is there a use-case for these outside of apps' badges?

(Adding to the existing namespace looks analogous to BadgeUpdater being in Windows.UI.Notifications Namespace which is described as "Contains classes that encapsulate tile, toast, and badge notifications.". Is WinAppSDK intentionally more granular?)

[jonwis]

DISCUSSION: This follows the PSDK model of having two different namespaces.

RECOMMEND: OK with this as-is, under the BadgeNotification.

[jonwis]

DISCUSSION: This is the last of the -Notification types coming in from PSDK (app, push, badge.) There's also Widget notifications. We should consider what happens when other visual formats of apps need to convey information...

[microsoft-github-policy-service]

@SatwikKrSharma please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

• (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.

@microsoft-github-policy-service agree

• (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.

@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

1. Definitions.
   “Code” means the computer software code, whether in human-readable or machine-executable form,
   that is delivered by You to Microsoft under this Agreement.
   “Project” means any of the projects owned or managed by Microsoft and offered under a license
   approved by the Open Source Initiative (www.opensource.org).
   “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
   Project, including but not limited to communication on electronic mailing lists, source code control
   systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
   discussing and improving that Project, but excluding communication that is conspicuously marked or
   otherwise designated in writing by You as “Not a Submission.”
   “Submission” means the Code and any other copyrightable material Submitted by You, including any
   associated comments and documentation.
2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
   Project. This Agreement covers any and all Submissions that You, now or in the future (except as
   described in Section 4 below), Submit to any Project.
3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
   Should You wish to Submit materials that are not Your original work, You may Submit them separately
   to the Project if You (a) retain all copyright and license information that was in the materials as You
   received them, (b) in the description accompanying Your Submission, include the phrase “Submission
   containing materials of a third party:” followed by the names of the third party and any licenses or other
   restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
   guidelines concerning Submissions.
4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
   for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
   Submission is made in the course of Your work for an employer or Your employer has intellectual
   property rights in Your Submission by contract or applicable law, You must secure permission from Your
   employer to make the Submission before signing this Agreement. In that case, the term “You” in this
   Agreement will refer to You and the employer collectively. If You change employers in the future and
   desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
   and secure permission from the new employer before Submitting those Submissions.
5. Licenses.

• Copyright License. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
  Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
  the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
  parties.
• Patent License. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
  Your patent claims that are necessarily infringed by the Submission or the combination of the
  Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
  import or otherwise dispose of the Submission alone or with the Project.
• Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
  No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
  granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above
   licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
   have disclosed under Section 3). You represent that You have secured permission from Your employer to
   make the Submission in cases where Your Submission is made in the course of Your work for Your
   employer or Your employer has intellectual property rights in Your Submission by contract or applicable
   law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
   have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
   You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
   REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
   EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
   PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
   NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
7. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
   You later become aware that would make Your representations in this Agreement inaccurate in any
   respect.
8. Information about Submissions. You agree that contributions to Projects and information about
   contributions may be maintained indefinitely and disclosed publicly, including Your name and other
   information that You submit with Your Submission.
9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
   the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
   Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
   exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
   defenses of lack of personal jurisdiction and forum non-conveniens.
10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

[oldnewthing]

TYPO

Suggested change

	winrt::BadgeNotificationGlyph badgeNotificationGlyph = winrt::BadgeNotificationGlyph::Alert
	winrt::BadgeNotificationGlyph badgeNotificationGlyph = winrt::BadgeNotificationGlyph::Alert;

[jonwis]

RECOMMEND: Fix

[SatwikKrSharma]

fixed

[oldnewthing]

If the app has multiple windows, which one gets the badge?

[jonwis]

DISCUSSION: Only the "main window" gets the badge - controlled by the existing shell implementation. For people who disdain glomming ("Combine taskbar icons"), the shell has to pick one top-level Window, where the "main badge" lives. Document that the selected tile is system-controlled.

[jonwis]

RECOMMEND: Fix

[jonwis]

DISCUSSION: Only the "main window" gets the badge - controlled by the existing shell implementation. For people who disdain glomming ("Combine taskbar icons"), the shell has to pick one top-level Window, where the "main badge" lives. Document that the selected tile is system-controlled.