Add PushManager.supportedContentEncodings #252
Conversation
|
I'm sure the phrasing can be improved, @martinthomson. Most open to suggestions! |
index.html
Outdated
| @@ -314,6 +314,10 @@ | |||
| specification assumes the use of this protocol; alternative protocols are expected to | |||
| provide compatible semantics. | |||
| </p> | |||
| <p> | |||
| The <dfn>Content-Encoding</dfn> HTTP header, described in section 3.1.2.2. of [[!RFC7231]], | |||
There was a problem hiding this comment.
The RFC style guide references sections using "Section 3.1.2.2", capital on Section and no trailing period.
| @@ -642,12 +646,25 @@ | |||
| </p> | |||
| <pre class="idl"> | |||
| interface PushManager { | |||
| [SameObject] static readonly attribute FrozenArray<DOMString> supportedContentEncodings; | |||
There was a problem hiding this comment.
Hmm, it's called a content coding, but the header is content-encoding. I think that supportedContentEncodings is probably the best choice, because other than us nerds who work on this stuff, the difference is meaningless.
There was a problem hiding this comment.
Agreed - the developer is exposed to the Content-Encoding header more than the fact it accepts a (list of) content coding.
index.html
Outdated
| Promise<PushSubscription> subscribe(optional PushSubscriptionOptionsInit options); | ||
| Promise<PushSubscription?> getSubscription(); | ||
| Promise<PushPermissionState> permissionState(optional PushSubscriptionOptionsInit options); | ||
| }; | ||
| </pre> | ||
| <p> | ||
| The <dfn>supportedContentEncodings</dfn> attribute exposes the sequence of supported content | ||
| codings using which the payload of a <a>push message</a> can be encrypted. When a content |
There was a problem hiding this comment.
"... codings that can be used to encrypt the payload of a push message."
index.html
Outdated
| The <dfn>supportedContentEncodings</dfn> attribute exposes the sequence of supported content | ||
| codings using which the payload of a <a>push message</a> can be encrypted. When a content | ||
| coding is used, it MUST be set in the <a>Content-Encoding</a> HTTP header when sending a | ||
| <a>push message</a> to the <a>push service</a>. |
There was a problem hiding this comment.
I don't think that you want the MUST requirement here.
"A content coding is indicated using the Content-Encoding header field when requesting the sending of a push message from the push service." ...Maybe.
There was a problem hiding this comment.
Done. I considered changing it around (sending from the AS) but there's other cases too, so I adopted your suggestion.
beverloo
force-pushed
the
supported-encodings
branch
from
72e89f4 to
0bae071
Compare
index.html
Outdated
| @@ -314,6 +314,10 @@ | |||
| specification assumes the use of this protocol; alternative protocols are expected to | |||
| provide compatible semantics. | |||
| </p> | |||
| <p> | |||
| The <dfn>Content-Encoding</dfn> HTTP header, described in section 3.1.2.2. of [[!RFC7231]], | |||
| @@ -642,12 +646,25 @@ | |||
| </p> | |||
| <pre class="idl"> | |||
| interface PushManager { | |||
| [SameObject] static readonly attribute FrozenArray<DOMString> supportedContentEncodings; | |||
There was a problem hiding this comment.
Agreed - the developer is exposed to the Content-Encoding header more than the fact it accepts a (list of) content coding.
index.html
Outdated
| Promise<PushSubscription> subscribe(optional PushSubscriptionOptionsInit options); | ||
| Promise<PushSubscription?> getSubscription(); | ||
| Promise<PushPermissionState> permissionState(optional PushSubscriptionOptionsInit options); | ||
| }; | ||
| </pre> | ||
| <p> | ||
| The <dfn>supportedContentEncodings</dfn> attribute exposes the sequence of supported content | ||
| codings using which the payload of a <a>push message</a> can be encrypted. When a content |
index.html
Outdated
| The <dfn>supportedContentEncodings</dfn> attribute exposes the sequence of supported content | ||
| codings using which the payload of a <a>push message</a> can be encrypted. When a content | ||
| coding is used, it MUST be set in the <a>Content-Encoding</a> HTTP header when sending a | ||
| <a>push message</a> to the <a>push service</a>. |
There was a problem hiding this comment.
Done. I considered changing it around (sending from the AS) but there's other cases too, so I adopted your suggestion.
Fixes #251