HttpHelperRequest
Warning
(This API is obsolete and has been removed. Please use System.Net.Http.HttpRequestMessage or Windows.Web.Http.HttpRequestMessage directly)
The HttpHelperRequest (/dotnet/api/microsoft.toolkit.uwp.httphelperrequest
) represents an HTTP request message including headers.
var request = new HttpHelperRequest(uri, HttpMethod.Get);
Dim request = New HttpHelperRequest(uri, HttpMethod.[Get])
Constructors
The HttpHelperRequest class has these constructors.
Constructor | Description |
---|---|
HttpHelperRequest(Uri) | Initializes a new instance of the HttpHelperRequest class with an HTTP Get method and a request Uri. |
HttpHelperRequest(HttpMethod, Uri) | Initializes a new instance of the HttpRequestMessage class with an HTTP method and a request Uri. |
Methods
The HttpHelperRequest class has these methods. It also inherits from Object class.
Method | Description |
---|---|
ToHttpRequestMessage() | Returns an instance of HttpRequestMessage representing current HttpHelperRequest object. |
Dispose() | Performs tasks associated with freeing, releasing, or resetting unmanaged resources. |
ToString() | Returns a string that represents the current HttpHelperRequest object. |
Properties
The HttpHelperRequest class has these properties.
Property | Type | Description |
---|---|---|
Content | IHttpContent | Gets or sets the HTTP content to send to the server on the HTTP request |
Headers | HttpRequestHeaderCollection | Gets the collection of the HTTP request headers associated with the request |
Method | HttpMethod | Gets the HTTP method to be performed on the request URI |
RequestUri | Uri | Gets the Uri used for the HTTP request |
Remarks
The HttpHelperRequest class contains headers, the HTTP verb, and potentially data. An app starts by using one of the HttpHelperRequest constructors to create an HttpRequestHelper instance. The app then sets various properties on the HttpRequestHelper as needed. Then the HttpRequestHelper is passed as a parameter to the HttpHelper.SendRequestAsync method.
Example
var request = new HttpHelperRequest(uri, HttpMethod.Get);
request.Headers.Authorization = new Windows.Web.Http.Headers.HttpCredentialsHeaderValue("OAuth", authorizationHeaderParams);
Dim request = New HttpHelperRequest(uri, HttpMethod.[Get])
request.Headers.Authorization = New Windows.Web.Http.Headers.HttpCredentialsHeaderValue("OAuth", authorizationHeaderParams)
Requirements
Device family | Universal, 10.0.16299.0 or higher |
---|---|
Namespace | Microsoft.Toolkit.Uwp |
NuGet package | Microsoft.Toolkit.Uwp |
API
- HttpHelperRequest source code (
https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp/Helpers/HttpHelper/HttpHelperRequest.cs
)
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for