-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
Copy pathAutoClientHttpError.xml
196 lines (196 loc) · 13.5 KB
/
AutoClientHttpError.xml
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
<Type Name="AutoClientHttpError" FullName="Microsoft.Extensions.Http.AutoClient.AutoClientHttpError">
<TypeSignature Language="C#" Value="public class AutoClientHttpError" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit AutoClientHttpError extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Http.AutoClient.AutoClientHttpError" />
<TypeSignature Language="VB.NET" Value="Public Class AutoClientHttpError" />
<TypeSignature Language="F#" Value="type AutoClientHttpError = class" />
<TypeSignature Language="C++ CLI" Value="public ref class AutoClientHttpError" />
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Http.AutoClient</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Holds details about an HTTP error.
</summary>
<remarks>
When a REST API client fails, it will throw a <see cref="T:Microsoft.Extensions.Http.AutoClient.AutoClientException" />.
This exception contains a <see cref="T:Microsoft.Extensions.Http.AutoClient.AutoClientHttpError" /> instance that holds details like content, headers and status code.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AutoClientHttpError (int statusCode, System.Collections.Generic.IReadOnlyDictionary<string,Microsoft.Extensions.Primitives.StringValues> responseHeaders, string rawContent, string? reasonPhrase);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 statusCode, class System.Collections.Generic.IReadOnlyDictionary`2<string, valuetype Microsoft.Extensions.Primitives.StringValues> responseHeaders, string rawContent, string reasonPhrase) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Http.AutoClient.AutoClientHttpError.#ctor(System.Int32,System.Collections.Generic.IReadOnlyDictionary{System.String,Microsoft.Extensions.Primitives.StringValues},System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (statusCode As Integer, responseHeaders As IReadOnlyDictionary(Of String, StringValues), rawContent As String, reasonPhrase As String)" />
<MemberSignature Language="F#" Value="new Microsoft.Extensions.Http.AutoClient.AutoClientHttpError : int * System.Collections.Generic.IReadOnlyDictionary<string, Microsoft.Extensions.Primitives.StringValues> * string * string -> Microsoft.Extensions.Http.AutoClient.AutoClientHttpError" Usage="new Microsoft.Extensions.Http.AutoClient.AutoClientHttpError (statusCode, responseHeaders, rawContent, reasonPhrase)" />
<MemberSignature Language="C++ CLI" Value="public:
 AutoClientHttpError(int statusCode, System::Collections::Generic::IReadOnlyDictionary<System::String ^, Microsoft::Extensions::Primitives::StringValues> ^ responseHeaders, System::String ^ rawContent, System::String ^ reasonPhrase);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Http.AutoClient</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="statusCode" Type="System.Int32" />
<Parameter Name="responseHeaders" Type="System.Collections.Generic.IReadOnlyDictionary<System.String,Microsoft.Extensions.Primitives.StringValues>" />
<Parameter Name="rawContent" Type="System.String" />
<Parameter Name="reasonPhrase" Type="System.String">
<Attributes>
<Attribute FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="statusCode">The HTTP status code of the response.</param>
<param name="responseHeaders">The response headers.</param>
<param name="rawContent">The raw string content of the response.</param>
<param name="reasonPhrase">The HTTP error reason.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Extensions.Http.AutoClient.AutoClientHttpError" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<Microsoft.Extensions.Http.AutoClient.AutoClientHttpError> CreateAsync (System.Net.Http.HttpResponseMessage response, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1<class Microsoft.Extensions.Http.AutoClient.AutoClientHttpError> CreateAsync(class System.Net.Http.HttpResponseMessage response, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Http.AutoClient.AutoClientHttpError.CreateAsync(System.Net.Http.HttpResponseMessage,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function CreateAsync (response As HttpResponseMessage, cancellationToken As CancellationToken) As Task(Of AutoClientHttpError)" />
<MemberSignature Language="F#" Value="static member CreateAsync : System.Net.Http.HttpResponseMessage * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Extensions.Http.AutoClient.AutoClientHttpError>" Usage="Microsoft.Extensions.Http.AutoClient.AutoClientHttpError.CreateAsync (response, cancellationToken)" />
<MemberSignature Language="C++ CLI" Value="public:
 static System::Threading::Tasks::Task<Microsoft::Extensions::Http::AutoClient::AutoClientHttpError ^> ^ CreateAsync(System::Net::Http::HttpResponseMessage ^ response, System::Threading::CancellationToken cancellationToken);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Http.AutoClient</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Extensions.Http.AutoClient.AutoClientHttpError></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="response" Type="System.Net.Http.HttpResponseMessage" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="response">The response to be used.</param>
<param name="cancellationToken">Cancellation token used on asynchronous calls.</param>
<summary>
Creates an instance of <see cref="T:Microsoft.Extensions.Http.AutoClient.AutoClientHttpError" /> based on an <see cref="T:System.Net.Http.HttpResponseMessage" />.
</summary>
<returns>An instance of <see cref="T:Microsoft.Extensions.Http.AutoClient.AutoClientHttpError" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RawContent">
<MemberSignature Language="C#" Value="public string RawContent { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string RawContent" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Http.AutoClient.AutoClientHttpError.RawContent" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property RawContent As String" />
<MemberSignature Language="F#" Value="member this.RawContent : string" Usage="Microsoft.Extensions.Http.AutoClient.AutoClientHttpError.RawContent" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ RawContent { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Http.AutoClient</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the raw string content returned in the response.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReasonPhrase">
<MemberSignature Language="C#" Value="public string? ReasonPhrase { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ReasonPhrase" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Http.AutoClient.AutoClientHttpError.ReasonPhrase" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ReasonPhrase As String" />
<MemberSignature Language="F#" Value="member this.ReasonPhrase : string" Usage="Microsoft.Extensions.Http.AutoClient.AutoClientHttpError.ReasonPhrase" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ ReasonPhrase { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Http.AutoClient</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the HTTP error reason.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ResponseHeaders">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyDictionary<string,Microsoft.Extensions.Primitives.StringValues> ResponseHeaders { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyDictionary`2<string, valuetype Microsoft.Extensions.Primitives.StringValues> ResponseHeaders" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Http.AutoClient.AutoClientHttpError.ResponseHeaders" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ResponseHeaders As IReadOnlyDictionary(Of String, StringValues)" />
<MemberSignature Language="F#" Value="member this.ResponseHeaders : System.Collections.Generic.IReadOnlyDictionary<string, Microsoft.Extensions.Primitives.StringValues>" Usage="Microsoft.Extensions.Http.AutoClient.AutoClientHttpError.ResponseHeaders" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Collections::Generic::IReadOnlyDictionary<System::String ^, Microsoft::Extensions::Primitives::StringValues> ^ ResponseHeaders { System::Collections::Generic::IReadOnlyDictionary<System::String ^, Microsoft::Extensions::Primitives::StringValues> ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Http.AutoClient</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IReadOnlyDictionary<System.String,Microsoft.Extensions.Primitives.StringValues></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the HTTP response headers.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StatusCode">
<MemberSignature Language="C#" Value="public int StatusCode { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 StatusCode" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Http.AutoClient.AutoClientHttpError.StatusCode" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property StatusCode As Integer" />
<MemberSignature Language="F#" Value="member this.StatusCode : int" Usage="Microsoft.Extensions.Http.AutoClient.AutoClientHttpError.StatusCode" />
<MemberSignature Language="C++ CLI" Value="public:
 property int StatusCode { int get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Http.AutoClient</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the HTTP status code returned in the response.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>