HttpClient Clase
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Proporciona una clase para enviar solicitudes HTTP y recibir respuestas HTTP de un recurso identificado por un URI.
public ref class HttpClient : System::Net::Http::HttpMessageInvoker
public class HttpClient : System.Net.Http.HttpMessageInvoker
type HttpClient = class
inherit HttpMessageInvoker
Public Class HttpClient
Inherits HttpMessageInvoker
- Herencia
Ejemplos
// HttpClient is intended to be instantiated once per application, rather than per-use. See Remarks.
static readonly HttpClient client = new HttpClient();
static async Task Main()
{
// Call asynchronous network methods in a try/catch block to handle exceptions.
try
{
using HttpResponseMessage response = await client.GetAsync("http://www.contoso.com/");
response.EnsureSuccessStatusCode();
string responseBody = await response.Content.ReadAsStringAsync();
// Above three lines can be replaced with new helper method below
// string responseBody = await client.GetStringAsync(uri);
Console.WriteLine(responseBody);
}
catch (HttpRequestException e)
{
Console.WriteLine("\nException Caught!");
Console.WriteLine("Message :{0} ", e.Message);
}
}
open System.Net.Http
// HttpClient is intended to be instantiated once per application, rather than per-use. See Remarks.
let client = new HttpClient()
let main =
task {
// Call asynchronous network methods in a try/catch block to handle exceptions.
try
use! response = client.GetAsync "http://www.contoso.com/"
response.EnsureSuccessStatusCode() |> ignore
let! responseBody = response.Content.ReadAsStringAsync()
// Above three lines can be replaced with new helper method below
// let! responseBody = client.GetStringAsync uri
printfn $"{responseBody}"
with
| :? HttpRequestException as e ->
printfn "\nException Caught!"
printfn $"Message :{e.Message} "
}
main.Wait()
' HttpClient is intended to be instantiated once per application, rather than per-use. See Remarks.
Shared ReadOnly client As HttpClient = New HttpClient()
Private Shared Async Function Main() As Task
' Call asynchronous network methods in a try/catch block to handle exceptions.
Try
Using response As HttpResponseMessage = Await client.GetAsync("http://www.contoso.com/")
response.EnsureSuccessStatusCode()
Dim responseBody As String = Await response.Content.ReadAsStringAsync()
' Above three lines can be replaced with new helper method below
' Dim responseBody As String = Await client.GetStringAsync(uri)
Console.WriteLine(responseBody)
End Using
Catch e As HttpRequestException
Console.WriteLine(Environment.NewLine & "Exception Caught!")
Console.WriteLine("Message :{0} ", e.Message)
End Try
End Function
Comentarios
Para obtener más información sobre esta API, consulte Comentarios complementarios de api para HttpClient.
Constructores
| Nombre | Description |
|---|---|
| HttpClient() |
Inicializa una nueva instancia de la HttpClient clase mediante un HttpClientHandler que se elimina cuando se elimina esta instancia. |
| HttpClient(HttpMessageHandler, Boolean) |
Inicializa una nueva instancia de la HttpClient clase con el controlador proporcionado y especifica si ese controlador se debe eliminar cuando se elimina esta instancia. |
| HttpClient(HttpMessageHandler) |
Inicializa una nueva instancia de la HttpClient clase con el controlador especificado. El controlador se elimina cuando se elimina esta instancia. |
Propiedades
| Nombre | Description |
|---|---|
| BaseAddress |
Obtiene o establece la dirección base del identificador uniforme de recursos (URI) del recurso de Internet que se usa al enviar solicitudes. |
| DefaultProxy |
Obtiene o establece el proxy HTTP global. |
| DefaultRequestHeaders |
Obtiene los encabezados que se deben enviar con cada solicitud. |
| DefaultRequestVersion |
Obtiene o establece la versión HTTP predeterminada usada en las solicitudes posteriores realizadas por esta HttpClient instancia. |
| DefaultVersionPolicy |
Obtiene o establece la directiva de versión predeterminada para las solicitudes creadas implícitamente en métodos útiles, por ejemplo, GetAsync(String) y PostAsync(String, HttpContent). |
| MaxResponseContentBufferSize |
Obtiene o establece el número máximo de bytes que se van a almacenar en búfer al leer el contenido de la respuesta. |
| Timeout |
Obtiene o establece el intervalo de tiempo que se va a esperar antes de que se agote el tiempo de espera de la solicitud. |
Métodos
| Nombre | Description |
|---|---|
| CancelPendingRequests() |
Cancele todas las solicitudes pendientes en esta instancia. |
| DeleteAsync(String, CancellationToken) |
Envíe una solicitud DELETE al URI especificado con un token de cancelación como una operación asincrónica. |
| DeleteAsync(String) |
Envíe una solicitud DELETE al URI especificado como una operación asincrónica. |
| DeleteAsync(Uri, CancellationToken) |
Envíe una solicitud DELETE al URI especificado con un token de cancelación como una operación asincrónica. |
| DeleteAsync(Uri) |
Envíe una solicitud DELETE al URI especificado como una operación asincrónica. |
| Dispose() |
Libera los recursos no administrados y elimina los recursos administrados usados por .HttpMessageInvoker (Heredado de HttpMessageInvoker) |
| Dispose(Boolean) |
Libera los recursos no administrados utilizados por HttpClient y, opcionalmente, elimina los recursos administrados. |
| Equals(Object) |
Determina si el objeto especificado es igual al objeto actual. (Heredado de Object) |
| GetAsync(String, CancellationToken) |
Envíe una solicitud GET al URI especificado con un token de cancelación como una operación asincrónica. |
| GetAsync(String, HttpCompletionOption, CancellationToken) |
Envíe una solicitud GET al URI especificado con una opción de finalización HTTP y un token de cancelación como una operación asincrónica. |
| GetAsync(String, HttpCompletionOption) |
Envíe una solicitud GET al URI especificado con una opción de finalización HTTP como una operación asincrónica. |
| GetAsync(String) |
Envíe una solicitud GET al URI especificado como una operación asincrónica. |
| GetAsync(Uri, CancellationToken) |
Envíe una solicitud GET al URI especificado con un token de cancelación como una operación asincrónica. |
| GetAsync(Uri, HttpCompletionOption, CancellationToken) |
Envíe una solicitud GET al URI especificado con una opción de finalización HTTP y un token de cancelación como una operación asincrónica. |
| GetAsync(Uri, HttpCompletionOption) |
Envíe una solicitud GET al URI especificado con una opción de finalización HTTP como una operación asincrónica. |
| GetAsync(Uri) |
Envíe una solicitud GET al URI especificado como una operación asincrónica. |
| GetByteArrayAsync(String, CancellationToken) |
Envía una solicitud GET al URI especificado y devuelve el cuerpo de la respuesta como una matriz de bytes en una operación asincrónica. |
| GetByteArrayAsync(String) |
Envía una solicitud GET al URI especificado y devuelve el cuerpo de la respuesta como una matriz de bytes en una operación asincrónica. |
| GetByteArrayAsync(Uri, CancellationToken) |
Envíe una solicitud GET al URI especificado y devuelva el cuerpo de la respuesta como una matriz de bytes en una operación asincrónica. |
| GetByteArrayAsync(Uri) |
Envíe una solicitud GET al URI especificado y devuelva el cuerpo de la respuesta como una matriz de bytes en una operación asincrónica. |
| GetHashCode() |
Actúa como función hash predeterminada. (Heredado de Object) |
| GetStreamAsync(String, CancellationToken) |
Envíe una solicitud GET al URI especificado y devuelva el cuerpo de la respuesta como una secuencia en una operación asincrónica. |
| GetStreamAsync(String) |
Envíe una solicitud GET al URI especificado y devuelva el cuerpo de la respuesta como una secuencia en una operación asincrónica. |
| GetStreamAsync(Uri, CancellationToken) |
Envíe una solicitud GET al URI especificado y devuelva el cuerpo de la respuesta como una secuencia en una operación asincrónica. |
| GetStreamAsync(Uri) |
Envíe una solicitud GET al URI especificado y devuelva el cuerpo de la respuesta como una secuencia en una operación asincrónica. |
| GetStringAsync(String, CancellationToken) |
Envíe una solicitud GET al URI especificado y devuelva el cuerpo de la respuesta como una cadena en una operación asincrónica. |
| GetStringAsync(String) |
Envíe una solicitud GET al URI especificado y devuelva el cuerpo de la respuesta como una cadena en una operación asincrónica. |
| GetStringAsync(Uri, CancellationToken) |
Envíe una solicitud GET al URI especificado y devuelva el cuerpo de la respuesta como una cadena en una operación asincrónica. |
| GetStringAsync(Uri) |
Envíe una solicitud GET al URI especificado y devuelva el cuerpo de la respuesta como una cadena en una operación asincrónica. |
| GetType() |
Obtiene el Type de la instancia actual. (Heredado de Object) |
| MemberwiseClone() |
Crea una copia superficial del Objectactual. (Heredado de Object) |
| PatchAsync(String, HttpContent, CancellationToken) |
Envía una solicitud PATCH con un token de cancelación a un URI representado como una cadena como una operación asincrónica. |
| PatchAsync(String, HttpContent) |
Envía una solicitud PATCH a un URI designado como una cadena como una operación asincrónica. |
| PatchAsync(Uri, HttpContent, CancellationToken) |
Envía una solicitud PATCH con un token de cancelación como una operación asincrónica. |
| PatchAsync(Uri, HttpContent) |
Envía una solicitud PATCH como una operación asincrónica. |
| PostAsync(String, HttpContent, CancellationToken) |
Envíe una solicitud POST con un token de cancelación como una operación asincrónica. |
| PostAsync(String, HttpContent) |
Envíe una solicitud POST al URI especificado como una operación asincrónica. |
| PostAsync(Uri, HttpContent, CancellationToken) |
Envíe una solicitud POST con un token de cancelación como una operación asincrónica. |
| PostAsync(Uri, HttpContent) |
Envíe una solicitud POST al URI especificado como una operación asincrónica. |
| PutAsync(String, HttpContent, CancellationToken) |
Envíe una solicitud PUT con un token de cancelación como una operación asincrónica. |
| PutAsync(String, HttpContent) |
Envíe una solicitud PUT al URI especificado como una operación asincrónica. |
| PutAsync(Uri, HttpContent, CancellationToken) |
Envíe una solicitud PUT con un token de cancelación como una operación asincrónica. |
| PutAsync(Uri, HttpContent) |
Envíe una solicitud PUT al URI especificado como una operación asincrónica. |
| Send(HttpRequestMessage, CancellationToken) |
Envía una solicitud HTTP con la solicitud y el token de cancelación especificados. |
| Send(HttpRequestMessage, HttpCompletionOption, CancellationToken) |
Envía una solicitud HTTP con la solicitud, la opción de finalización y el token de cancelación especificados. |
| Send(HttpRequestMessage, HttpCompletionOption) |
Envía una solicitud HTTP. |
| Send(HttpRequestMessage) |
Envía una solicitud HTTP con la solicitud especificada. |
| SendAsync(HttpRequestMessage, CancellationToken) |
Envíe una solicitud HTTP como una operación asincrónica. |
| SendAsync(HttpRequestMessage, HttpCompletionOption, CancellationToken) |
Envíe una solicitud HTTP como una operación asincrónica. |
| SendAsync(HttpRequestMessage, HttpCompletionOption) |
Envíe una solicitud HTTP como una operación asincrónica. |
| SendAsync(HttpRequestMessage) |
Envíe una solicitud HTTP como una operación asincrónica. |
| ToString() |
Devuelve una cadena que representa el objeto actual. (Heredado de Object) |
Métodos de extensión
| Nombre | Description |
|---|---|
| DeleteFromJsonAsync(HttpClient, String, Type, CancellationToken) |
Envía una solicitud DELETE al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica. |
| DeleteFromJsonAsync(HttpClient, String, Type, JsonSerializerContext, CancellationToken) |
Envía una solicitud DELETE al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica. |
| DeleteFromJsonAsync(HttpClient, String, Type, JsonSerializerOptions, CancellationToken) |
Envía una solicitud DELETE al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica. |
| DeleteFromJsonAsync(HttpClient, Uri, Type, CancellationToken) |
Envía una solicitud DELETE al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica. |
| DeleteFromJsonAsync(HttpClient, Uri, Type, JsonSerializerContext, CancellationToken) |
Envía una solicitud DELETE al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica. |
| DeleteFromJsonAsync(HttpClient, Uri, Type, JsonSerializerOptions, CancellationToken) |
Envía una solicitud DELETE al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica. |
| DeleteFromJsonAsync<TValue>(HttpClient, String, CancellationToken) |
Envía una solicitud DELETE al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica. |
| DeleteFromJsonAsync<TValue>(HttpClient, String, JsonSerializerOptions, CancellationToken) |
Envía una solicitud DELETE al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica. |
| DeleteFromJsonAsync<TValue>(HttpClient, String, JsonTypeInfo<TValue>, CancellationToken) |
Envía una solicitud DELETE al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica. |
| DeleteFromJsonAsync<TValue>(HttpClient, Uri, CancellationToken) |
Envía una solicitud DELETE al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica. |
| DeleteFromJsonAsync<TValue>(HttpClient, Uri, JsonSerializerOptions, CancellationToken) |
Envía una solicitud DELETE al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica. |
| DeleteFromJsonAsync<TValue>(HttpClient, Uri, JsonTypeInfo<TValue>, CancellationToken) |
Envía una solicitud DELETE al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica. |
| GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, String, CancellationToken) |
Envía una |
| GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, String, JsonSerializerOptions, CancellationToken) |
Envía una |
| GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, String, JsonTypeInfo<TValue>, CancellationToken) |
Envía una |
| GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, Uri, CancellationToken) |
Envía una |
| GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, Uri, JsonSerializerOptions, CancellationToken) |
Envía una |
| GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, Uri, JsonTypeInfo<TValue>, CancellationToken) |
Envía una |
| GetFromJsonAsync(HttpClient, String, Type, CancellationToken) |
Envía una solicitud GET al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica. |
| GetFromJsonAsync(HttpClient, String, Type, JsonSerializerContext, CancellationToken) |
Envía una solicitud GET al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica. |
| GetFromJsonAsync(HttpClient, String, Type, JsonSerializerOptions, CancellationToken) |
Envía una solicitud GET al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica. |
| GetFromJsonAsync(HttpClient, Uri, Type, CancellationToken) |
Envía una solicitud GET al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica. |
| GetFromJsonAsync(HttpClient, Uri, Type, JsonSerializerContext, CancellationToken) |
Envía una solicitud GET al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica. |
| GetFromJsonAsync(HttpClient, Uri, Type, JsonSerializerOptions, CancellationToken) |
Envía una solicitud GET al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica. |
| GetFromJsonAsync<TValue>(HttpClient, String, CancellationToken) |
Envía una solicitud GET al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica. |
| GetFromJsonAsync<TValue>(HttpClient, String, JsonSerializerOptions, CancellationToken) |
Envía una solicitud GET al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica. |
| GetFromJsonAsync<TValue>(HttpClient, String, JsonTypeInfo<TValue>, CancellationToken) |
Envía una solicitud GET al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica. |
| GetFromJsonAsync<TValue>(HttpClient, Uri, CancellationToken) |
Envía una solicitud GET al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica. |
| GetFromJsonAsync<TValue>(HttpClient, Uri, JsonSerializerOptions, CancellationToken) |
Envía una solicitud GET al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica. |
| GetFromJsonAsync<TValue>(HttpClient, Uri, JsonTypeInfo<TValue>, CancellationToken) |
Envía una solicitud GET al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica. |
| PatchAsJsonAsync<TValue>(HttpClient, String, TValue, CancellationToken) |
Envía una solicitud PATCH al URI especificado que contiene el |
| PatchAsJsonAsync<TValue>(HttpClient, String, TValue, JsonSerializerOptions, CancellationToken) |
Envía una solicitud PATCH al URI especificado que contiene el |
| PatchAsJsonAsync<TValue>(HttpClient, String, TValue, JsonTypeInfo<TValue>, CancellationToken) |
Envía una solicitud PATCH al URI especificado que contiene el |
| PatchAsJsonAsync<TValue>(HttpClient, Uri, TValue, CancellationToken) |
Envía una solicitud PATCH al URI especificado que contiene el |
| PatchAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonSerializerOptions, CancellationToken) |
Envía una solicitud PATCH al URI especificado que contiene el |
| PatchAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonTypeInfo<TValue>, CancellationToken) |
Envía una solicitud PATCH al URI especificado que contiene el |
| PostAsJsonAsync<TValue>(HttpClient, String, TValue, CancellationToken) |
Envía una solicitud POST al URI especificado que contiene el |
| PostAsJsonAsync<TValue>(HttpClient, String, TValue, JsonSerializerOptions, CancellationToken) |
Envía una solicitud POST al URI especificado que contiene el |
| PostAsJsonAsync<TValue>(HttpClient, String, TValue, JsonTypeInfo<TValue>, CancellationToken) |
Envía una solicitud POST al URI especificado que contiene el |
| PostAsJsonAsync<TValue>(HttpClient, Uri, TValue, CancellationToken) |
Envía una solicitud POST al URI especificado que contiene el |
| PostAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonSerializerOptions, CancellationToken) |
Envía una solicitud POST al URI especificado que contiene el |
| PostAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonTypeInfo<TValue>, CancellationToken) |
Envía una solicitud POST al URI especificado que contiene el |
| PutAsJsonAsync<TValue>(HttpClient, String, TValue, CancellationToken) |
Envíe una solicitud PUT al URI especificado que contiene el |
| PutAsJsonAsync<TValue>(HttpClient, String, TValue, JsonSerializerOptions, CancellationToken) |
Envíe una solicitud PUT al URI especificado que contiene el |
| PutAsJsonAsync<TValue>(HttpClient, String, TValue, JsonTypeInfo<TValue>, CancellationToken) |
Envíe una solicitud PUT al URI especificado que contiene el |
| PutAsJsonAsync<TValue>(HttpClient, Uri, TValue, CancellationToken) |
Envíe una solicitud PUT al URI especificado que contiene el |
| PutAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonSerializerOptions, CancellationToken) |
Envíe una solicitud PUT al URI especificado que contiene el |
| PutAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonTypeInfo<TValue>, CancellationToken) |
Envíe una solicitud PUT al URI especificado que contiene el |