Add app badge to Declarative Web Push #402
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -392,14 +392,26 @@ <h3> | |
| </dd> | ||
| </dl> | ||
| </dd> | ||
| <dt> | ||
| <code>app_badge</code> | ||
| </dt> | ||
| <dd> | ||
| <p> | ||
| A [=/64-bit unsigned integer=]. | ||
marcoscaceres marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| </p> | ||
| <p class="note"> | ||
| Platform conventions are likely to impose a lower limit with regards to what is | ||
| displayed to the end user. [[BADGING]] | ||
| </p> | ||
| </dd> | ||
| <dt> | ||
| <code>mutable</code> | ||
| </dt> | ||
| <dd> | ||
| <p> | ||
| A boolean. When true causes a <code>push</code> event to be dispatched to a service | ||
| worker (if any) containing the {{Notification}} object and app badge number (if | ||
| any) described by the <a>declarative push message</a>. | ||
| </p> | ||
| </dd> | ||
| </dl> | ||
|
|
@@ -411,7 +423,8 @@ <h3> | |
| <p> | ||
| A <dfn>declarative push message parser result</dfn> is a [=/tuple=] consisting of a | ||
| <dfn data-dfn-for="declarative push message parser result">notification</dfn> (a | ||
| [=/notification=]), an <dfn data-dfn-for="declarative push message parser result">app | ||
| badge</dfn> (null or an integer), and a <dfn data-dfn-for= | ||
| "declarative push message parser result">mutable</dfn> (a boolean). | ||
| </p> | ||
| <p> | ||
|
|
@@ -673,6 +686,18 @@ <h3> | |
| <var>notification</var>'s [=notification/actions=] is null, then return failure. | ||
| </p> | ||
| </li> | ||
| <li> | ||
| <p> | ||
| Let <var>appBadge</var> be null. | ||
| </p> | ||
| </li> | ||
| <li> | ||
| <p> | ||
| If <var>message</var>["`app_badge`"] [=map/exists=] and | ||
| <var>message</var>["`app_badge`"] is a [=/64-bit unsigned integer=], then set | ||
| <var>appBadge</var> to <var>message</var>["`app_badge`"]. | ||
| </p><!-- unsigned long long in Web IDL --> | ||
| </li> | ||
| <li> | ||
| <p> | ||
| Let <var>mutable</var> be false. | ||
|
|
@@ -687,7 +712,7 @@ <h3> | |
| </li> | ||
| <li> | ||
| <p> | ||
| Return (<var>notification</var>, <var>appBadge</var>, <var>mutable</var>). | ||
| </p> | ||
| </li> | ||
| </ol> | ||
|
|
@@ -1598,11 +1623,13 @@ <h2> | |
| constructor(DOMString type, optional PushEventInit eventInitDict = {}); | ||
| readonly attribute PushMessageData? data; | ||
| readonly attribute Notification? notification; | ||
| readonly attribute unsigned long long? appBadge; | ||
| }; | ||
|
|
||
| dictionary PushEventInit : ExtendableEventInit { | ||
| PushMessageDataInit? data = null; | ||
| Notification? notification = null; | ||
| unsigned long long? appBadge = null; | ||
| }; | ||
|
|
||
| typedef (BufferSource or USVString) PushMessageDataInit; | ||
|
|
@@ -1629,6 +1656,9 @@ <h2> | |
| <p> | ||
| The <dfn>notification</dfn> attribute must return the value it was initialized with. | ||
| </p> | ||
| <p> | ||
| The <dfn>appBadge</dfn> attribute must return the value it was initialized with. | ||
| </p> | ||
| </section> | ||
| <section> | ||
| <h2> | ||
|
|
@@ -1715,6 +1745,11 @@ <h2> | |
| Let |notificationShown| be false. | ||
| </p> | ||
| </li> | ||
| <li> | ||
| <p> | ||
| Let |appBadgeSet| be false. | ||
| </p> | ||
| </li> | ||
| <li> | ||
| <p> | ||
| If |declarativeResult|'s [=declarative push message parser result/mutable=] | ||
|
|
@@ -1724,14 +1759,16 @@ <h2> | |
| <li> | ||
| <p> | ||
| Let |result| be the result of [=fire a push event|firing a push event=] | ||
| given |registration|, null, a new {{Notification}} object representing | ||
| |notification|, and |declarativeResult|'s [=declarative push message | ||
| parser result/app badge=]. | ||
| </p> | ||
| </li> | ||
| <li> | ||
| <p> | ||
| If |result| is not failure, then set |notificationShown| to |result|'s | ||
| [=push event result/notification shown=] and |appBadgeSet| to |result|'s | ||
| [=push event result/app badge set=]. | ||
| </p> | ||
| </li> | ||
| </ol> | ||
|
|
@@ -1742,6 +1779,27 @@ <h2> | |
| given |notification|. | ||
| </p> | ||
| </li> | ||
| <li data-cite="appmanifest"> | ||
| <p> | ||
| If |appBadgeSet| is false and the web application associated with the <a>push | ||
| subscription</a> is an [=installed web application=]: | ||
|
Member
Author
There was a problem hiding this comment. We should use |subscription| here, I think? Maybe
Member
Author
There was a problem hiding this comment. Though it would be nice to also support this outside of installed web applications. But I suppose that's a separate change.
Member
There was a problem hiding this comment. Setting a badge is pretty tightly bound to installation at the moment, as that's how it's been implemented by everyone. We could change this if this changes. |
||
| </p> | ||
| <ol> | ||
| <li> | ||
| <p> | ||
| Let |identity| be the web application's [=installed web | ||
| application/identity=] [=/URL=]. | ||
| </p> | ||
| </li> | ||
| <li> | ||
| <p> | ||
| [=Set the application badge for installed web application=] given | ||
|
|
||
| |identity| and |declarativeResult|'s [=declarative push message parser | ||
| result/app badge=]. | ||
| </p> | ||
| </li> | ||
| </ol> | ||
| </li> | ||
| <li> | ||
| <p> | ||
| [=acknowledge a push message|Acknowledge=] the <a>push message</a> and abort | ||
|
|
@@ -1761,7 +1819,7 @@ <h2> | |
| <li> | ||
| <p> | ||
| Let |result| be the result of [=fire a push event|firing a push event=] given | ||
| |registration|, |data|, null, and null. | ||
| </p> | ||
| </li> | ||
| <li> | ||
|
|
@@ -1779,20 +1837,27 @@ <h2> | |
| </li> | ||
| </ol> | ||
| <p> | ||
| A <dfn>push event result</dfn> is a [=/tuple=] consisting of a <dfn for= | ||
| "push event result">notification shown</dfn> (a [=/boolean=]) and an <dfn for= | ||
| "push event result">app badge set</dfn> (a [=/boolean=]). | ||
| </p> | ||
| <p> | ||
| To <dfn>fire a push event</dfn> given a [=/service worker registration=] |registration|, | ||
| {{PushMessageData}} object or null |data|, a [=/notification=] or null |notification|, | ||
| and an integer or null |appBadge|, run these steps. They return failure or a [=/push | ||
| event result=]. | ||
| </p> | ||
| <ol> | ||
| <li> | ||
| <p> | ||
| Let |notificationResult| be null. | ||
| </p> | ||
| </li> | ||
| <li> | ||
| <p> | ||
| Let |appBadgeResult| be null. | ||
| </p> | ||
| </li> | ||
| <li> | ||
| <p> | ||
| Set |registration|'s [=service worker registration/has shownotification() been | ||
|
|
@@ -1817,6 +1882,12 @@ <h2> | |
| <dd> | ||
| |notification| | ||
| </dd> | ||
| <dt> | ||
| {{PushEvent/appBadge}} | ||
| </dt> | ||
| <dd> | ||
| |appBadge| | ||
| </dd> | ||
| </dl> | ||
| <p> | ||
| Then run the following steps in parallel, with |dispatchedEvent|: | ||
|
|
@@ -1830,21 +1901,28 @@ <h2> | |
| </li> | ||
| <li> | ||
| <p> | ||
| If they do not resolve successfully, then set |notificationResult| and | ||
| |appBadgeResult| to failure and abort these steps. | ||
| </p> | ||
| </li> | ||
| <li> | ||
| <p> | ||
| Set |notificationResult| to |registration|'s [=service worker registration/has | ||
| shownotification() been successfully invoked|has `showNotification()` been | ||
| successfully invoked=]. | ||
| </p> | ||
| </li> | ||
| <li> | ||
| <p> | ||
| Set |appBadgeResult| to true if {{NavigatorBadge/setAppBadge()}} has been | ||
| invoked; otherwise false. | ||
|
Member
Author
There was a problem hiding this comment. @marcoscaceres we need a hook for this similar to "has
Member
There was a problem hiding this comment. IIUC, in the case of notifications, it emulates calling Instead, for the Badging case, can we reuse "set the application badge for an installed web application" and I can get that to return a boolean if it worked?
Member
Author
There was a problem hiding this comment. No, this is specifically to catch the case where the developer used See https://notifications.spec.whatwg.org/#service-worker-registration-has-shownotification-been-successfully-invoked and how
Member
There was a problem hiding this comment. ah, ok... I'll have another look. |
||
| </p> | ||
| </li> | ||
| </ol> | ||
| </li> | ||
| <li> | ||
| <p> | ||
| Wait for |notificationResult| and |appBadgeResult| to be non-null. | ||
| </p> | ||
| </li> | ||
| <li> | ||
|
|
@@ -1854,12 +1932,12 @@ <h2> | |
| </li> | ||
| <li> | ||
| <p> | ||
| [=/Assert=]: |notificationResult| and |appBadgeResult| are [=/booleans=]. | ||
| </p> | ||
| </li> | ||
| <li> | ||
| <p> | ||
| Return (|notificationResult|, |appBadgeResult|). | ||
| </p> | ||
| </li> | ||
| </ol> | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just noting that not all platforms support setting a number: for instance, Android allows setting the badge to "flag" (which just shows up as a dot). Some macOS apps do this too (e.g., Slack).
For backwards compat, we might need to default change the badging API to support an enum to explicitly set a
"flag"as the default value, so that:There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So you're saying that even platforms that do render a number, can also render just the badge without the number? In that case we'd indeed need to support that separate state. We could perhaps allow passing undefined or null for that? Bit finicky, I'll admit.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correct. Android in particular supports both modes ("App Icon can Show Badges with Numbers or Dot-style Badges"). Even though it's user controlled, a web developer can still just set a "dot" (i.e., what in the Badging spec is called a "flag").
Yeah :( hopefully we can do it consistently across both specs.
Possibly the most compatible option would be to change
app_badgeto support either abooleanor a64-bit unsigned integer:We can distinguish between the types, so could potentially work.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That shape sounds good. What happens for platforms that don't support "flag" though?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Described in w3c/badging#123