Merge pull request #2773 from fippo/move-url

add url attribute to RTCIceCandidate
w3c · Oct 27, 2022 · 9ce26dd · 9ce26dd
2 parents 67341a6 + 73a0a9c
commit 9ce26dd
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 4 deletions.
diff --git a/amendments.json b/amendments.json
@@ -196,6 +196,15 @@
       "id": 16
     }
   ],
+  "rtcpeerconnectioniceevent-attributes": [
+    {
+      "description": "Add deprecation notice to RTCPeerConnectionIceEvent.url",
+      "pr": 2773,
+      "type": "correction",
+      "status": "candidate",
+      "id": 23
+    }
+  ],
   "rtcicecandidate-attributes": [
     {
       "description": "Add RTCIceCandidate.relayProtocol",
@@ -204,6 +213,13 @@
       "type": "addition",
       "status": "candidate",
       "id": 16
+    },
+    {
+      "description": "Add RTCIceCandidate.url",
+      "pr": 2773,
+      "type": "addition",
+      "status": "candidate",
+      "id": 23
     }
   ],
   "rtcicecredentialtype-enum": [

diff --git a/base-rec.html b/base-rec.html
@@ -7016,9 +7016,9 @@ <h5 id="constructors-2">
               </dl>
             </section>
             <section>
-              <h5 id="attributes-5">
+              <h5 id="rtcpeerconnectioniceevent-attributes">
                 Attributes
-              <a class="self-link" aria-label="§" href="#attributes-5"></a></h5>
+              <a class="self-link" aria-label="§" href="#rtcpeerconnectioniceevent-attributes"></a></h5>
               <dl data-link-for="RTCPeerConnectionIceEvent" data-dfn-for="RTCPeerConnectionIceEvent" class="attributes">
                 <dt data-tests="RTCPeerConnectionIceEvent-constructor.html" class="has-tests">
                   <dfn data-idl="attribute" data-export="" data-dfn-type="attribute" id="dom-rtcpeerconnectioniceevent-candidate" data-title="candidate" data-dfn-for="RTCPeerConnectionIceEvent" data-type="RTCIceCandidate" data-lt="candidate" data-local-lt="RTCPeerConnectionIceEvent.candidate"><code>candidate</code></dfn> of type <span class="idlAttrType"><a data-link-type="idl" href="#dom-rtcicecandidate" class="internalDFN" id="ref-for-dom-rtcicecandidate-15"><code><code>RTCIceCandidate</code></code></a></span>, readonly, nullable

diff --git a/webrtc.html b/webrtc.html
@@ -5938,6 +5938,7 @@ <h4>
   readonly attribute unsigned short? relatedPort;
   readonly attribute DOMString? usernameFragment;
   readonly attribute RTCIceServerTransportProtocol? relayProtocol;
+  readonly attribute DOMString? url;
   RTCIceCandidateInit toJSON();
 };</pre>
             <section>
@@ -6250,6 +6251,17 @@ <h2>
                     is only present for local relay candidates.
                   </p>
                 </dd>
+                <dt class="add-to-rtcicecandidate-attributes">
+                  <dfn>url</dfn> of type <span class=
+                  "idlMemberType">DOMString</span>
+                </dt>
+                <dd class="add-to-rtcicecandidate-attributes">
+                  <p>
+                    For local candidates of type {{RTCIceCandidateType/"srflx"}} or type
+                    {{RTCIceCandidateType/"relay"}} this is the URL of the ICE server
+                    from which the candidate was obtained.
+                  </p>
+                </dd>
               </dl>
             </section>
             <section>
@@ -6648,7 +6660,7 @@ <h4>
             </ul>
           </div>
           <div>
-            <pre class="idl" data-tests="idlharness.https.window.js">[Exposed=Window]
+            <pre class="idl" data-tests="idlharness.https.window.js" id="webidl-rtcpeerconnectioniceevent">[Exposed=Window]
 interface RTCPeerConnectionIceEvent : Event {
   constructor(DOMString type, optional RTCPeerConnectionIceEventInit eventInitDict = {});
   readonly attribute RTCIceCandidate? candidate;
@@ -6671,7 +6683,7 @@ <h2>
                 Attributes
               </h2>
               <dl data-link-for="RTCPeerConnectionIceEvent" data-dfn-for=
-              "RTCPeerConnectionIceEvent" class="attributes">
+              "RTCPeerConnectionIceEvent" id="rtcpeerconnectioniceevent-attributes" class="attributes">
                 <dt data-tests="RTCPeerConnectionIceEvent-constructor.html">
                   <dfn data-idl="">candidate</dfn> of type <span class=
                   "idlAttrType">{{RTCIceCandidate}}</span>, readonly, nullable
@@ -6702,6 +6714,10 @@ <h2>
                     TURN server, this parameter will be set to
                     <code>null</code>.
                   </p>
+                  <p class="note" class="add-to-rtcpeerconnectioniceevent-attributes">
+                    This attribute is deprecated; it exists for legacy compatibility reasons only.
+                    Prefer the candidate {{RTCIceCandidate/url}}.
+                  </p>
                 </dd>
               </dl>
             </section>