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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
|
// Copyright (c) Microsoft Corporation. All rights reserved. See License.txt in the project root for license information.
using System.ComponentModel;
using System.Diagnostics.CodeAnalysis;
using System.Net.Http.Formatting;
using System.Threading;
using System.Threading.Tasks;
namespace System.Net.Http
{
/// <summary>
/// Extension methods that aid in making formatted requests using <see cref="HttpClient"/>.
/// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public static class HttpClientExtensions
{
/// <summary>
/// Sends a POST request as an asynchronous operation to the specified Uri with the given <paramref name="value"/> serialized
/// as JSON.
/// </summary>
/// <remarks>
/// This method uses the default instance of <see cref="JsonMediaTypeFormatter"/>.
/// </remarks>
/// <typeparam name="T">The type of <paramref name="value"/>.</typeparam>
/// <param name="client">The client used to make the request.</param>
/// <param name="requestUri">The Uri the request is sent to.</param>
/// <param name="value">The value that will be placed in the request's entity body.</param>
/// <returns>A task object representing the asynchronous operation.</returns>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings", MessageId = "1#", Justification = "We want to support URIs as strings")]
public static Task<HttpResponseMessage> PostAsJsonAsync<T>(this HttpClient client, string requestUri, T value)
{
return client.PostAsJsonAsync(requestUri, value, CancellationToken.None);
}
/// <summary>
/// Sends a POST request as an asynchronous operation to the specified Uri with the given <paramref name="value"/> serialized
/// as JSON.
/// </summary>
/// <remarks>
/// This method uses the default instance of <see cref="JsonMediaTypeFormatter"/>.
/// </remarks>
/// <typeparam name="T">The type of <paramref name="value"/>.</typeparam>
/// <param name="client">The client used to make the request.</param>
/// <param name="requestUri">The Uri the request is sent to.</param>
/// <param name="value">The value that will be placed in the request's entity body.</param>
/// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
/// <returns>A task object representing the asynchronous operation.</returns>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings", MessageId = "1#", Justification = "We want to support URIs as strings")]
public static Task<HttpResponseMessage> PostAsJsonAsync<T>(this HttpClient client, string requestUri, T value, CancellationToken cancellationToken)
{
return client.PostAsync(requestUri, value, new JsonMediaTypeFormatter(), cancellationToken);
}
/// <summary>
/// Sends a POST request as an asynchronous operation to the specified Uri with the given <paramref name="value"/> serialized
/// as XML.
/// </summary>
/// <remarks>
/// This method uses the default instance of <see cref="XmlMediaTypeFormatter"/>.
/// </remarks>
/// <typeparam name="T">The type of <paramref name="value"/>.</typeparam>
/// <param name="client">The client used to make the request.</param>
/// <param name="requestUri">The Uri the request is sent to.</param>
/// <param name="value">The value that will be placed in the request's entity body.</param>
/// <returns>A task object representing the asynchronous operation.</returns>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings", MessageId = "1#", Justification = "We want to support URIs as strings")]
public static Task<HttpResponseMessage> PostAsXmlAsync<T>(this HttpClient client, string requestUri, T value)
{
return client.PostAsXmlAsync(requestUri, value, CancellationToken.None);
}
/// <summary>
/// Sends a POST request as an asynchronous operation to the specified Uri with the given <paramref name="value"/> serialized
/// as XML.
/// </summary>
/// <remarks>
/// This method uses the default instance of <see cref="XmlMediaTypeFormatter"/>.
/// </remarks>
/// <typeparam name="T">The type of <paramref name="value"/>.</typeparam>
/// <param name="client">The client used to make the request.</param>
/// <param name="requestUri">The Uri the request is sent to.</param>
/// <param name="value">The value that will be placed in the request's entity body.</param>
/// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
/// <returns>A task object representing the asynchronous operation.</returns>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings", MessageId = "1#", Justification = "We want to support URIs as strings")]
public static Task<HttpResponseMessage> PostAsXmlAsync<T>(this HttpClient client, string requestUri, T value, CancellationToken cancellationToken)
{
return client.PostAsync(requestUri, value, new XmlMediaTypeFormatter(), cancellationToken);
}
/// <summary>
/// Sends a POST request as an asynchronous operation to the specified Uri with <paramref name="value"/>
/// serialized using the given <paramref name="formatter"/>.
/// </summary>
/// <seealso cref="PostAsync{T}(HttpClient, string, T, MediaTypeFormatter, string, CancellationToken)"/>
/// <typeparam name="T">The type of <paramref name="value"/>.</typeparam>
/// <param name="client">The client used to make the request.</param>
/// <param name="requestUri">The Uri the request is sent to.</param>
/// <param name="value">The value that will be placed in the request's entity body.</param>
/// <param name="formatter">The formatter used to serialize the <paramref name="value"/>.</param>
/// <returns>A task object representing the asynchronous operation.</returns>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings", MessageId = "1#", Justification = "We want to support URIs as strings")]
public static Task<HttpResponseMessage> PostAsync<T>(this HttpClient client, string requestUri, T value, MediaTypeFormatter formatter)
{
return client.PostAsync(requestUri, value, formatter, CancellationToken.None);
}
/// <summary>
/// Sends a POST request as an asynchronous operation to the specified Uri with <paramref name="value"/>
/// serialized using the given <paramref name="formatter"/>.
/// </summary>
/// <seealso cref="PostAsync{T}(HttpClient, string, T, MediaTypeFormatter, string, CancellationToken)"/>
/// <typeparam name="T">The type of <paramref name="value"/>.</typeparam>
/// <param name="client">The client used to make the request.</param>
/// <param name="requestUri">The Uri the request is sent to.</param>
/// <param name="value">The value that will be placed in the request's entity body.</param>
/// <param name="formatter">The formatter used to serialize the <paramref name="value"/>.</param>
/// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
/// <returns>A task object representing the asynchronous operation.</returns>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings", MessageId = "1#", Justification = "We want to support URIs as strings")]
public static Task<HttpResponseMessage> PostAsync<T>(this HttpClient client, string requestUri, T value, MediaTypeFormatter formatter, CancellationToken cancellationToken)
{
return client.PostAsync(requestUri, value, formatter, mediaType: null, cancellationToken: cancellationToken);
}
/// <summary>
/// Sends a POST request as an asynchronous operation to the specified Uri with <paramref name="value"/>
/// serialized using the given <paramref name="formatter"/>.
/// </summary>
/// <seealso cref="PostAsync{T}(HttpClient, string, T, MediaTypeFormatter, string, CancellationToken)"/>
/// <typeparam name="T">The type of <paramref name="value"/>.</typeparam>
/// <param name="client">The client used to make the request.</param>
/// <param name="requestUri">The Uri the request is sent to.</param>
/// <param name="value">The value that will be placed in the request's entity body.</param>
/// <param name="formatter">The formatter used to serialize the <paramref name="value"/>.</param>
/// <param name="mediaType">The authoritative value of the request's content's Content-Type header. Can be <c>null</c> in which case the
/// <paramref name="formatter">formatter's</paramref> default content type will be used.</param>
/// <returns>A task object representing the asynchronous operation.</returns>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings", MessageId = "1#", Justification = "We want to support URIs as strings")]
public static Task<HttpResponseMessage> PostAsync<T>(this HttpClient client, string requestUri, T value, MediaTypeFormatter formatter, string mediaType)
{
return client.PostAsync(requestUri, value, formatter, mediaType, CancellationToken.None);
}
/// <summary>
/// Sends a POST request as an asynchronous operation to the specified Uri with <paramref name="value"/>
/// serialized using the given <paramref name="formatter"/>.
/// </summary>
/// <typeparam name="T">The type of <paramref name="value"/>.</typeparam>
/// <param name="client">The client used to make the request.</param>
/// <param name="requestUri">The Uri the request is sent to.</param>
/// <param name="value">The value that will be placed in the request's entity body.</param>
/// <param name="formatter">The formatter used to serialize the <paramref name="value"/>.</param>
/// <param name="mediaType">The authoritative value of the request's content's Content-Type header. Can be <c>null</c> in which case the
/// <paramref name="formatter">formatter's</paramref> default content type will be used.</param>
/// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
/// <returns>A task object representing the asynchronous operation.</returns>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings", MessageId = "1#", Justification = "We want to support URIs as strings")]
[SuppressMessage("Microsoft.Reliability", "CA2000:Dispose objects before losing scope", Justification = "The caller is responsible for disposing the object")]
[SuppressMessage("Microsoft.Usage", "CA2234:PassSystemUriObjectsInsteadOfStrings", Justification = "The called method will convert to Uri instance.")]
public static Task<HttpResponseMessage> PostAsync<T>(this HttpClient client, string requestUri, T value, MediaTypeFormatter formatter, string mediaType, CancellationToken cancellationToken)
{
if (client == null)
{
throw new ArgumentNullException("client");
}
var content = new ObjectContent<T>(value, formatter, mediaType);
return client.PostAsync(requestUri, content, cancellationToken);
}
/// <summary>
/// Sends a PUT request as an asynchronous operation to the specified Uri with the given <paramref name="value"/> serialized
/// as JSON.
/// </summary>
/// <remarks>
/// This method uses the default instance of <see cref="JsonMediaTypeFormatter"/>.
/// </remarks>
/// <typeparam name="T">The type of <paramref name="value"/>.</typeparam>
/// <param name="client">The client used to make the request.</param>
/// <param name="requestUri">The Uri the request is sent to.</param>
/// <param name="value">The value that will be placed in the request's entity body.</param>
/// <returns>A task object representing the asynchronous operation.</returns>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings", MessageId = "1#", Justification = "We want to support URIs as strings")]
public static Task<HttpResponseMessage> PutAsJsonAsync<T>(this HttpClient client, string requestUri, T value)
{
return client.PutAsJsonAsync(requestUri, value, CancellationToken.None);
}
/// <summary>
/// Sends a PUT request as an asynchronous operation to the specified Uri with the given <paramref name="value"/> serialized
/// as JSON.
/// </summary>
/// <remarks>
/// This method uses the default instance of <see cref="JsonMediaTypeFormatter"/>.
/// </remarks>
/// <typeparam name="T">The type of <paramref name="value"/>.</typeparam>
/// <param name="client">The client used to make the request.</param>
/// <param name="requestUri">The Uri the request is sent to.</param>
/// <param name="value">The value that will be placed in the request's entity body.</param>
/// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
/// <returns>A task object representing the asynchronous operation.</returns>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings", MessageId = "1#", Justification = "We want to support URIs as strings")]
public static Task<HttpResponseMessage> PutAsJsonAsync<T>(this HttpClient client, string requestUri, T value, CancellationToken cancellationToken)
{
return client.PutAsync(requestUri, value, new JsonMediaTypeFormatter(), cancellationToken);
}
/// <summary>
/// Sends a PUT request as an asynchronous operation to the specified Uri with the given <paramref name="value"/> serialized
/// as XML.
/// </summary>
/// <remarks>
/// This method uses the default instance of <see cref="XmlMediaTypeFormatter"/>.
/// </remarks>
/// <typeparam name="T">The type of <paramref name="value"/>.</typeparam>
/// <param name="client">The client used to make the request.</param>
/// <param name="requestUri">The Uri the request is sent to.</param>
/// <param name="value">The value that will be placed in the request's entity body.</param>
/// <returns>A task object representing the asynchronous operation.</returns>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings", MessageId = "1#", Justification = "We want to support URIs as strings")]
public static Task<HttpResponseMessage> PutAsXmlAsync<T>(this HttpClient client, string requestUri, T value)
{
return client.PutAsXmlAsync(requestUri, value, CancellationToken.None);
}
/// <summary>
/// Sends a PUT request as an asynchronous operation to the specified Uri with the given <paramref name="value"/> serialized
/// as XML.
/// </summary>
/// <remarks>
/// This method uses the default instance of <see cref="XmlMediaTypeFormatter"/>.
/// </remarks>
/// <typeparam name="T">The type of <paramref name="value"/>.</typeparam>
/// <param name="client">The client used to make the request.</param>
/// <param name="requestUri">The Uri the request is sent to.</param>
/// <param name="value">The value that will be placed in the request's entity body.</param>
/// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
/// <returns>A task object representing the asynchronous operation.</returns>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings", MessageId = "1#", Justification = "We want to support URIs as strings")]
public static Task<HttpResponseMessage> PutAsXmlAsync<T>(this HttpClient client, string requestUri, T value, CancellationToken cancellationToken)
{
return client.PutAsync(requestUri, value, new XmlMediaTypeFormatter(), cancellationToken);
}
/// <summary>
/// Sends a PUT request as an asynchronous operation to the specified Uri with <paramref name="value"/>
/// serialized using the given <paramref name="formatter"/>.
/// </summary>
/// <seealso cref="PutAsync{T}(HttpClient, string, T, MediaTypeFormatter, string, CancellationToken)"/>
/// <typeparam name="T">The type of <paramref name="value"/>.</typeparam>
/// <param name="client">The client used to make the request.</param>
/// <param name="requestUri">The Uri the request is sent to.</param>
/// <param name="value">The value that will be placed in the request's entity body.</param>
/// <param name="formatter">The formatter used to serialize the <paramref name="value"/>.</param>
/// <returns>A task object representing the asynchronous operation.</returns>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings", MessageId = "1#", Justification = "We want to support URIs as strings")]
public static Task<HttpResponseMessage> PutAsync<T>(this HttpClient client, string requestUri, T value, MediaTypeFormatter formatter)
{
return client.PutAsync(requestUri, value, formatter, CancellationToken.None);
}
/// <summary>
/// Sends a PUT request as an asynchronous operation to the specified Uri with <paramref name="value"/>
/// serialized using the given <paramref name="formatter"/>.
/// </summary>
/// <seealso cref="PutAsync{T}(HttpClient, string, T, MediaTypeFormatter, string, CancellationToken)"/>
/// <typeparam name="T">The type of <paramref name="value"/>.</typeparam>
/// <param name="client">The client used to make the request.</param>
/// <param name="requestUri">The Uri the request is sent to.</param>
/// <param name="value">The value that will be placed in the request's entity body.</param>
/// <param name="formatter">The formatter used to serialize the <paramref name="value"/>.</param>
/// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
/// <returns>A task object representing the asynchronous operation.</returns>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings", MessageId = "1#", Justification = "We want to support URIs as strings")]
public static Task<HttpResponseMessage> PutAsync<T>(this HttpClient client, string requestUri, T value, MediaTypeFormatter formatter, CancellationToken cancellationToken)
{
return client.PutAsync(requestUri, value, formatter, mediaType: null, cancellationToken: cancellationToken);
}
/// <summary>
/// Sends a PUT request as an asynchronous operation to the specified Uri with <paramref name="value"/>
/// serialized using the given <paramref name="formatter"/>.
/// </summary>
/// <seealso cref="PutAsync{T}(HttpClient, string, T, MediaTypeFormatter, string, CancellationToken)"/>
/// <typeparam name="T">The type of <paramref name="value"/>.</typeparam>
/// <param name="client">The client used to make the request.</param>
/// <param name="requestUri">The Uri the request is sent to.</param>
/// <param name="value">The value that will be placed in the request's entity body.</param>
/// <param name="formatter">The formatter used to serialize the <paramref name="value"/>.</param>
/// <param name="mediaType">The authoritative value of the request's content's Content-Type header. Can be <c>null</c> in which case the
/// <paramref name="formatter">formatter's</paramref> default content type will be used.</param>
/// <returns>A task object representing the asynchronous operation.</returns>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings", MessageId = "1#", Justification = "We want to support URIs as strings")]
public static Task<HttpResponseMessage> PutAsync<T>(this HttpClient client, string requestUri, T value, MediaTypeFormatter formatter, string mediaType)
{
return client.PutAsync(requestUri, value, formatter, mediaType, CancellationToken.None);
}
/// <summary>
/// Sends a PUT request as an asynchronous operation to the specified Uri with <paramref name="value"/>
/// serialized using the given <paramref name="formatter"/>.
/// </summary>
/// <typeparam name="T">The type of <paramref name="value"/>.</typeparam>
/// <param name="client">The client used to make the request.</param>
/// <param name="requestUri">The Uri the request is sent to.</param>
/// <param name="value">The value that will be placed in the request's entity body.</param>
/// <param name="formatter">The formatter used to serialize the <paramref name="value"/>.</param>
/// <param name="mediaType">The authoritative value of the request's content's Content-Type header. Can be <c>null</c> in which case the
/// <paramref name="formatter">formatter's</paramref> default content type will be used.</param>
/// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
/// <returns>A task object representing the asynchronous operation.</returns>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings", MessageId = "1#", Justification = "We want to support URIs as strings")]
[SuppressMessage("Microsoft.Reliability", "CA2000:Dispose objects before losing scope", Justification = "The caller is responsible for disposing the object")]
[SuppressMessage("Microsoft.Usage", "CA2234:PassSystemUriObjectsInsteadOfStrings", Justification = "The called method will convert to Uri instance.")]
public static Task<HttpResponseMessage> PutAsync<T>(this HttpClient client, string requestUri, T value, MediaTypeFormatter formatter, string mediaType, CancellationToken cancellationToken)
{
if (client == null)
{
throw new ArgumentNullException("client");
}
var content = new ObjectContent<T>(value, formatter, mediaType);
return client.PutAsync(requestUri, content, cancellationToken);
}
}
}
|
