dotnet-api-docs/xml/System.Net.Http/HttpVersionPolicy.xml at rc2-doc-comments · gewarren/dotnet-api-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
<Type Name="HttpVersionPolicy" FullName="System.Net.Http.HttpVersionPolicy">
  <TypeSignature Language="C#" Value="public enum HttpVersionPolicy" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed HttpVersionPolicy extends System.Enum" />
  <TypeSignature Language="DocId" Value="T:System.Net.Http.HttpVersionPolicy" />
  <TypeSignature Language="VB.NET" Value="Public Enum HttpVersionPolicy" />
  <TypeSignature Language="C++ CLI" Value="public enum class HttpVersionPolicy" />
  <TypeSignature Language="F#" Value="type HttpVersionPolicy = " />
  <AssemblyInfo>
    <AssemblyName>System.Net.Http</AssemblyName>
    <AssemblyVersion>5.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Enum</BaseTypeName>
  </Base>
  <Docs>
    <summary>Specifies behaviors for selecting and negotiating the HTTP version for a request.</summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName="RequestVersionExact">
      <MemberSignature Language="C#" Value="RequestVersionExact" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Http.HttpVersionPolicy RequestVersionExact = int32(2)" />
      <MemberSignature Language="DocId" Value="F:System.Net.Http.HttpVersionPolicy.RequestVersionExact" />
      <MemberSignature Language="VB.NET" Value="RequestVersionExact" />
      <MemberSignature Language="C++ CLI" Value="RequestVersionExact" />
      <MemberSignature Language="F#" Value="RequestVersionExact = 2" Usage="System.Net.Http.HttpVersionPolicy.RequestVersionExact" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Net.Http</AssemblyName>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Net.Http.HttpVersionPolicy</ReturnType>
      </ReturnValue>
      <MemberValue>2</MemberValue>
      <Docs>
        <summary>Only use the requested version.</summary>
        <remarks>
          <format type="text/markdown"><![CDATA[

## Remarks
This option allows for use of a prenegotiated clear text connection for the requested version.

 ]]></format>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="RequestVersionOrHigher">
      <MemberSignature Language="C#" Value="RequestVersionOrHigher" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Http.HttpVersionPolicy RequestVersionOrHigher = int32(1)" />
      <MemberSignature Language="DocId" Value="F:System.Net.Http.HttpVersionPolicy.RequestVersionOrHigher" />
      <MemberSignature Language="VB.NET" Value="RequestVersionOrHigher" />
      <MemberSignature Language="C++ CLI" Value="RequestVersionOrHigher" />
      <MemberSignature Language="F#" Value="RequestVersionOrHigher = 1" Usage="System.Net.Http.HttpVersionPolicy.RequestVersionOrHigher" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Net.Http</AssemblyName>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Net.Http.HttpVersionPolicy</ReturnType>
      </ReturnValue>
      <MemberValue>1</MemberValue>
      <Docs>
        <summary>Use the highest available version, downgrading only to the requested version but not below.</summary>
        <remarks>
          <format type="text/markdown"><![CDATA[

## Remarks
If the server supports a higher version than the requested version (either negotiated via ALPN (H2) or advertised via Alt-Svc (H3)) and a secure connection is requested, the result is the highest available version. Otherwise, the version downgrades to <see cref="HttpRequestMessage.Version" />.

This option allows use of a prenegotiated clear text connection for the requested version but not for a higher version.

 ]]></format>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="RequestVersionOrLower">
      <MemberSignature Language="C#" Value="RequestVersionOrLower" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Http.HttpVersionPolicy RequestVersionOrLower = int32(0)" />
      <MemberSignature Language="DocId" Value="F:System.Net.Http.HttpVersionPolicy.RequestVersionOrLower" />
      <MemberSignature Language="VB.NET" Value="RequestVersionOrLower" />
      <MemberSignature Language="C++ CLI" Value="RequestVersionOrLower" />
      <MemberSignature Language="F#" Value="RequestVersionOrLower = 0" Usage="System.Net.Http.HttpVersionPolicy.RequestVersionOrLower" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Net.Http</AssemblyName>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Net.Http.HttpVersionPolicy</ReturnType>
      </ReturnValue>
      <MemberValue>0</MemberValue>
      <Docs>
        <summary>Use the requested version or downgrade to a lower one. This is the default behavior.</summary>
        <remarks>
          <format type="text/markdown"><![CDATA[

## Remarks
If the server supports the requested version, either negotiated via ALPN (H2) or advertised via Alt-Svc (H3), and a secure connection is being requested, the result is the <see cref="HttpRequestMessage.Version" />. Otherwise, the version downgrades to HTTP/1.1.

This option does not allow use of a prenegotiated clear text connection, for example, H2C.
 ]]></format>
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>