Skip to content

Commit

Permalink
Remove documentation for the RTCIceCandidateType enum (#6459)
Browse files Browse the repository at this point in the history
  • Loading branch information
queengooborg authored Jun 30, 2021
1 parent 29af89a commit 8acca38
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 65 deletions.
1 change: 1 addition & 0 deletions files/en-us/_redirects.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8349,6 +8349,7 @@
/en-US/docs/Web/API/RTCIceCandidatePairStats/circuitBreakerTriggerCoun /en-US/docs/Web/API/RTCIceCandidatePairStats/circuitBreakerTriggerCount
/en-US/docs/Web/API/RTCIceCandidatePairStats/contentRequestsSent /en-US/docs/Web/API/RTCIceCandidatePairStats/consentRequestsSent
/en-US/docs/Web/API/RTCIceCandidateStats/ip /en-US/docs/Web/API/RTCIceCandidateStats/address
/en-US/docs/Web/API/RTCIceCandidateType /en-US/docs/Web/API/RTCIceCandidate/type
/en-US/docs/Web/API/RTCIceConnectionState /en-US/docs/Web/API/RTCPeerConnection/iceConnectionState
/en-US/docs/Web/API/RTCIceGatheringState /en-US/docs/Web/API/RTCPeerConnection/iceGatheringState
/en-US/docs/Web/API/RTCInboundRtpStreamStats/lastPacketReceivedTimesta /en-US/docs/Web/API/RTCInboundRtpStreamStats/lastPacketReceivedTimestamp
Expand Down
7 changes: 0 additions & 7 deletions files/en-us/_wikihistory.json
Original file line number Diff line number Diff line change
Expand Up @@ -72276,13 +72276,6 @@
"Sheppy"
]
},
"Web/API/RTCIceCandidateType": {
"modified": "2020-10-15T22:06:15.113Z",
"contributors": [
"sideshowbarker",
"Sheppy"
]
},
"Web/API/RTCIceComponent": {
"modified": "2020-10-15T22:06:08.263Z",
"contributors": [
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/rtcicecandidate/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ <h2 id="Properties">Properties</h2>
<dt>{{domxref("RTCIceCandidate.tcpType", "tcpType")}} {{readonlyInline}}</dt>
<dd>If <code>protocol</code> is <code>"tcp"</code><code>tcpType</code> represents the type of TCP candidate. Otherwise, <code>tcpType</code> is <code>null</code>.</dd>
<dt>{{domxref("RTCIceCandidate.type", "type")}} {{readonlyInline}}</dt>
<dd>A {{domxref("DOMString")}} indicating the type of candidate as one of the strings from the {{domxref("RTCIceCandidateType")}} enumerated type.</dd>
<dd>A {{domxref("DOMString")}} indicating the type of candidate as one of the strings listed on <a href="/en-US/docs/Web/API/RTCIceCandidate/type#Values"><code>RTCIceCandidate.type</code></a>.</dd>
<dt>{{domxref("RTCIceCandidate.usernameFragment", "usernameFragment")}} {{ReadOnlyInline}}</dt>
<dd>A {{domxref("DOMString")}} containing a randomly-generated username fragment ("ice-ufrag") which ICE uses for message integrity along with a randomly-generated password ("ice-pwd"). You can use this string to verify generations of ICE generation; each generation of the same ICE process will use the same <code>usernameFragment</code>, even across ICE restarts.</dd>
</dl>
Expand Down
18 changes: 14 additions & 4 deletions files/en-us/web/api/rtcicecandidate/type/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,20 @@ <h2 id="Syntax">Syntax</h2>

<h3 id="Value">Value</h3>

<p>A {{domxref("DOMString")}} whose value is one of those defined by the
{{domxref("RTCIceCandidateType")}} enumerated type.</p>

<p>{{page("/en-US/docs/Web/API/RTCIceCandidateType", "Values")}}</p>
<p>A {{domxref("DOMString")}} whose value is one of those defined below. These candidate types are listed in order of priority; the higher in the list they are, the more efficient they are.</p>

<div id="value-list">
<dl>
<dt><code>host</code></dt>
<dd>The candidate is a host candidate, whose IP address as specified in the {{domxref("RTCIceCandidate.ip")}} property is in fact the true address of the remote peer.</dd>
<dt><code>srflx</code></dt>
<dd>The candidate is a server reflexive candidate; the <code>ip</code> indicates an intermediary address assigned by the {{Glossary("STUN")}} server to represent the candidate's peer anonymously.</dd>
<dt><code>prflx</code></dt>
<dd>The candidate is a peer reflexive candidate; the <code>ip</code> is an intermediary address assigned by the STUN server to represent the candidate's peer anonymously.</dd>
<dt><code>relay</code></dt>
<dd>The candidate is a relay candidate, obtained from a {{Glossary("TURN")}} server. The relay candidate's IP address is an address the TURN server uses to forward the media between the two peers.</dd>
</dl>
</div>

<p>If <code>type</code> is <code>null</code>, that information was missing from the
{{domxref("RTCIceCandidate.candidate", "candidate")}}'s a-line, which will cause
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,7 @@ <h2 id="Syntax">Syntax</h2>

<h3 id="Value">Value</h3>

<p>A {{domxref("DOMString")}} whose value is one of the strings found in the
{{domxref("RTCIceCandidateType")}} enumerated
type:{{page("/en-US/docs/Web/API/RTCIceCandidateType", "value-list")}}</p>
<p>A {{domxref("DOMString")}} whose value is one of the strings found in <a href="/en-US/docs/Web/API/RTCIceCandidate/type#Values"><code>RTCIceCandidate.type</code></a>.</p>

<h2 id="Specifications">Specifications</h2>

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/rtcicecandidatestats/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ <h2 id="Properties">Properties</h2>
<dt>{{domxref("RTCIceCandidateStats.address", "address")}} {{optional_inline}}</dt>
<dd>A string containing the address of the candidate. This value may be an IPv4 address, an IPv6 address, or a fully-qualified domain name. This property was previously named <code>ip</code> and only accepted IP addresses.</dd>
<dt>{{domxref("RTCIceCandidateStats.candidateType", "candidateType")}} {{optional_inline}}</dt>
<dd>A string matching one of the values in the {{domxref("RTCIceCandidateType")}} enumerated type, indicating what kind of candidate the object provides statistics for.</dd>
<dd>A string matching one of the values in <a href="/en-US/docs/Web/API/RTCIceCandidate/type#Values"><code>RTCIceCandidate.type</code></a>, indicating what kind of candidate the object provides statistics for.</dd>
<dt>{{domxref("RTCIceCandidateStats.deleted", "deleted")}} {{optional_inline}}</dt>
<dd>A Boolean value indicating whether or not the candidate has been released or deleted; the default value is <code>false</code>. For local candidates, it's value is <code>true</code> if the candidate has been deleted or released. For host candidates, <code>true</code> means that any network resources (usually a network socket) associated with the candidate have already been released. For {{Glossary("TURN")}} candidates, the TURN allocation is no longer active for deleted candidates. This property is not present for remote candidates.</dd>
<dt>{{domxref("RTCIceCandidateStats.networkType", "networkType")}} {{optional_inline}}</dt>
Expand Down
49 changes: 0 additions & 49 deletions files/en-us/web/api/rtcicecandidatetype/index.html

This file was deleted.

0 comments on commit 8acca38

Please sign in to comment.