123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>Microsoft.Extensions.Http</name>
- </assembly>
- <members>
- <member name="T:Microsoft.Extensions.Http.HttpClientFactoryOptions">
- <summary>
- An options class for configuring the default <see cref="T:System.Net.Http.IHttpClientFactory"/>.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.Http.HttpClientFactoryOptions.HttpMessageHandlerBuilderActions">
- <summary>
- Gets a list of operations used to configure an <see cref="T:Microsoft.Extensions.Http.HttpMessageHandlerBuilder"/>.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.Http.HttpClientFactoryOptions.HttpClientActions">
- <summary>
- Gets a list of operations used to configure an <see cref="T:System.Net.Http.HttpClient"/>.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.Http.HttpClientFactoryOptions.HandlerLifetime">
- <summary>
- Gets or sets the length of time that a <see cref="T:System.Net.Http.HttpMessageHandler"/> instance can be reused. Each named
- client can have its own configured handler lifetime value. The default value of this property is two minutes.
- Set the lifetime to <see cref="F:System.Threading.Timeout.InfiniteTimeSpan"/> to disable handler expiry.
- </summary>
- <remarks>
- <para>
- The default implementation of <see cref="T:System.Net.Http.IHttpClientFactory"/> will pool the <see cref="T:System.Net.Http.HttpMessageHandler"/>
- instances created by the factory to reduce resource consumption. This setting configures the amount of time
- a handler can be pooled before it is scheduled for removal from the pool and disposal.
- </para>
- <para>
- Pooling of handlers is desirable as each handler typically manages its own underlying HTTP connections; creating
- more handlers than necessary can result in connection delays. Some handlers also keep connections open indefinitely
- which can prevent the handler from reacting to DNS changes. The value of <see cref="P:Microsoft.Extensions.Http.HttpClientFactoryOptions.HandlerLifetime"/> should be
- chosen with an understanding of the application's requirement to respond to changes in the network environment.
- </para>
- <para>
- Expiry of a handler will not immediately dispose the handler. An expired handler is placed in a separate pool
- which is processed at intervals to dispose handlers only when they become unreachable. Using long-lived
- <see cref="T:System.Net.Http.HttpClient"/> instances will prevent the underlying <see cref="T:System.Net.Http.HttpMessageHandler"/> from being
- disposed until all references are garbage-collected.
- </para>
- </remarks>
- </member>
- <member name="P:Microsoft.Extensions.Http.HttpClientFactoryOptions.ShouldRedactHeaderValue">
- <summary>
- The <see cref="T:System.Func`2"/> which determines whether to redact the HTTP header value before logging.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.Http.HttpClientFactoryOptions.SuppressHandlerScope">
- <summary>
- <para>
- Gets or sets a value that determines whether the <see cref="T:System.Net.Http.IHttpClientFactory"/> will
- create a dependency injection scope when building an <see cref="T:System.Net.Http.HttpMessageHandler"/>.
- If <c>false</c> (default), a scope will be created, otherwise a scope will not be created.
- </para>
- <para>
- This option is provided for compatibility with existing applications. It is recommended
- to use the default setting for new applications.
- </para>
- </summary>
- <remarks>
- <para>
- The <see cref="T:System.Net.Http.IHttpClientFactory"/> will (by default) create a dependency injection scope
- each time it creates an <see cref="T:System.Net.Http.HttpMessageHandler"/>. The created scope has the same
- lifetime as the message handler, and will be disposed when the message handler is disposed.
- </para>
- <para>
- When operations that are part of <see cref="P:Microsoft.Extensions.Http.HttpClientFactoryOptions.HttpMessageHandlerBuilderActions"/> are executed
- they will be provided with the scoped <see cref="T:System.IServiceProvider"/> via
- <see cref="P:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.Services"/>. This includes retrieving a message handler
- from dependency injection, such as one registered using
- <see cref="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddHttpMessageHandler``1(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder)"/>.
- </para>
- </remarks>
- </member>
- <member name="T:Microsoft.Extensions.Http.HttpMessageHandlerBuilder">
- <summary>
- A builder abstraction for configuring <see cref="T:System.Net.Http.HttpMessageHandler"/> instances.
- </summary>
- <remarks>
- The <see cref="T:Microsoft.Extensions.Http.HttpMessageHandlerBuilder"/> is registered in the service collection as
- a transient service. Callers should retrieve a new instance for each <see cref="T:System.Net.Http.HttpMessageHandler"/> to
- be created. Implementors should expect each instance to be used a single time.
- </remarks>
- </member>
- <member name="P:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.Name">
- <summary>
- Gets or sets the name of the <see cref="T:System.Net.Http.HttpClient"/> being created.
- </summary>
- <remarks>
- The <see cref="P:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.Name"/> is set by the <see cref="T:System.Net.Http.IHttpClientFactory"/> infrastructure
- and is public for unit testing purposes only. Setting the <see cref="P:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.Name"/> outside of
- testing scenarios may have unpredictable results.
- </remarks>
- </member>
- <member name="P:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.PrimaryHandler">
- <summary>
- Gets or sets the primary <see cref="T:System.Net.Http.HttpMessageHandler"/>.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.AdditionalHandlers">
- <summary>
- Gets a list of additional <see cref="T:System.Net.Http.DelegatingHandler"/> instances used to configure an
- <see cref="T:System.Net.Http.HttpClient"/> pipeline.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.Services">
- <summary>
- Gets an <see cref="T:System.IServiceProvider"/> which can be used to resolve services
- from the dependency injection container.
- </summary>
- <remarks>
- This property is sensitive to the value of
- <see cref="P:Microsoft.Extensions.Http.HttpClientFactoryOptions.SuppressHandlerScope"/>. If <c>true</c> this
- property will be a reference to the application's root service provider. If <c>false</c>
- (default) this will be a reference to a scoped service provider that has the same
- lifetime as the handler being created.
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.Build">
- <summary>
- Creates an <see cref="T:System.Net.Http.HttpMessageHandler"/>.
- </summary>
- <returns>
- An <see cref="T:System.Net.Http.HttpMessageHandler"/> built from the <see cref="P:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.PrimaryHandler"/> and
- <see cref="P:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.AdditionalHandlers"/>.
- </returns>
- </member>
- <member name="M:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.CreateHandlerPipeline(System.Net.Http.HttpMessageHandler,System.Collections.Generic.IEnumerable{System.Net.Http.DelegatingHandler})">
- <summary>
- Constructs an instance of <see cref="T:System.Net.Http.HttpMessageHandler"/> by chaining <paramref name="additionalHandlers"/> one after another with <paramref name="primaryHandler"/> in the
- end of the chain. The resulting pipeline is used by <see cref="T:System.Net.Http.IHttpClientFactory"/> infrastructure to create <see cref="T:System.Net.Http.HttpClient"/> instances with customized message
- handlers. The resulting pipeline can also be accessed by using <see cref="T:System.Net.Http.IHttpMessageHandlerFactory"/> instead of <see cref="T:System.Net.Http.IHttpClientFactory"/>.
- </summary>
- <param name="primaryHandler">An instance of <see cref="T:System.Net.Http.HttpMessageHandler"/> to operate at the bottom of the handler chain and actually handle the HTTP transport operations.</param>
- <param name="additionalHandlers">An ordered list of <see cref="T:System.Net.Http.DelegatingHandler"/> instances to be invoked as part
- of sending an <see cref="T:System.Net.Http.HttpRequestMessage"/> and receiving an <see cref="T:System.Net.Http.HttpResponseMessage"/>.
- The handlers are invoked in a top-down fashion. That is, the first entry is invoked first for
- an outbound request message but last for an inbound response message.</param>
- <returns>The HTTP message handler chain.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="primaryHandler "/> or <paramref name="additionalHandlers "/> is <see langword="null"/>.</exception>
- <exception cref="T:System.InvalidOperationException"><paramref name="additionalHandlers "/> contains a <see langword="null"/> entry.
- -or-
- The <c>DelegatingHandler.InnerHandler</c> property must be <see langword="null"/>. <c>DelegatingHandler</c> instances provided to <c>HttpMessageHandlerBuilder</c> must not be reused or cached.</exception>
- </member>
- <member name="T:Microsoft.Extensions.Http.IHttpMessageHandlerBuilderFilter">
- <summary>
- Used by the <see cref="T:Microsoft.Extensions.Http.DefaultHttpClientFactory"/> to apply additional initialization to the configure the
- <see cref="T:Microsoft.Extensions.Http.HttpMessageHandlerBuilder"/> immediately before <see cref="M:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.Build"/>
- is called.
- </summary>
- </member>
- <member name="M:Microsoft.Extensions.Http.IHttpMessageHandlerBuilderFilter.Configure(System.Action{Microsoft.Extensions.Http.HttpMessageHandlerBuilder})">
- <summary>
- Applies additional initialization to the <see cref="T:Microsoft.Extensions.Http.HttpMessageHandlerBuilder"/>
- </summary>
- <param name="next">A delegate which will run the next <see cref="T:Microsoft.Extensions.Http.IHttpMessageHandlerBuilderFilter"/>.</param>
- <returns>The configured <see cref="T:Microsoft.Extensions.Http.HttpMessageHandlerBuilder"/>.</returns>
- </member>
- <member name="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1">
- <summary>
- A factory abstraction for a component that can create typed client instances with custom
- configuration for a given logical name.
- </summary>
- <typeparam name="TClient">The type of typed client to create.</typeparam>
- <remarks>
- <para>
- The <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1"/> is infrastructure that supports the
- <see cref="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String)"/> and
- <see cref="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddTypedClient``1(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder)"/> functionality. This type
- should rarely be used directly in application code, use <see cref="M:System.IServiceProvider.GetService(System.Type)"/> instead
- to retrieve typed clients.
- </para>
- <para>
- A default <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1"/> can be registered in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>
- by calling <see cref="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient(Microsoft.Extensions.DependencyInjection.IServiceCollection)"/>.
- The default <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1"/> will be registered in the service collection as a singleton
- open-generic service.
- </para>
- <para>
- The default <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1"/> uses type activation to create typed client instances. Typed
- client types are not retrieved directly from the <see cref="T:System.IServiceProvider"/>. See
- <see cref="M:Microsoft.Extensions.DependencyInjection.ActivatorUtilities.CreateInstance(System.IServiceProvider,System.Type,System.Object[])" /> for details.
- </para>
- </remarks>
- <example>
- This sample shows the basic pattern for defining a typed client class.
- <code>
- class ExampleClient
- {
- private readonly HttpClient _httpClient;
- private readonly ILogger _logger;
-
- // typed clients can use constructor injection to access additional services
- public ExampleClient(HttpClient httpClient, ILogger<ExampleClient> logger)
- {
- _httpClient = httpClient;
- _logger = logger;
- }
-
- // typed clients can expose the HttpClient for application code to call directly
- public HttpClient HttpClient => _httpClient;
-
- // typed clients can also define methods that abstract usage of the HttpClient
- public async Task SendHelloRequest()
- {
- var response = await _httpClient.GetAsync("/helloworld");
- response.EnsureSuccessStatusCode();
- }
- }
- </code>
- </example>
- <example>
- This sample shows how to consume a typed client from an ASP.NET Core middleware.
- <code>
- // in Startup.cs
- public void Configure(IApplicationBuilder app, ExampleClient exampleClient)
- {
- app.Run(async (context) =>
- {
- var response = await _exampleClient.GetAsync("/helloworld");
- await context.Response.WriteAsync("Remote server said: ");
- await response.Content.CopyToAsync(context.Response.Body);
- });
- }
- </code>
- </example>
- <example>
- This sample shows how to consume a typed client from an ASP.NET Core MVC Controller.
- <code>
- // in Controllers/HomeController.cs
- public class HomeController : ControllerBase(IApplicationBuilder app, ExampleClient exampleClient)
- {
- private readonly ExampleClient _exampleClient;
-
- public HomeController(ExampleClient exampleClient)
- {
- _exampleClient = exampleClient;
- }
-
- public async Task<IActionResult> Index()
- {
- var response = await _exampleClient.GetAsync("/helloworld");
- var text = await response.Content.ReadAsStringAsync();
- return Content("Remote server said: " + text, "text/plain");
- };
- }
- </code>
- </example>
- </member>
- <member name="M:Microsoft.Extensions.Http.ITypedHttpClientFactory`1.CreateClient(System.Net.Http.HttpClient)">
- <summary>
- Creates a typed client given an associated <see cref="T:System.Net.Http.HttpClient"/>.
- </summary>
- <param name="httpClient">
- An <see cref="T:System.Net.Http.HttpClient"/> created by the <see cref="T:System.Net.Http.IHttpClientFactory"/> for the named client
- associated with <typeparamref name="TClient"/>.
- </param>
- <returns>An instance of <typeparamref name="TClient"/>.</returns>
- </member>
- <member name="T:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler">
- <summary>
- Handles logging of the lifecycle for an HTTP request.
- </summary>
- </member>
- <member name="M:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler.#ctor(Microsoft.Extensions.Logging.ILogger)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler"/> class with a specified logger.
- </summary>
- <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to log to.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="logger"/> is <see langword="null"/>.</exception>
- </member>
- <member name="M:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler.#ctor(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Http.HttpClientFactoryOptions)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler"/> class with a specified logger and options.
- </summary>
- <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to log to.</param>
- <param name="options">The <see cref="T:Microsoft.Extensions.Http.HttpClientFactoryOptions"/> used to configure the <see cref="T:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler"/> instance.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="logger"/> or <paramref name="options"/> is <see langword="null"/>.</exception>
- </member>
- <member name="M:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler.SendAsync(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)">
- <inheritdoc />
- <remarks>Loggs the request to and response from the sent <see cref="T:System.Net.Http.HttpRequestMessage"/>.</remarks>
- </member>
- <member name="T:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler">
- <summary>
- Handles logging of the lifecycle for an HTTP request within a log scope.
- </summary>
- </member>
- <member name="M:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler.#ctor(Microsoft.Extensions.Logging.ILogger)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler"/> class with a specified logger.
- </summary>
- <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to log to.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="logger"/> is <see langword="null"/>.</exception>
- </member>
- <member name="M:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler.#ctor(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Http.HttpClientFactoryOptions)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler"/> class with a specified logger and options.
- </summary>
- <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to log to.</param>
- <param name="options">The <see cref="T:Microsoft.Extensions.Http.HttpClientFactoryOptions"/> used to configure the <see cref="T:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler"/> instance.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="logger"/> or <paramref name="options"/> is <see langword="null"/>.</exception>
- </member>
- <member name="M:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler.SendAsync(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)">
- <inheritdoc />
- <remarks>Loggs the request to and response from the sent <see cref="T:System.Net.Http.HttpRequestMessage"/>.</remarks>
- </member>
- <member name="T:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions">
- <summary>
- Extension methods for configuring an <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>
- </summary>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.ConfigureHttpClient(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Action{System.Net.Http.HttpClient})">
- <summary>
- Adds a delegate that will be used to configure a named <see cref="T:System.Net.Http.HttpClient"/>.
- </summary>
- <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
- <param name="configureClient">A delegate that is used to configure an <see cref="T:System.Net.Http.HttpClient"/>.</param>
- <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.ConfigureHttpClient(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Action{System.IServiceProvider,System.Net.Http.HttpClient})">
- <summary>
- Adds a delegate that will be used to configure a named <see cref="T:System.Net.Http.HttpClient"/>.
- </summary>
- <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
- <param name="configureClient">A delegate that is used to configure an <see cref="T:System.Net.Http.HttpClient"/>.</param>
- <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- <remarks>
- The <see cref="T:System.IServiceProvider"/> provided to <paramref name="configureClient"/> will be the
- same application's root service provider instance.
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddHttpMessageHandler(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Func{System.Net.Http.DelegatingHandler})">
- <summary>
- Adds a delegate that will be used to create an additional message handler for a named <see cref="T:System.Net.Http.HttpClient"/>.
- </summary>
- <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
- <param name="configureHandler">A delegate that is used to create a <see cref="T:System.Net.Http.DelegatingHandler"/>.</param>
- <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- <remarks>
- The <see paramref="configureHandler"/> delegate should return a new instance of the message handler each time it
- is invoked.
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddHttpMessageHandler(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Func{System.IServiceProvider,System.Net.Http.DelegatingHandler})">
- <summary>
- Adds a delegate that will be used to create an additional message handler for a named <see cref="T:System.Net.Http.HttpClient"/>.
- </summary>
- <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
- <param name="configureHandler">A delegate that is used to create a <see cref="T:System.Net.Http.DelegatingHandler"/>.</param> /// <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- <remarks>
- <para>
- The <see paramref="configureHandler"/> delegate should return a new instance of the message handler each time it
- is invoked.
- </para>
- <para>
- The <see cref="T:System.IServiceProvider"/> argument provided to <paramref name="configureHandler"/> will be
- a reference to a scoped service provider that shares the lifetime of the handler being constructed.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddHttpMessageHandler``1(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder)">
- <summary>
- Adds an additional message handler from the dependency injection container for a named <see cref="T:System.Net.Http.HttpClient"/>.
- </summary>
- <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
- <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- <typeparam name="THandler">
- The type of the <see cref="T:System.Net.Http.DelegatingHandler"/>. The handler type must be registered as a transient service.
- </typeparam>
- <remarks>
- <para>
- The <typeparamref name="THandler"/> will be resolved from a scoped service provider that shares
- the lifetime of the handler being constructed.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.ConfigurePrimaryHttpMessageHandler(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Func{System.Net.Http.HttpMessageHandler})">
- <summary>
- Adds a delegate that will be used to configure the primary <see cref="T:System.Net.Http.HttpMessageHandler"/> for a
- named <see cref="T:System.Net.Http.HttpClient"/>.
- </summary>
- <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
- <param name="configureHandler">A delegate that is used to create an <see cref="T:System.Net.Http.HttpMessageHandler"/>.</param>
- <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- <remarks>
- The <see paramref="configureHandler"/> delegate should return a new instance of the message handler each time it
- is invoked.
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.ConfigurePrimaryHttpMessageHandler(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Func{System.IServiceProvider,System.Net.Http.HttpMessageHandler})">
- <summary>
- Adds a delegate that will be used to configure the primary <see cref="T:System.Net.Http.HttpMessageHandler"/> for a
- named <see cref="T:System.Net.Http.HttpClient"/>.
- </summary>
- <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
- <param name="configureHandler">A delegate that is used to create an <see cref="T:System.Net.Http.HttpMessageHandler"/>.</param>
- <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- <remarks>
- <para>
- The <see paramref="configureHandler"/> delegate should return a new instance of the message handler each time it
- is invoked.
- </para>
- <para>
- The <see cref="T:System.IServiceProvider"/> argument provided to <paramref name="configureHandler"/> will be
- a reference to a scoped service provider that shares the lifetime of the handler being constructed.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.ConfigurePrimaryHttpMessageHandler``1(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder)">
- <summary>
- Configures the primary <see cref="T:System.Net.Http.HttpMessageHandler"/> from the dependency injection container
- for a named <see cref="T:System.Net.Http.HttpClient"/>.
- </summary>
- <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
- <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- <typeparam name="THandler">
- The type of the <see cref="T:System.Net.Http.DelegatingHandler"/>. The handler type must be registered as a transient service.
- </typeparam>
- <remarks>
- <para>
- The <typeparamref name="THandler"/> will be resolved from a scoped service provider that shares
- the lifetime of the handler being constructed.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.ConfigureHttpMessageHandlerBuilder(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Action{Microsoft.Extensions.Http.HttpMessageHandlerBuilder})">
- <summary>
- Adds a delegate that will be used to configure message handlers using <see cref="T:Microsoft.Extensions.Http.HttpMessageHandlerBuilder"/>
- for a named <see cref="T:System.Net.Http.HttpClient"/>.
- </summary>
- <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
- <param name="configureBuilder">A delegate that is used to configure an <see cref="T:Microsoft.Extensions.Http.HttpMessageHandlerBuilder"/>.</param>
- <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddTypedClient``1(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder)">
- <summary>
- Configures a binding between the <typeparamref name="TClient" /> type and the named <see cref="T:System.Net.Http.HttpClient"/>
- associated with the <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.
- </summary>
- <typeparam name="TClient">
- The type of the typed client. The type specified will be registered in the service collection as
- a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
- </typeparam>
- <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
- <remarks>
- <para>
- <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
- can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
- <typeparamref name="TClient"/> as the service type.
- </para>
- <para>
- Calling <see cref="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddTypedClient``1(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder)"/> will register a typed
- client binding that creates <typeparamref name="TClient"/> using the <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" />.
- </para>
- <para>
- The typed client's service dependencies will be resolved from the same service provider
- that is used to resolve the typed client. It is not possible to access services from the
- scope bound to the message handler, which is managed independently.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddTypedClient``2(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder)">
- <summary>
- Configures a binding between the <typeparamref name="TClient" /> type and the named <see cref="T:System.Net.Http.HttpClient"/>
- associated with the <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>. The created instances will be of type
- <typeparamref name="TImplementation"/>.
- </summary>
- <typeparam name="TClient">
- The declared type of the typed client. They type specified will be registered in the service collection as
- a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
- </typeparam>
- <typeparam name="TImplementation">
- The implementation type of the typed client. The type specified by will be instantiated by the
- <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1"/>.
- </typeparam>
- <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
- <remarks>
- <para>
- <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
- can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
- <typeparamref name="TClient"/> as the service type.
- </para>
- <para>
- Calling <see cref="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddTypedClient``2(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder)"/>
- will register a typed client binding that creates <typeparamref name="TImplementation"/> using the
- <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" />.
- </para>
- <para>
- The typed client's service dependencies will be resolved from the same service provider
- that is used to resolve the typed client. It is not possible to access services from the
- scope bound to the message handler, which is managed independently.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddTypedClient``1(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Func{System.Net.Http.HttpClient,``0})">
- <summary>
- Configures a binding between the <typeparamref name="TClient" /> type and the named <see cref="T:System.Net.Http.HttpClient"/>
- associated with the <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.
- </summary>
- <typeparam name="TClient">
- The type of the typed client. They type specified will be registered in the service collection as
- a transient service.
- </typeparam>
- <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
- <param name="factory">A factory function that will be used to construct the typed client.</param>
- <remarks>
- <para>
- <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
- can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
- <typeparamref name="TClient"/> as the service type.
- </para>
- <para>
- Calling <see cref="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddTypedClient``1(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Func{System.Net.Http.HttpClient,``0})"/>
- will register a typed client binding that creates <typeparamref name="TClient"/> using the provided factory function.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddTypedClient``1(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Func{System.Net.Http.HttpClient,System.IServiceProvider,``0})">
- <summary>
- Configures a binding between the <typeparamref name="TClient" /> type and the named <see cref="T:System.Net.Http.HttpClient"/>
- associated with the <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.
- </summary>
- <typeparam name="TClient">
- The type of the typed client. They type specified will be registered in the service collection as
- a transient service.
- </typeparam>
- <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
- <param name="factory">A factory function that will be used to construct the typed client.</param>
- <remarks>
- <para>
- <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
- can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
- <typeparamref name="TClient"/> as the service type.
- </para>
- <para>
- Calling <see cref="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddTypedClient``1(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Func{System.Net.Http.HttpClient,System.IServiceProvider,``0})"/>
- will register a typed client binding that creates <typeparamref name="TClient"/> using the provided factory function.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.RedactLoggedHeaders(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Func{System.String,System.Boolean})">
- <summary>
- Sets the <see cref="T:System.Func`2"/> which determines whether to redact the HTTP header value before logging.
- </summary>
- <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
- <param name="shouldRedactHeaderValue">The <see cref="T:System.Func`2"/> which determines whether to redact the HTTP header value before logging.</param>
- <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</returns>
- <remarks>The provided <paramref name="shouldRedactHeaderValue"/> predicate will be evaluated for each header value when logging. If the predicate returns <c>true</c> then the header value will be replaced with a marker value <c>*</c> in logs; otherwise the header value will be logged.
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.RedactLoggedHeaders(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Collections.Generic.IEnumerable{System.String})">
- <summary>
- Sets the collection of HTTP headers names for which values should be redacted before logging.
- </summary>
- <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
- <param name="redactedLoggedHeaderNames">The collection of HTTP headers names for which values should be redacted before logging.</param>
- <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</returns>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.SetHandlerLifetime(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.TimeSpan)">
- <summary>
- Sets the length of time that a <see cref="T:System.Net.Http.HttpMessageHandler"/> instance can be reused. Each named
- client can have its own configured handler lifetime value. The default value is two minutes. Set the lifetime to
- <see cref="F:System.Threading.Timeout.InfiniteTimeSpan"/> to disable handler expiry.
- </summary>
- <remarks>
- <para>
- The default implementation of <see cref="T:System.Net.Http.IHttpClientFactory"/> will pool the <see cref="T:System.Net.Http.HttpMessageHandler"/>
- instances created by the factory to reduce resource consumption. This setting configures the amount of time
- a handler can be pooled before it is scheduled for removal from the pool and disposal.
- </para>
- <para>
- Pooling of handlers is desirable as each handler typically manages its own underlying HTTP connections; creating
- more handlers than necessary can result in connection delays. Some handlers also keep connections open indefinitely
- which can prevent the handler from reacting to DNS changes. The value of <paramref name="handlerLifetime"/> should be
- chosen with an understanding of the application's requirement to respond to changes in the network environment.
- </para>
- <para>
- Expiry of a handler will not immediately dispose the handler. An expired handler is placed in a separate pool
- which is processed at intervals to dispose handlers only when they become unreachable. Using long-lived
- <see cref="T:System.Net.Http.HttpClient"/> instances will prevent the underlying <see cref="T:System.Net.Http.HttpMessageHandler"/> from being
- disposed until all references are garbage-collected.
- </para>
- </remarks>
- </member>
- <member name="T:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions">
- <summary>
- Extension methods to configure an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> for <see cref="T:System.Net.Http.IHttpClientFactory"/>.
- </summary>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
- <summary>
- Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.
- </summary>
- <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
- <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</returns>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String)">
- <summary>
- Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
- a named <see cref="T:System.Net.Http.HttpClient"/>.
- </summary>
- <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
- <param name="name">The logical name of the <see cref="T:System.Net.Http.HttpClient"/> to configure.</param>
- <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- <remarks>
- <para>
- <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
- <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
- </para>
- <para>
- Use <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/> as the name to configure the default client.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.Action{System.Net.Http.HttpClient})">
- <summary>
- Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
- a named <see cref="T:System.Net.Http.HttpClient"/>.
- </summary>
- <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
- <param name="name">The logical name of the <see cref="T:System.Net.Http.HttpClient"/> to configure.</param>
- <param name="configureClient">A delegate that is used to configure an <see cref="T:System.Net.Http.HttpClient"/>.</param>
- <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- <remarks>
- <para>
- <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
- <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
- </para>
- <para>
- Use <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/> as the name to configure the default client.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.Action{System.IServiceProvider,System.Net.Http.HttpClient})">
- <summary>
- Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
- a named <see cref="T:System.Net.Http.HttpClient"/>.
- </summary>
- <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
- <param name="name">The logical name of the <see cref="T:System.Net.Http.HttpClient"/> to configure.</param>
- <param name="configureClient">A delegate that is used to configure an <see cref="T:System.Net.Http.HttpClient"/>.</param>
- <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- <remarks>
- <para>
- <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
- <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
- </para>
- <para>
- Use <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/> as the name to configure the default client.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``1(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
- <summary>
- Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
- a binding between the <typeparamref name="TClient"/> type and a named <see cref="T:System.Net.Http.HttpClient"/>. The client name
- will be set to the type name of <typeparamref name="TClient"/>.
- </summary>
- <typeparam name="TClient">
- The type of the typed client. The type specified will be registered in the service collection as
- a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
- </typeparam>
- <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
- <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- <remarks>
- <para>
- <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
- <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
- </para>
- <para>
- <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
- can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
- <typeparamref name="TClient"/> as the service type.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``2(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
- <summary>
- Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
- a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>. The client name will
- be set to the type name of <typeparamref name="TClient"/>.
- </summary>
- <typeparam name="TClient">
- The type of the typed client. The type specified will be registered in the service collection as
- a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
- </typeparam>
- <typeparam name="TImplementation">
- The implementation type of the typed client. The type specified will be instantiated by the
- <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1"/>
- </typeparam>
- <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
- <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- <remarks>
- <para>
- <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
- <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
- </para>
- <para>
- <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
- can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
- <typeparamref name="TClient"/> as the service type.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String)">
- <summary>
- Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
- a binding between the <typeparamref name="TClient"/> type and a named <see cref="T:System.Net.Http.HttpClient"/>.
- </summary>
- <typeparam name="TClient">
- The type of the typed client. The type specified will be registered in the service collection as
- a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
- </typeparam>
- <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
- <param name="name">The logical name of the <see cref="T:System.Net.Http.HttpClient"/> to configure.</param>
- <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- <remarks>
- <para>
- <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
- <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
- </para>
- <para>
- <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
- can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
- <typeparamref name="TClient"/> as the service type.
- </para>
- <para>
- Use <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/> as the name to configure the default client.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``2(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String)">
- <summary>
- Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
- a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>.
- </summary>
- <typeparam name="TClient">
- The type of the typed client. The type specified will be registered in the service collection as
- a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
- </typeparam>
- <typeparam name="TImplementation">
- The implementation type of the typed client. The type specified will be instantiated by the
- <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1"/>
- </typeparam>
- <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
- <param name="name">The logical name of the <see cref="T:System.Net.Http.HttpClient"/> to configure.</param>
- <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- <remarks>
- <para>
- <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
- <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
- </para>
- <para>
- <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
- can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
- <typeparamref name="TClient"/> as the service type.
- </para>
- <para>
- Use <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/> as the name to configure the default client.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{System.Net.Http.HttpClient})">
- <summary>
- Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
- a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>. The client name will
- be set to the type name of <typeparamref name="TClient"/>.
- </summary>
- <typeparam name="TClient">
- The type of the typed client. The type specified will be registered in the service collection as
- a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
- </typeparam>
- <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
- <param name="configureClient">A delegate that is used to configure an <see cref="T:System.Net.Http.HttpClient"/>.</param>
- <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- <remarks>
- <para>
- <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
- <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
- </para>
- <para>
- <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
- can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
- <typeparamref name="TClient"/> as the service type.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{System.IServiceProvider,System.Net.Http.HttpClient})">
- <summary>
- Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
- a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>. The client name will
- be set to the type name of <typeparamref name="TClient"/>.
- </summary>
- <typeparam name="TClient">
- The type of the typed client. The type specified will be registered in the service collection as
- a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
- </typeparam>
- <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
- <param name="configureClient">A delegate that is used to configure an <see cref="T:System.Net.Http.HttpClient"/>.</param>
- <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- <remarks>
- <para>
- <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
- <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
- </para>
- <para>
- <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
- can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
- <typeparamref name="TClient"/> as the service type.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``2(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{System.Net.Http.HttpClient})">
- <summary>
- Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
- a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>. The client name will
- be set to the type name of <typeparamref name="TClient"/>.
- </summary>
- <typeparam name="TClient">
- The type of the typed client. The type specified will be registered in the service collection as
- a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
- </typeparam>
- <typeparam name="TImplementation">
- The implementation type of the typed client. The type specified will be instantiated by the
- <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1"/>
- </typeparam>
- <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
- <param name="configureClient">A delegate that is used to configure an <see cref="T:System.Net.Http.HttpClient"/>.</param>
- <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- <remarks>
- <para>
- <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
- <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
- </para>
- <para>
- <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
- can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
- <typeparamref name="TClient"/> as the service type.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``2(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{System.IServiceProvider,System.Net.Http.HttpClient})">
- <summary>
- Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
- a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>. The client name will
- be set to the type name of <typeparamref name="TClient"/>.
- </summary>
- <typeparam name="TClient">
- The type of the typed client. The type specified will be registered in the service collection as
- a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
- </typeparam>
- <typeparam name="TImplementation">
- The implementation type of the typed client. The type specified will be instantiated by the
- <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1"/>
- </typeparam>
- <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
- <param name="configureClient">A delegate that is used to configure an <see cref="T:System.Net.Http.HttpClient"/>.</param>
- <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- <remarks>
- <para>
- <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
- <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
- </para>
- <para>
- <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
- can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
- <typeparamref name="TClient"/> as the service type.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.Action{System.Net.Http.HttpClient})">
- <summary>
- Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
- a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>.
- </summary>
- <typeparam name="TClient">
- The type of the typed client. The type specified will be registered in the service collection as
- a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
- </typeparam>
- <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
- <param name="name">The logical name of the <see cref="T:System.Net.Http.HttpClient"/> to configure.</param>
- <param name="configureClient">A delegate that is used to configure an <see cref="T:System.Net.Http.HttpClient"/>.</param>
- <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- <remarks>
- <para>
- <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
- <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
- </para>
- <para>
- <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
- can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
- <typeparamref name="TClient"/> as the service type.
- </para>
- <para>
- Use <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/> as the name to configure the default client.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.Action{System.IServiceProvider,System.Net.Http.HttpClient})">
- <summary>
- Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
- a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>.
- </summary>
- <typeparam name="TClient">
- The type of the typed client. The type specified will be registered in the service collection as
- a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
- </typeparam>
- <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
- <param name="name">The logical name of the <see cref="T:System.Net.Http.HttpClient"/> to configure.</param>
- <param name="configureClient">A delegate that is used to configure an <see cref="T:System.Net.Http.HttpClient"/>.</param>
- <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- <remarks>
- <para>
- <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
- <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
- </para>
- <para>
- <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
- can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
- <typeparamref name="TClient"/> as the service type.
- </para>
- <para>
- Use <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/> as the name to configure the default client.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``2(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.Action{System.Net.Http.HttpClient})">
- <summary>
- Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
- a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>.
- </summary>
- <typeparam name="TClient">
- The type of the typed client. The type specified will be registered in the service collection as
- a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
- </typeparam>
- <typeparam name="TImplementation">
- The implementation type of the typed client. The type specified will be instantiated by the
- <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1"/>
- </typeparam>
- <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
- <param name="name">The logical name of the <see cref="T:System.Net.Http.HttpClient"/> to configure.</param>
- <param name="configureClient">A delegate that is used to configure an <see cref="T:System.Net.Http.HttpClient"/>.</param>
- <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- <remarks>
- <para>
- <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
- <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
- </para>
- <para>
- <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
- can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
- <typeparamref name="TClient"/> as the service type.
- </para>
- <para>
- Use <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/> as the name to configure the default client.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``2(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.Action{System.IServiceProvider,System.Net.Http.HttpClient})">
- <summary>
- Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
- a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>.
- </summary>
- <typeparam name="TClient">
- The type of the typed client. The type specified will be registered in the service collection as
- a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
- </typeparam>
- <typeparam name="TImplementation">
- The implementation type of the typed client. The type specified will be instantiated by the
- <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1"/>
- </typeparam>
- <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
- <param name="name">The logical name of the <see cref="T:System.Net.Http.HttpClient"/> to configure.</param>
- <param name="configureClient">A delegate that is used to configure an <see cref="T:System.Net.Http.HttpClient"/>.</param>
- <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- <remarks>
- <para>
- <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
- <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
- </para>
- <para>
- <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
- can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
- <typeparamref name="TClient"/> as the service type.
- </para>
- <para>
- Use <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/> as the name to configure the default client.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``2(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Func{System.Net.Http.HttpClient,``1})">
- <summary>
- Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
- a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>.
- </summary>
- <typeparam name="TClient">
- The type of the typed client. The type specified will be registered in the service collection as
- a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
- </typeparam>
- <typeparam name="TImplementation">
- The implementation type of the typed client.
- </typeparam>
- <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
- <param name="factory">A delegate that is used to create an instance of <typeparamref name="TClient"/>.</param>
- <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- <remarks>
- <para>
- <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
- <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
- </para>
- <para>
- <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
- can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
- <typeparamref name="TClient"/> as the service type.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``2(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.Func{System.Net.Http.HttpClient,``1})">
- <summary>
- Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
- a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>.
- </summary>
- <typeparam name="TClient">
- The type of the typed client. The type specified will be registered in the service collection as
- a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
- </typeparam>
- <typeparam name="TImplementation">
- The implementation type of the typed client.
- </typeparam>
- <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
- <param name="name">The logical name of the <see cref="T:System.Net.Http.HttpClient"/> to configure.</param>
- <param name="factory">A delegate that is used to create an instance of <typeparamref name="TClient"/>.</param>
- <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- <remarks>
- <para>
- <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
- <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
- </para>
- <para>
- <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
- can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
- <typeparamref name="TClient"/> as the service type.
- </para>
- <typeparamref name="TImplementation">
- </typeparamref>
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``2(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Func{System.Net.Http.HttpClient,System.IServiceProvider,``1})">
- <summary>
- Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
- a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>.
- </summary>
- <typeparam name="TClient">
- The type of the typed client. The type specified will be registered in the service collection as
- a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
- </typeparam>
- <typeparam name="TImplementation">
- The implementation type of the typed client.
- </typeparam>
- <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
- <param name="factory">A delegate that is used to create an instance of <typeparamref name="TClient"/>.</param>
- <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- <remarks>
- <para>
- <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
- <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
- </para>
- <para>
- <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
- can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
- <typeparamref name="TClient"/> as the service type.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``2(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.Func{System.Net.Http.HttpClient,System.IServiceProvider,``1})">
- <summary>
- Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
- a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>.
- </summary>
- <typeparam name="TClient">
- The type of the typed client. The type specified will be registered in the service collection as
- a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
- </typeparam>
- <typeparam name="TImplementation">
- The implementation type of the typed client.
- </typeparam>
- <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
- <param name="name">The logical name of the <see cref="T:System.Net.Http.HttpClient"/> to configure.</param>
- <param name="factory">A delegate that is used to create an instance of <typeparamref name="TClient"/>.</param>
- <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
- <remarks>
- <para>
- <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
- <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
- </para>
- <para>
- <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
- can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
- <typeparamref name="TClient"/> as the service type.
- </para>
- </remarks>
- </member>
- <member name="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder">
- <summary>
- A builder for configuring named <see cref="T:System.Net.Http.HttpClient"/> instances returned by <see cref="T:System.Net.Http.IHttpClientFactory"/>.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder.Name">
- <summary>
- Gets the name of the client configured by this builder.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder.Services">
- <summary>
- Gets the application service collection.
- </summary>
- </member>
- <member name="M:Microsoft.Extensions.Internal.TypeNameHelper.GetTypeDisplayName(System.Type,System.Boolean,System.Boolean,System.Boolean,System.Char)">
- <summary>
- Pretty print a type name.
- </summary>
- <param name="type">The <see cref="T:System.Type"/>.</param>
- <param name="fullName"><c>true</c> to print a fully qualified name.</param>
- <param name="includeGenericParameterNames"><c>true</c> to include generic parameter names.</param>
- <param name="includeGenericParameters"><c>true</c> to include generic parameters.</param>
- <param name="nestedTypeDelimiter">Character to use as a delimiter in nested type names</param>
- <returns>The pretty printed type name.</returns>
- </member>
- <member name="T:System.Net.Http.HttpClientFactoryExtensions">
- <summary>
- Extensions methods for <see cref="T:System.Net.Http.IHttpClientFactory"/>.
- </summary>
- </member>
- <member name="M:System.Net.Http.HttpClientFactoryExtensions.CreateClient(System.Net.Http.IHttpClientFactory)">
- <summary>
- Creates a new <see cref="T:System.Net.Http.HttpClient"/> using the default configuration.
- </summary>
- <param name="factory">The <see cref="T:System.Net.Http.IHttpClientFactory"/>.</param>
- <returns>An <see cref="T:System.Net.Http.HttpClient"/> configured using the default configuration.</returns>
- </member>
- <member name="T:System.Net.Http.HttpMessageHandlerFactoryExtensions">
- <summary>
- Extensions methods for <see cref="T:System.Net.Http.IHttpMessageHandlerFactory"/>.
- </summary>
- </member>
- <member name="M:System.Net.Http.HttpMessageHandlerFactoryExtensions.CreateHandler(System.Net.Http.IHttpMessageHandlerFactory)">
- <summary>
- Creates a new <see cref="T:System.Net.Http.HttpMessageHandler"/> using the default configuration.
- </summary>
- <param name="factory">The <see cref="T:System.Net.Http.IHttpMessageHandlerFactory"/>.</param>
- <returns>An <see cref="T:System.Net.Http.HttpMessageHandler"/> configured using the default configuration.</returns>
- </member>
- <member name="T:System.Net.Http.IHttpClientFactory">
- <summary>
- A factory abstraction for a component that can create <see cref="T:System.Net.Http.HttpClient"/> instances with custom
- configuration for a given logical name.
- </summary>
- <remarks>
- A default <see cref="T:System.Net.Http.IHttpClientFactory"/> can be registered in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>
- by calling <see cref="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient(Microsoft.Extensions.DependencyInjection.IServiceCollection)"/>.
- The default <see cref="T:System.Net.Http.IHttpClientFactory"/> will be registered in the service collection as a singleton.
- </remarks>
- </member>
- <member name="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)">
- <summary>
- Creates and configures an <see cref="T:System.Net.Http.HttpClient"/> instance using the configuration that corresponds
- to the logical name specified by <paramref name="name"/>.
- </summary>
- <param name="name">The logical name of the client to create.</param>
- <returns>A new <see cref="T:System.Net.Http.HttpClient"/> instance.</returns>
- <remarks>
- <para>
- Each call to <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> is guaranteed to return a new <see cref="T:System.Net.Http.HttpClient"/>
- instance. It is generally not necessary to dispose of the <see cref="T:System.Net.Http.HttpClient"/> as the
- <see cref="T:System.Net.Http.IHttpClientFactory"/> tracks and disposes resources used by the <see cref="T:System.Net.Http.HttpClient"/>.
- </para>
- <para>
- Callers are also free to mutate the returned <see cref="T:System.Net.Http.HttpClient"/> instance's public properties
- as desired.
- </para>
- </remarks>
- </member>
- <member name="T:System.Net.Http.IHttpMessageHandlerFactory">
- <summary>
- A factory abstraction for a component that can create <see cref="T:System.Net.Http.HttpMessageHandler"/> instances with custom
- configuration for a given logical name.
- </summary>
- <remarks>
- A default <see cref="T:System.Net.Http.IHttpMessageHandlerFactory"/> can be registered in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>
- by calling <see cref="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient(Microsoft.Extensions.DependencyInjection.IServiceCollection)"/>.
- The default <see cref="T:System.Net.Http.IHttpMessageHandlerFactory"/> will be registered in the service collection as a singleton.
- </remarks>
- </member>
- <member name="M:System.Net.Http.IHttpMessageHandlerFactory.CreateHandler(System.String)">
- <summary>
- Creates and configures an <see cref="T:System.Net.Http.HttpMessageHandler"/> instance using the configuration that corresponds
- to the logical name specified by <paramref name="name"/>.
- </summary>
- <param name="name">The logical name of the message handler to create.</param>
- <returns>A new <see cref="T:System.Net.Http.HttpMessageHandler"/> instance.</returns>
- <remarks>
- <para>
- The default <see cref="T:System.Net.Http.IHttpMessageHandlerFactory"/> implementation may cache the underlying
- <see cref="T:System.Net.Http.HttpMessageHandler"/> instances to improve performance.
- </para>
- <para>
- The default <see cref="T:System.Net.Http.IHttpMessageHandlerFactory"/> implementation also manages the lifetime of the
- handler created, so disposing of the <see cref="T:System.Net.Http.HttpMessageHandler"/> returned by this method may
- have no effect.
- </para>
- </remarks>
- </member>
- <member name="M:System.ThrowHelper.ThrowIfNull(System.Object,System.String)">
- <summary>Throws an <see cref="T:System.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary>
- <param name="argument">The reference type argument to validate as non-null.</param>
- <param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param>
- </member>
- <member name="P:System.SR.HttpMessageHandlerBuilder_AdditionalHandlerIsNull">
- <summary>The '{0}' must not contain a null entry.</summary>
- </member>
- <member name="P:System.SR.HttpMessageHandlerBuilder_AdditionHandlerIsInvalid">
- <summary>The '{0}' property must be null. '{1}' instances provided to '{2}' must not be reused or cached.{3}Handler: '{4}'</summary>
- </member>
- <member name="P:System.SR.HttpMessageHandlerBuilder_PrimaryHandlerIsNull">
- <summary>The '{0}' must not be null.</summary>
- </member>
- <member name="P:System.SR.HandlerLifetime_InvalidValue">
- <summary>The handler lifetime must be at least 1 second.</summary>
- </member>
- <member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
- <summary>
- Attribute used to indicate a source generator should create a function for marshalling
- arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
- </summary>
- <remarks>
- This attribute is meaningless if the source generator associated with it is not enabled.
- The current built-in source generator only supports C# and only supplies an implementation when
- applied to static, partial, non-generic methods.
- </remarks>
- </member>
- <member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
- </summary>
- <param name="libraryName">Name of the library containing the import.</param>
- </member>
- <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
- <summary>
- Gets the name of the library containing the import.
- </summary>
- </member>
- <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
- <summary>
- Gets or sets the name of the entry point to be called.
- </summary>
- </member>
- <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
- <summary>
- Gets or sets how to marshal string arguments to the method.
- </summary>
- <remarks>
- If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
- <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
- </remarks>
- </member>
- <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
- <summary>
- Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
- </summary>
- <remarks>
- If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
- or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
- </remarks>
- </member>
- <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
- <summary>
- Gets or sets whether the callee sets an error (SetLastError on Windows or errno
- on other platforms) before returning from the attributed method.
- </summary>
- </member>
- <member name="T:System.Runtime.InteropServices.StringMarshalling">
- <summary>
- Specifies how strings should be marshalled for generated p/invokes
- </summary>
- </member>
- <member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
- <summary>
- Indicates the user is suppling a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
- </summary>
- </member>
- <member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
- <summary>
- Use the platform-provided UTF-8 marshaller.
- </summary>
- </member>
- <member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
- <summary>
- Use the platform-provided UTF-16 marshaller.
- </summary>
- </member>
- </members>
- </doc>
|