Skip to content
31 changes: 23 additions & 8 deletions xml/System.Net.Http/SocketsHttpHandler.xml
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ If this change is undesirable, you can configure your application to use the old
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Creates an instance of a <see cref="T:System.Net.Http.SocketsHttpHandler" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -92,9 +92,24 @@ If this change is undesirable, you can configure your application to use the old
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets or sets a value that indicates whether the handler should follow redirection responses.</summary>
<value>
<see langword="true" /> if the handler should follow redirection responses; otherwise <see langword="false" />. The default value is <see langword="true" />.
</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
Set <xref:System.Net.Http.SocketsHttpHandler.AllowAutoRedirect%2A> to `true` if you want the handler to automatically follow HTTP redirection headers to the new location of the resource. The maximum number of redirections to follow is set by the <xref:System.Net.Http.SocketsHttpHandler.MaxAutomaticRedirections%2A> property.

If <xref:System.Net.Http.SocketsHttpHandler.AllowAutoRedirect%2A> is set to `false`, all HTTP responses with an HTTP status code from 300 to 399 are returned to the application.

The Authorization header is cleared on auto-redirects and the handler automatically tries to re-authenticate to the redirected location. In practice, this means that an application can't put custom authentication information into the Authorization header if it is possible to encounter redirection. Instead, the application must implement and register a custom authentication module.

> [!NOTE]
> Handler never follow a redirection from HTTPS to HTTP even if <xref:System.Net.Http.SocketsHttpHandler.AllowAutoRedirect%2A> is set to `true`.

]]></format>
</Docs>
</Member>
<Member MemberName="AutomaticDecompression">
Expand Down Expand Up @@ -138,8 +153,8 @@ If this change is undesirable, you can configure your application to use the old
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets or sets the timespan to wait before the connection establishing times out.</summary>
<value>The timespan to wait before the connection establishing times out. The default value is <xref:Timeout.InfiniteTimeSpan?displayProperty=nameWithType>.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -184,8 +199,8 @@ If this change is undesirable, you can configure your application to use the old
<ReturnType>System.Net.ICredentials</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets or sets authentication information used by this handler.</summary>
<value>The authentication credentials associated with the handler. The default is <see langword="null" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down