Microsoft.Extensions.Http.xml 115 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.Http</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.Http.HttpClientFactoryOptions">
  8. <summary>
  9. An options class for configuring the default <see cref="T:System.Net.Http.IHttpClientFactory"/>.
  10. </summary>
  11. </member>
  12. <member name="P:Microsoft.Extensions.Http.HttpClientFactoryOptions.HttpMessageHandlerBuilderActions">
  13. <summary>
  14. Gets a list of operations used to configure an <see cref="T:Microsoft.Extensions.Http.HttpMessageHandlerBuilder"/>.
  15. </summary>
  16. </member>
  17. <member name="P:Microsoft.Extensions.Http.HttpClientFactoryOptions.HttpClientActions">
  18. <summary>
  19. Gets a list of operations used to configure an <see cref="T:System.Net.Http.HttpClient"/>.
  20. </summary>
  21. </member>
  22. <member name="P:Microsoft.Extensions.Http.HttpClientFactoryOptions.HandlerLifetime">
  23. <summary>
  24. Gets or sets the length of time that a <see cref="T:System.Net.Http.HttpMessageHandler"/> instance can be reused. Each named
  25. client can have its own configured handler lifetime value. The default value of this property is two minutes.
  26. Set the lifetime to <see cref="F:System.Threading.Timeout.InfiniteTimeSpan"/> to disable handler expiry.
  27. </summary>
  28. <remarks>
  29. <para>
  30. The default implementation of <see cref="T:System.Net.Http.IHttpClientFactory"/> will pool the <see cref="T:System.Net.Http.HttpMessageHandler"/>
  31. instances created by the factory to reduce resource consumption. This setting configures the amount of time
  32. a handler can be pooled before it is scheduled for removal from the pool and disposal.
  33. </para>
  34. <para>
  35. Pooling of handlers is desirable as each handler typically manages its own underlying HTTP connections; creating
  36. more handlers than necessary can result in connection delays. Some handlers also keep connections open indefinitely
  37. which can prevent the handler from reacting to DNS changes. The value of <see cref="P:Microsoft.Extensions.Http.HttpClientFactoryOptions.HandlerLifetime"/> should be
  38. chosen with an understanding of the application's requirement to respond to changes in the network environment.
  39. </para>
  40. <para>
  41. Expiry of a handler will not immediately dispose the handler. An expired handler is placed in a separate pool
  42. which is processed at intervals to dispose handlers only when they become unreachable. Using long-lived
  43. <see cref="T:System.Net.Http.HttpClient"/> instances will prevent the underlying <see cref="T:System.Net.Http.HttpMessageHandler"/> from being
  44. disposed until all references are garbage-collected.
  45. </para>
  46. </remarks>
  47. </member>
  48. <member name="P:Microsoft.Extensions.Http.HttpClientFactoryOptions.ShouldRedactHeaderValue">
  49. <summary>
  50. The <see cref="T:System.Func`2"/> which determines whether to redact the HTTP header value before logging.
  51. </summary>
  52. </member>
  53. <member name="P:Microsoft.Extensions.Http.HttpClientFactoryOptions.SuppressHandlerScope">
  54. <summary>
  55. <para>
  56. Gets or sets a value that determines whether the <see cref="T:System.Net.Http.IHttpClientFactory"/> will
  57. create a dependency injection scope when building an <see cref="T:System.Net.Http.HttpMessageHandler"/>.
  58. If <c>false</c> (default), a scope will be created, otherwise a scope will not be created.
  59. </para>
  60. <para>
  61. This option is provided for compatibility with existing applications. It is recommended
  62. to use the default setting for new applications.
  63. </para>
  64. </summary>
  65. <remarks>
  66. <para>
  67. The <see cref="T:System.Net.Http.IHttpClientFactory"/> will (by default) create a dependency injection scope
  68. each time it creates an <see cref="T:System.Net.Http.HttpMessageHandler"/>. The created scope has the same
  69. lifetime as the message handler, and will be disposed when the message handler is disposed.
  70. </para>
  71. <para>
  72. When operations that are part of <see cref="P:Microsoft.Extensions.Http.HttpClientFactoryOptions.HttpMessageHandlerBuilderActions"/> are executed
  73. they will be provided with the scoped <see cref="T:System.IServiceProvider"/> via
  74. <see cref="P:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.Services"/>. This includes retrieving a message handler
  75. from dependency injection, such as one registered using
  76. <see cref="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddHttpMessageHandler``1(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder)"/>.
  77. </para>
  78. </remarks>
  79. </member>
  80. <member name="T:Microsoft.Extensions.Http.HttpMessageHandlerBuilder">
  81. <summary>
  82. A builder abstraction for configuring <see cref="T:System.Net.Http.HttpMessageHandler"/> instances.
  83. </summary>
  84. <remarks>
  85. The <see cref="T:Microsoft.Extensions.Http.HttpMessageHandlerBuilder"/> is registered in the service collection as
  86. a transient service. Callers should retrieve a new instance for each <see cref="T:System.Net.Http.HttpMessageHandler"/> to
  87. be created. Implementors should expect each instance to be used a single time.
  88. </remarks>
  89. </member>
  90. <member name="P:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.Name">
  91. <summary>
  92. Gets or sets the name of the <see cref="T:System.Net.Http.HttpClient"/> being created.
  93. </summary>
  94. <remarks>
  95. The <see cref="P:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.Name"/> is set by the <see cref="T:System.Net.Http.IHttpClientFactory"/> infrastructure
  96. and is public for unit testing purposes only. Setting the <see cref="P:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.Name"/> outside of
  97. testing scenarios may have unpredictable results.
  98. </remarks>
  99. </member>
  100. <member name="P:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.PrimaryHandler">
  101. <summary>
  102. Gets or sets the primary <see cref="T:System.Net.Http.HttpMessageHandler"/>.
  103. </summary>
  104. </member>
  105. <member name="P:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.AdditionalHandlers">
  106. <summary>
  107. Gets a list of additional <see cref="T:System.Net.Http.DelegatingHandler"/> instances used to configure an
  108. <see cref="T:System.Net.Http.HttpClient"/> pipeline.
  109. </summary>
  110. </member>
  111. <member name="P:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.Services">
  112. <summary>
  113. Gets an <see cref="T:System.IServiceProvider"/> which can be used to resolve services
  114. from the dependency injection container.
  115. </summary>
  116. <remarks>
  117. This property is sensitive to the value of
  118. <see cref="P:Microsoft.Extensions.Http.HttpClientFactoryOptions.SuppressHandlerScope"/>. If <c>true</c> this
  119. property will be a reference to the application's root service provider. If <c>false</c>
  120. (default) this will be a reference to a scoped service provider that has the same
  121. lifetime as the handler being created.
  122. </remarks>
  123. </member>
  124. <member name="M:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.Build">
  125. <summary>
  126. Creates an <see cref="T:System.Net.Http.HttpMessageHandler"/>.
  127. </summary>
  128. <returns>
  129. An <see cref="T:System.Net.Http.HttpMessageHandler"/> built from the <see cref="P:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.PrimaryHandler"/> and
  130. <see cref="P:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.AdditionalHandlers"/>.
  131. </returns>
  132. </member>
  133. <member name="M:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.CreateHandlerPipeline(System.Net.Http.HttpMessageHandler,System.Collections.Generic.IEnumerable{System.Net.Http.DelegatingHandler})">
  134. <summary>
  135. 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
  136. 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
  137. 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"/>.
  138. </summary>
  139. <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>
  140. <param name="additionalHandlers">An ordered list of <see cref="T:System.Net.Http.DelegatingHandler"/> instances to be invoked as part
  141. of sending an <see cref="T:System.Net.Http.HttpRequestMessage"/> and receiving an <see cref="T:System.Net.Http.HttpResponseMessage"/>.
  142. The handlers are invoked in a top-down fashion. That is, the first entry is invoked first for
  143. an outbound request message but last for an inbound response message.</param>
  144. <returns>The HTTP message handler chain.</returns>
  145. <exception cref="T:System.ArgumentNullException"><paramref name="primaryHandler "/> or <paramref name="additionalHandlers "/> is <see langword="null"/>.</exception>
  146. <exception cref="T:System.InvalidOperationException"><paramref name="additionalHandlers "/> contains a <see langword="null"/> entry.
  147. -or-
  148. 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>
  149. </member>
  150. <member name="T:Microsoft.Extensions.Http.IHttpMessageHandlerBuilderFilter">
  151. <summary>
  152. Used by the <see cref="T:Microsoft.Extensions.Http.DefaultHttpClientFactory"/> to apply additional initialization to the configure the
  153. <see cref="T:Microsoft.Extensions.Http.HttpMessageHandlerBuilder"/> immediately before <see cref="M:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.Build"/>
  154. is called.
  155. </summary>
  156. </member>
  157. <member name="M:Microsoft.Extensions.Http.IHttpMessageHandlerBuilderFilter.Configure(System.Action{Microsoft.Extensions.Http.HttpMessageHandlerBuilder})">
  158. <summary>
  159. Applies additional initialization to the <see cref="T:Microsoft.Extensions.Http.HttpMessageHandlerBuilder"/>
  160. </summary>
  161. <param name="next">A delegate which will run the next <see cref="T:Microsoft.Extensions.Http.IHttpMessageHandlerBuilderFilter"/>.</param>
  162. <returns>The configured <see cref="T:Microsoft.Extensions.Http.HttpMessageHandlerBuilder"/>.</returns>
  163. </member>
  164. <member name="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1">
  165. <summary>
  166. A factory abstraction for a component that can create typed client instances with custom
  167. configuration for a given logical name.
  168. </summary>
  169. <typeparam name="TClient">The type of typed client to create.</typeparam>
  170. <remarks>
  171. <para>
  172. The <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1"/> is infrastructure that supports the
  173. <see cref="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String)"/> and
  174. <see cref="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddTypedClient``1(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder)"/> functionality. This type
  175. should rarely be used directly in application code, use <see cref="M:System.IServiceProvider.GetService(System.Type)"/> instead
  176. to retrieve typed clients.
  177. </para>
  178. <para>
  179. A default <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1"/> can be registered in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>
  180. by calling <see cref="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient(Microsoft.Extensions.DependencyInjection.IServiceCollection)"/>.
  181. The default <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1"/> will be registered in the service collection as a singleton
  182. open-generic service.
  183. </para>
  184. <para>
  185. The default <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1"/> uses type activation to create typed client instances. Typed
  186. client types are not retrieved directly from the <see cref="T:System.IServiceProvider"/>. See
  187. <see cref="M:Microsoft.Extensions.DependencyInjection.ActivatorUtilities.CreateInstance(System.IServiceProvider,System.Type,System.Object[])" /> for details.
  188. </para>
  189. </remarks>
  190. <example>
  191. This sample shows the basic pattern for defining a typed client class.
  192. <code>
  193. class ExampleClient
  194. {
  195. private readonly HttpClient _httpClient;
  196. private readonly ILogger _logger;
  197. // typed clients can use constructor injection to access additional services
  198. public ExampleClient(HttpClient httpClient, ILogger&lt;ExampleClient&gt; logger)
  199. {
  200. _httpClient = httpClient;
  201. _logger = logger;
  202. }
  203. // typed clients can expose the HttpClient for application code to call directly
  204. public HttpClient HttpClient => _httpClient;
  205. // typed clients can also define methods that abstract usage of the HttpClient
  206. public async Task SendHelloRequest()
  207. {
  208. var response = await _httpClient.GetAsync("/helloworld");
  209. response.EnsureSuccessStatusCode();
  210. }
  211. }
  212. </code>
  213. </example>
  214. <example>
  215. This sample shows how to consume a typed client from an ASP.NET Core middleware.
  216. <code>
  217. // in Startup.cs
  218. public void Configure(IApplicationBuilder app, ExampleClient exampleClient)
  219. {
  220. app.Run(async (context) =>
  221. {
  222. var response = await _exampleClient.GetAsync("/helloworld");
  223. await context.Response.WriteAsync("Remote server said: ");
  224. await response.Content.CopyToAsync(context.Response.Body);
  225. });
  226. }
  227. </code>
  228. </example>
  229. <example>
  230. This sample shows how to consume a typed client from an ASP.NET Core MVC Controller.
  231. <code>
  232. // in Controllers/HomeController.cs
  233. public class HomeController : ControllerBase(IApplicationBuilder app, ExampleClient exampleClient)
  234. {
  235. private readonly ExampleClient _exampleClient;
  236. public HomeController(ExampleClient exampleClient)
  237. {
  238. _exampleClient = exampleClient;
  239. }
  240. public async Task&lt;IActionResult&gt; Index()
  241. {
  242. var response = await _exampleClient.GetAsync("/helloworld");
  243. var text = await response.Content.ReadAsStringAsync();
  244. return Content("Remote server said: " + text, "text/plain");
  245. };
  246. }
  247. </code>
  248. </example>
  249. </member>
  250. <member name="M:Microsoft.Extensions.Http.ITypedHttpClientFactory`1.CreateClient(System.Net.Http.HttpClient)">
  251. <summary>
  252. Creates a typed client given an associated <see cref="T:System.Net.Http.HttpClient"/>.
  253. </summary>
  254. <param name="httpClient">
  255. An <see cref="T:System.Net.Http.HttpClient"/> created by the <see cref="T:System.Net.Http.IHttpClientFactory"/> for the named client
  256. associated with <typeparamref name="TClient"/>.
  257. </param>
  258. <returns>An instance of <typeparamref name="TClient"/>.</returns>
  259. </member>
  260. <member name="T:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler">
  261. <summary>
  262. Handles logging of the lifecycle for an HTTP request.
  263. </summary>
  264. </member>
  265. <member name="M:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler.#ctor(Microsoft.Extensions.Logging.ILogger)">
  266. <summary>
  267. Initializes a new instance of the <see cref="T:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler"/> class with a specified logger.
  268. </summary>
  269. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to log to.</param>
  270. <exception cref="T:System.ArgumentNullException"><paramref name="logger"/> is <see langword="null"/>.</exception>
  271. </member>
  272. <member name="M:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler.#ctor(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Http.HttpClientFactoryOptions)">
  273. <summary>
  274. Initializes a new instance of the <see cref="T:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler"/> class with a specified logger and options.
  275. </summary>
  276. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to log to.</param>
  277. <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>
  278. <exception cref="T:System.ArgumentNullException"><paramref name="logger"/> or <paramref name="options"/> is <see langword="null"/>.</exception>
  279. </member>
  280. <member name="M:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler.SendAsync(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)">
  281. <inheritdoc />
  282. <remarks>Loggs the request to and response from the sent <see cref="T:System.Net.Http.HttpRequestMessage"/>.</remarks>
  283. </member>
  284. <member name="T:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler">
  285. <summary>
  286. Handles logging of the lifecycle for an HTTP request within a log scope.
  287. </summary>
  288. </member>
  289. <member name="M:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler.#ctor(Microsoft.Extensions.Logging.ILogger)">
  290. <summary>
  291. Initializes a new instance of the <see cref="T:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler"/> class with a specified logger.
  292. </summary>
  293. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to log to.</param>
  294. <exception cref="T:System.ArgumentNullException"><paramref name="logger"/> is <see langword="null"/>.</exception>
  295. </member>
  296. <member name="M:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler.#ctor(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Http.HttpClientFactoryOptions)">
  297. <summary>
  298. Initializes a new instance of the <see cref="T:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler"/> class with a specified logger and options.
  299. </summary>
  300. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to log to.</param>
  301. <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>
  302. <exception cref="T:System.ArgumentNullException"><paramref name="logger"/> or <paramref name="options"/> is <see langword="null"/>.</exception>
  303. </member>
  304. <member name="M:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler.SendAsync(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)">
  305. <inheritdoc />
  306. <remarks>Loggs the request to and response from the sent <see cref="T:System.Net.Http.HttpRequestMessage"/>.</remarks>
  307. </member>
  308. <member name="T:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions">
  309. <summary>
  310. Extension methods for configuring an <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>
  311. </summary>
  312. </member>
  313. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.ConfigureHttpClient(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Action{System.Net.Http.HttpClient})">
  314. <summary>
  315. Adds a delegate that will be used to configure a named <see cref="T:System.Net.Http.HttpClient"/>.
  316. </summary>
  317. <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
  318. <param name="configureClient">A delegate that is used to configure an <see cref="T:System.Net.Http.HttpClient"/>.</param>
  319. <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
  320. </member>
  321. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.ConfigureHttpClient(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Action{System.IServiceProvider,System.Net.Http.HttpClient})">
  322. <summary>
  323. Adds a delegate that will be used to configure a named <see cref="T:System.Net.Http.HttpClient"/>.
  324. </summary>
  325. <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
  326. <param name="configureClient">A delegate that is used to configure an <see cref="T:System.Net.Http.HttpClient"/>.</param>
  327. <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
  328. <remarks>
  329. The <see cref="T:System.IServiceProvider"/> provided to <paramref name="configureClient"/> will be the
  330. same application's root service provider instance.
  331. </remarks>
  332. </member>
  333. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddHttpMessageHandler(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Func{System.Net.Http.DelegatingHandler})">
  334. <summary>
  335. Adds a delegate that will be used to create an additional message handler for a named <see cref="T:System.Net.Http.HttpClient"/>.
  336. </summary>
  337. <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
  338. <param name="configureHandler">A delegate that is used to create a <see cref="T:System.Net.Http.DelegatingHandler"/>.</param>
  339. <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
  340. <remarks>
  341. The <see paramref="configureHandler"/> delegate should return a new instance of the message handler each time it
  342. is invoked.
  343. </remarks>
  344. </member>
  345. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddHttpMessageHandler(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Func{System.IServiceProvider,System.Net.Http.DelegatingHandler})">
  346. <summary>
  347. Adds a delegate that will be used to create an additional message handler for a named <see cref="T:System.Net.Http.HttpClient"/>.
  348. </summary>
  349. <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
  350. <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>
  351. <remarks>
  352. <para>
  353. The <see paramref="configureHandler"/> delegate should return a new instance of the message handler each time it
  354. is invoked.
  355. </para>
  356. <para>
  357. The <see cref="T:System.IServiceProvider"/> argument provided to <paramref name="configureHandler"/> will be
  358. a reference to a scoped service provider that shares the lifetime of the handler being constructed.
  359. </para>
  360. </remarks>
  361. </member>
  362. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddHttpMessageHandler``1(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder)">
  363. <summary>
  364. Adds an additional message handler from the dependency injection container for a named <see cref="T:System.Net.Http.HttpClient"/>.
  365. </summary>
  366. <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
  367. <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
  368. <typeparam name="THandler">
  369. The type of the <see cref="T:System.Net.Http.DelegatingHandler"/>. The handler type must be registered as a transient service.
  370. </typeparam>
  371. <remarks>
  372. <para>
  373. The <typeparamref name="THandler"/> will be resolved from a scoped service provider that shares
  374. the lifetime of the handler being constructed.
  375. </para>
  376. </remarks>
  377. </member>
  378. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.ConfigurePrimaryHttpMessageHandler(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Func{System.Net.Http.HttpMessageHandler})">
  379. <summary>
  380. Adds a delegate that will be used to configure the primary <see cref="T:System.Net.Http.HttpMessageHandler"/> for a
  381. named <see cref="T:System.Net.Http.HttpClient"/>.
  382. </summary>
  383. <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
  384. <param name="configureHandler">A delegate that is used to create an <see cref="T:System.Net.Http.HttpMessageHandler"/>.</param>
  385. <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
  386. <remarks>
  387. The <see paramref="configureHandler"/> delegate should return a new instance of the message handler each time it
  388. is invoked.
  389. </remarks>
  390. </member>
  391. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.ConfigurePrimaryHttpMessageHandler(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Func{System.IServiceProvider,System.Net.Http.HttpMessageHandler})">
  392. <summary>
  393. Adds a delegate that will be used to configure the primary <see cref="T:System.Net.Http.HttpMessageHandler"/> for a
  394. named <see cref="T:System.Net.Http.HttpClient"/>.
  395. </summary>
  396. <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
  397. <param name="configureHandler">A delegate that is used to create an <see cref="T:System.Net.Http.HttpMessageHandler"/>.</param>
  398. <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
  399. <remarks>
  400. <para>
  401. The <see paramref="configureHandler"/> delegate should return a new instance of the message handler each time it
  402. is invoked.
  403. </para>
  404. <para>
  405. The <see cref="T:System.IServiceProvider"/> argument provided to <paramref name="configureHandler"/> will be
  406. a reference to a scoped service provider that shares the lifetime of the handler being constructed.
  407. </para>
  408. </remarks>
  409. </member>
  410. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.ConfigurePrimaryHttpMessageHandler``1(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder)">
  411. <summary>
  412. Configures the primary <see cref="T:System.Net.Http.HttpMessageHandler"/> from the dependency injection container
  413. for a named <see cref="T:System.Net.Http.HttpClient"/>.
  414. </summary>
  415. <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
  416. <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
  417. <typeparam name="THandler">
  418. The type of the <see cref="T:System.Net.Http.DelegatingHandler"/>. The handler type must be registered as a transient service.
  419. </typeparam>
  420. <remarks>
  421. <para>
  422. The <typeparamref name="THandler"/> will be resolved from a scoped service provider that shares
  423. the lifetime of the handler being constructed.
  424. </para>
  425. </remarks>
  426. </member>
  427. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.ConfigureHttpMessageHandlerBuilder(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Action{Microsoft.Extensions.Http.HttpMessageHandlerBuilder})">
  428. <summary>
  429. Adds a delegate that will be used to configure message handlers using <see cref="T:Microsoft.Extensions.Http.HttpMessageHandlerBuilder"/>
  430. for a named <see cref="T:System.Net.Http.HttpClient"/>.
  431. </summary>
  432. <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
  433. <param name="configureBuilder">A delegate that is used to configure an <see cref="T:Microsoft.Extensions.Http.HttpMessageHandlerBuilder"/>.</param>
  434. <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
  435. </member>
  436. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddTypedClient``1(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder)">
  437. <summary>
  438. Configures a binding between the <typeparamref name="TClient" /> type and the named <see cref="T:System.Net.Http.HttpClient"/>
  439. associated with the <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.
  440. </summary>
  441. <typeparam name="TClient">
  442. The type of the typed client. The type specified will be registered in the service collection as
  443. a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
  444. </typeparam>
  445. <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
  446. <remarks>
  447. <para>
  448. <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
  449. can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
  450. <typeparamref name="TClient"/> as the service type.
  451. </para>
  452. <para>
  453. Calling <see cref="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddTypedClient``1(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder)"/> will register a typed
  454. client binding that creates <typeparamref name="TClient"/> using the <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" />.
  455. </para>
  456. <para>
  457. The typed client's service dependencies will be resolved from the same service provider
  458. that is used to resolve the typed client. It is not possible to access services from the
  459. scope bound to the message handler, which is managed independently.
  460. </para>
  461. </remarks>
  462. </member>
  463. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddTypedClient``2(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder)">
  464. <summary>
  465. Configures a binding between the <typeparamref name="TClient" /> type and the named <see cref="T:System.Net.Http.HttpClient"/>
  466. associated with the <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>. The created instances will be of type
  467. <typeparamref name="TImplementation"/>.
  468. </summary>
  469. <typeparam name="TClient">
  470. The declared type of the typed client. They type specified will be registered in the service collection as
  471. a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
  472. </typeparam>
  473. <typeparam name="TImplementation">
  474. The implementation type of the typed client. The type specified by will be instantiated by the
  475. <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1"/>.
  476. </typeparam>
  477. <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
  478. <remarks>
  479. <para>
  480. <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
  481. can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
  482. <typeparamref name="TClient"/> as the service type.
  483. </para>
  484. <para>
  485. Calling <see cref="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddTypedClient``2(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder)"/>
  486. will register a typed client binding that creates <typeparamref name="TImplementation"/> using the
  487. <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" />.
  488. </para>
  489. <para>
  490. The typed client's service dependencies will be resolved from the same service provider
  491. that is used to resolve the typed client. It is not possible to access services from the
  492. scope bound to the message handler, which is managed independently.
  493. </para>
  494. </remarks>
  495. </member>
  496. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddTypedClient``1(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Func{System.Net.Http.HttpClient,``0})">
  497. <summary>
  498. Configures a binding between the <typeparamref name="TClient" /> type and the named <see cref="T:System.Net.Http.HttpClient"/>
  499. associated with the <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.
  500. </summary>
  501. <typeparam name="TClient">
  502. The type of the typed client. They type specified will be registered in the service collection as
  503. a transient service.
  504. </typeparam>
  505. <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
  506. <param name="factory">A factory function that will be used to construct the typed client.</param>
  507. <remarks>
  508. <para>
  509. <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
  510. can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
  511. <typeparamref name="TClient"/> as the service type.
  512. </para>
  513. <para>
  514. Calling <see cref="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddTypedClient``1(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Func{System.Net.Http.HttpClient,``0})"/>
  515. will register a typed client binding that creates <typeparamref name="TClient"/> using the provided factory function.
  516. </para>
  517. </remarks>
  518. </member>
  519. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddTypedClient``1(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Func{System.Net.Http.HttpClient,System.IServiceProvider,``0})">
  520. <summary>
  521. Configures a binding between the <typeparamref name="TClient" /> type and the named <see cref="T:System.Net.Http.HttpClient"/>
  522. associated with the <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.
  523. </summary>
  524. <typeparam name="TClient">
  525. The type of the typed client. They type specified will be registered in the service collection as
  526. a transient service.
  527. </typeparam>
  528. <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
  529. <param name="factory">A factory function that will be used to construct the typed client.</param>
  530. <remarks>
  531. <para>
  532. <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
  533. can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
  534. <typeparamref name="TClient"/> as the service type.
  535. </para>
  536. <para>
  537. Calling <see cref="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddTypedClient``1(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Func{System.Net.Http.HttpClient,System.IServiceProvider,``0})"/>
  538. will register a typed client binding that creates <typeparamref name="TClient"/> using the provided factory function.
  539. </para>
  540. </remarks>
  541. </member>
  542. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.RedactLoggedHeaders(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Func{System.String,System.Boolean})">
  543. <summary>
  544. Sets the <see cref="T:System.Func`2"/> which determines whether to redact the HTTP header value before logging.
  545. </summary>
  546. <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
  547. <param name="shouldRedactHeaderValue">The <see cref="T:System.Func`2"/> which determines whether to redact the HTTP header value before logging.</param>
  548. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</returns>
  549. <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.
  550. </remarks>
  551. </member>
  552. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.RedactLoggedHeaders(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Collections.Generic.IEnumerable{System.String})">
  553. <summary>
  554. Sets the collection of HTTP headers names for which values should be redacted before logging.
  555. </summary>
  556. <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</param>
  557. <param name="redactedLoggedHeaderNames">The collection of HTTP headers names for which values should be redacted before logging.</param>
  558. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.</returns>
  559. </member>
  560. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.SetHandlerLifetime(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.TimeSpan)">
  561. <summary>
  562. Sets the length of time that a <see cref="T:System.Net.Http.HttpMessageHandler"/> instance can be reused. Each named
  563. client can have its own configured handler lifetime value. The default value is two minutes. Set the lifetime to
  564. <see cref="F:System.Threading.Timeout.InfiniteTimeSpan"/> to disable handler expiry.
  565. </summary>
  566. <remarks>
  567. <para>
  568. The default implementation of <see cref="T:System.Net.Http.IHttpClientFactory"/> will pool the <see cref="T:System.Net.Http.HttpMessageHandler"/>
  569. instances created by the factory to reduce resource consumption. This setting configures the amount of time
  570. a handler can be pooled before it is scheduled for removal from the pool and disposal.
  571. </para>
  572. <para>
  573. Pooling of handlers is desirable as each handler typically manages its own underlying HTTP connections; creating
  574. more handlers than necessary can result in connection delays. Some handlers also keep connections open indefinitely
  575. which can prevent the handler from reacting to DNS changes. The value of <paramref name="handlerLifetime"/> should be
  576. chosen with an understanding of the application's requirement to respond to changes in the network environment.
  577. </para>
  578. <para>
  579. Expiry of a handler will not immediately dispose the handler. An expired handler is placed in a separate pool
  580. which is processed at intervals to dispose handlers only when they become unreachable. Using long-lived
  581. <see cref="T:System.Net.Http.HttpClient"/> instances will prevent the underlying <see cref="T:System.Net.Http.HttpMessageHandler"/> from being
  582. disposed until all references are garbage-collected.
  583. </para>
  584. </remarks>
  585. </member>
  586. <member name="T:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions">
  587. <summary>
  588. Extension methods to configure an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> for <see cref="T:System.Net.Http.IHttpClientFactory"/>.
  589. </summary>
  590. </member>
  591. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
  592. <summary>
  593. Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.
  594. </summary>
  595. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
  596. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</returns>
  597. </member>
  598. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String)">
  599. <summary>
  600. Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
  601. a named <see cref="T:System.Net.Http.HttpClient"/>.
  602. </summary>
  603. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
  604. <param name="name">The logical name of the <see cref="T:System.Net.Http.HttpClient"/> to configure.</param>
  605. <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
  606. <remarks>
  607. <para>
  608. <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
  609. <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
  610. </para>
  611. <para>
  612. Use <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/> as the name to configure the default client.
  613. </para>
  614. </remarks>
  615. </member>
  616. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.Action{System.Net.Http.HttpClient})">
  617. <summary>
  618. Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
  619. a named <see cref="T:System.Net.Http.HttpClient"/>.
  620. </summary>
  621. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
  622. <param name="name">The logical name of the <see cref="T:System.Net.Http.HttpClient"/> to configure.</param>
  623. <param name="configureClient">A delegate that is used to configure an <see cref="T:System.Net.Http.HttpClient"/>.</param>
  624. <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
  625. <remarks>
  626. <para>
  627. <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
  628. <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
  629. </para>
  630. <para>
  631. Use <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/> as the name to configure the default client.
  632. </para>
  633. </remarks>
  634. </member>
  635. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.Action{System.IServiceProvider,System.Net.Http.HttpClient})">
  636. <summary>
  637. Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
  638. a named <see cref="T:System.Net.Http.HttpClient"/>.
  639. </summary>
  640. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
  641. <param name="name">The logical name of the <see cref="T:System.Net.Http.HttpClient"/> to configure.</param>
  642. <param name="configureClient">A delegate that is used to configure an <see cref="T:System.Net.Http.HttpClient"/>.</param>
  643. <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
  644. <remarks>
  645. <para>
  646. <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
  647. <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
  648. </para>
  649. <para>
  650. Use <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/> as the name to configure the default client.
  651. </para>
  652. </remarks>
  653. </member>
  654. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``1(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
  655. <summary>
  656. Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
  657. a binding between the <typeparamref name="TClient"/> type and a named <see cref="T:System.Net.Http.HttpClient"/>. The client name
  658. will be set to the type name of <typeparamref name="TClient"/>.
  659. </summary>
  660. <typeparam name="TClient">
  661. The type of the typed client. The type specified will be registered in the service collection as
  662. a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
  663. </typeparam>
  664. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
  665. <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
  666. <remarks>
  667. <para>
  668. <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
  669. <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
  670. </para>
  671. <para>
  672. <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
  673. can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
  674. <typeparamref name="TClient"/> as the service type.
  675. </para>
  676. </remarks>
  677. </member>
  678. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``2(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
  679. <summary>
  680. Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
  681. a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>. The client name will
  682. be set to the type name of <typeparamref name="TClient"/>.
  683. </summary>
  684. <typeparam name="TClient">
  685. The type of the typed client. The type specified will be registered in the service collection as
  686. a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
  687. </typeparam>
  688. <typeparam name="TImplementation">
  689. The implementation type of the typed client. The type specified will be instantiated by the
  690. <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1"/>
  691. </typeparam>
  692. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
  693. <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
  694. <remarks>
  695. <para>
  696. <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
  697. <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
  698. </para>
  699. <para>
  700. <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
  701. can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
  702. <typeparamref name="TClient"/> as the service type.
  703. </para>
  704. </remarks>
  705. </member>
  706. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String)">
  707. <summary>
  708. Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
  709. a binding between the <typeparamref name="TClient"/> type and a named <see cref="T:System.Net.Http.HttpClient"/>.
  710. </summary>
  711. <typeparam name="TClient">
  712. The type of the typed client. The type specified will be registered in the service collection as
  713. a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
  714. </typeparam>
  715. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
  716. <param name="name">The logical name of the <see cref="T:System.Net.Http.HttpClient"/> to configure.</param>
  717. <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
  718. <remarks>
  719. <para>
  720. <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
  721. <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
  722. </para>
  723. <para>
  724. <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
  725. can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
  726. <typeparamref name="TClient"/> as the service type.
  727. </para>
  728. <para>
  729. Use <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/> as the name to configure the default client.
  730. </para>
  731. </remarks>
  732. </member>
  733. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``2(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String)">
  734. <summary>
  735. Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
  736. a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>.
  737. </summary>
  738. <typeparam name="TClient">
  739. The type of the typed client. The type specified will be registered in the service collection as
  740. a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
  741. </typeparam>
  742. <typeparam name="TImplementation">
  743. The implementation type of the typed client. The type specified will be instantiated by the
  744. <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1"/>
  745. </typeparam>
  746. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
  747. <param name="name">The logical name of the <see cref="T:System.Net.Http.HttpClient"/> to configure.</param>
  748. <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
  749. <remarks>
  750. <para>
  751. <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
  752. <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
  753. </para>
  754. <para>
  755. <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
  756. can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
  757. <typeparamref name="TClient"/> as the service type.
  758. </para>
  759. <para>
  760. Use <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/> as the name to configure the default client.
  761. </para>
  762. </remarks>
  763. </member>
  764. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{System.Net.Http.HttpClient})">
  765. <summary>
  766. Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
  767. a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>. The client name will
  768. be set to the type name of <typeparamref name="TClient"/>.
  769. </summary>
  770. <typeparam name="TClient">
  771. The type of the typed client. The type specified will be registered in the service collection as
  772. a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
  773. </typeparam>
  774. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
  775. <param name="configureClient">A delegate that is used to configure an <see cref="T:System.Net.Http.HttpClient"/>.</param>
  776. <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
  777. <remarks>
  778. <para>
  779. <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
  780. <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
  781. </para>
  782. <para>
  783. <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
  784. can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
  785. <typeparamref name="TClient"/> as the service type.
  786. </para>
  787. </remarks>
  788. </member>
  789. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{System.IServiceProvider,System.Net.Http.HttpClient})">
  790. <summary>
  791. Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
  792. a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>. The client name will
  793. be set to the type name of <typeparamref name="TClient"/>.
  794. </summary>
  795. <typeparam name="TClient">
  796. The type of the typed client. The type specified will be registered in the service collection as
  797. a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
  798. </typeparam>
  799. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
  800. <param name="configureClient">A delegate that is used to configure an <see cref="T:System.Net.Http.HttpClient"/>.</param>
  801. <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
  802. <remarks>
  803. <para>
  804. <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
  805. <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
  806. </para>
  807. <para>
  808. <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
  809. can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
  810. <typeparamref name="TClient"/> as the service type.
  811. </para>
  812. </remarks>
  813. </member>
  814. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``2(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{System.Net.Http.HttpClient})">
  815. <summary>
  816. Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
  817. a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>. The client name will
  818. be set to the type name of <typeparamref name="TClient"/>.
  819. </summary>
  820. <typeparam name="TClient">
  821. The type of the typed client. The type specified will be registered in the service collection as
  822. a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
  823. </typeparam>
  824. <typeparam name="TImplementation">
  825. The implementation type of the typed client. The type specified will be instantiated by the
  826. <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1"/>
  827. </typeparam>
  828. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
  829. <param name="configureClient">A delegate that is used to configure an <see cref="T:System.Net.Http.HttpClient"/>.</param>
  830. <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
  831. <remarks>
  832. <para>
  833. <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
  834. <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
  835. </para>
  836. <para>
  837. <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
  838. can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
  839. <typeparamref name="TClient"/> as the service type.
  840. </para>
  841. </remarks>
  842. </member>
  843. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``2(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{System.IServiceProvider,System.Net.Http.HttpClient})">
  844. <summary>
  845. Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
  846. a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>. The client name will
  847. be set to the type name of <typeparamref name="TClient"/>.
  848. </summary>
  849. <typeparam name="TClient">
  850. The type of the typed client. The type specified will be registered in the service collection as
  851. a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
  852. </typeparam>
  853. <typeparam name="TImplementation">
  854. The implementation type of the typed client. The type specified will be instantiated by the
  855. <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1"/>
  856. </typeparam>
  857. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
  858. <param name="configureClient">A delegate that is used to configure an <see cref="T:System.Net.Http.HttpClient"/>.</param>
  859. <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
  860. <remarks>
  861. <para>
  862. <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
  863. <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
  864. </para>
  865. <para>
  866. <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
  867. can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
  868. <typeparamref name="TClient"/> as the service type.
  869. </para>
  870. </remarks>
  871. </member>
  872. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.Action{System.Net.Http.HttpClient})">
  873. <summary>
  874. Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
  875. a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>.
  876. </summary>
  877. <typeparam name="TClient">
  878. The type of the typed client. The type specified will be registered in the service collection as
  879. a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
  880. </typeparam>
  881. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
  882. <param name="name">The logical name of the <see cref="T:System.Net.Http.HttpClient"/> to configure.</param>
  883. <param name="configureClient">A delegate that is used to configure an <see cref="T:System.Net.Http.HttpClient"/>.</param>
  884. <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
  885. <remarks>
  886. <para>
  887. <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
  888. <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
  889. </para>
  890. <para>
  891. <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
  892. can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
  893. <typeparamref name="TClient"/> as the service type.
  894. </para>
  895. <para>
  896. Use <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/> as the name to configure the default client.
  897. </para>
  898. </remarks>
  899. </member>
  900. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.Action{System.IServiceProvider,System.Net.Http.HttpClient})">
  901. <summary>
  902. Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
  903. a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>.
  904. </summary>
  905. <typeparam name="TClient">
  906. The type of the typed client. The type specified will be registered in the service collection as
  907. a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
  908. </typeparam>
  909. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
  910. <param name="name">The logical name of the <see cref="T:System.Net.Http.HttpClient"/> to configure.</param>
  911. <param name="configureClient">A delegate that is used to configure an <see cref="T:System.Net.Http.HttpClient"/>.</param>
  912. <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
  913. <remarks>
  914. <para>
  915. <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
  916. <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
  917. </para>
  918. <para>
  919. <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
  920. can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
  921. <typeparamref name="TClient"/> as the service type.
  922. </para>
  923. <para>
  924. Use <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/> as the name to configure the default client.
  925. </para>
  926. </remarks>
  927. </member>
  928. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``2(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.Action{System.Net.Http.HttpClient})">
  929. <summary>
  930. Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
  931. a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>.
  932. </summary>
  933. <typeparam name="TClient">
  934. The type of the typed client. The type specified will be registered in the service collection as
  935. a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
  936. </typeparam>
  937. <typeparam name="TImplementation">
  938. The implementation type of the typed client. The type specified will be instantiated by the
  939. <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1"/>
  940. </typeparam>
  941. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
  942. <param name="name">The logical name of the <see cref="T:System.Net.Http.HttpClient"/> to configure.</param>
  943. <param name="configureClient">A delegate that is used to configure an <see cref="T:System.Net.Http.HttpClient"/>.</param>
  944. <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
  945. <remarks>
  946. <para>
  947. <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
  948. <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
  949. </para>
  950. <para>
  951. <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
  952. can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
  953. <typeparamref name="TClient"/> as the service type.
  954. </para>
  955. <para>
  956. Use <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/> as the name to configure the default client.
  957. </para>
  958. </remarks>
  959. </member>
  960. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``2(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.Action{System.IServiceProvider,System.Net.Http.HttpClient})">
  961. <summary>
  962. Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
  963. a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>.
  964. </summary>
  965. <typeparam name="TClient">
  966. The type of the typed client. The type specified will be registered in the service collection as
  967. a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
  968. </typeparam>
  969. <typeparam name="TImplementation">
  970. The implementation type of the typed client. The type specified will be instantiated by the
  971. <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1"/>
  972. </typeparam>
  973. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
  974. <param name="name">The logical name of the <see cref="T:System.Net.Http.HttpClient"/> to configure.</param>
  975. <param name="configureClient">A delegate that is used to configure an <see cref="T:System.Net.Http.HttpClient"/>.</param>
  976. <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
  977. <remarks>
  978. <para>
  979. <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
  980. <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
  981. </para>
  982. <para>
  983. <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
  984. can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
  985. <typeparamref name="TClient"/> as the service type.
  986. </para>
  987. <para>
  988. Use <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/> as the name to configure the default client.
  989. </para>
  990. </remarks>
  991. </member>
  992. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``2(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Func{System.Net.Http.HttpClient,``1})">
  993. <summary>
  994. Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
  995. a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>.
  996. </summary>
  997. <typeparam name="TClient">
  998. The type of the typed client. The type specified will be registered in the service collection as
  999. a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
  1000. </typeparam>
  1001. <typeparam name="TImplementation">
  1002. The implementation type of the typed client.
  1003. </typeparam>
  1004. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
  1005. <param name="factory">A delegate that is used to create an instance of <typeparamref name="TClient"/>.</param>
  1006. <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
  1007. <remarks>
  1008. <para>
  1009. <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
  1010. <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
  1011. </para>
  1012. <para>
  1013. <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
  1014. can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
  1015. <typeparamref name="TClient"/> as the service type.
  1016. </para>
  1017. </remarks>
  1018. </member>
  1019. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``2(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.Func{System.Net.Http.HttpClient,``1})">
  1020. <summary>
  1021. Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
  1022. a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>.
  1023. </summary>
  1024. <typeparam name="TClient">
  1025. The type of the typed client. The type specified will be registered in the service collection as
  1026. a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
  1027. </typeparam>
  1028. <typeparam name="TImplementation">
  1029. The implementation type of the typed client.
  1030. </typeparam>
  1031. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
  1032. <param name="name">The logical name of the <see cref="T:System.Net.Http.HttpClient"/> to configure.</param>
  1033. <param name="factory">A delegate that is used to create an instance of <typeparamref name="TClient"/>.</param>
  1034. <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
  1035. <remarks>
  1036. <para>
  1037. <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
  1038. <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
  1039. </para>
  1040. <para>
  1041. <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
  1042. can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
  1043. <typeparamref name="TClient"/> as the service type.
  1044. </para>
  1045. <typeparamref name="TImplementation">
  1046. </typeparamref>
  1047. </remarks>
  1048. </member>
  1049. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``2(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Func{System.Net.Http.HttpClient,System.IServiceProvider,``1})">
  1050. <summary>
  1051. Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
  1052. a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>.
  1053. </summary>
  1054. <typeparam name="TClient">
  1055. The type of the typed client. The type specified will be registered in the service collection as
  1056. a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
  1057. </typeparam>
  1058. <typeparam name="TImplementation">
  1059. The implementation type of the typed client.
  1060. </typeparam>
  1061. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
  1062. <param name="factory">A delegate that is used to create an instance of <typeparamref name="TClient"/>.</param>
  1063. <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
  1064. <remarks>
  1065. <para>
  1066. <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
  1067. <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
  1068. </para>
  1069. <para>
  1070. <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
  1071. can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
  1072. <typeparamref name="TClient"/> as the service type.
  1073. </para>
  1074. </remarks>
  1075. </member>
  1076. <member name="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient``2(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.Func{System.Net.Http.HttpClient,System.IServiceProvider,``1})">
  1077. <summary>
  1078. Adds the <see cref="T:System.Net.Http.IHttpClientFactory"/> and related services to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> and configures
  1079. a binding between the <typeparamref name="TClient" /> type and a named <see cref="T:System.Net.Http.HttpClient"/>.
  1080. </summary>
  1081. <typeparam name="TClient">
  1082. The type of the typed client. The type specified will be registered in the service collection as
  1083. a transient service. See <see cref="T:Microsoft.Extensions.Http.ITypedHttpClientFactory`1" /> for more details about authoring typed clients.
  1084. </typeparam>
  1085. <typeparam name="TImplementation">
  1086. The implementation type of the typed client.
  1087. </typeparam>
  1088. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
  1089. <param name="name">The logical name of the <see cref="T:System.Net.Http.HttpClient"/> to configure.</param>
  1090. <param name="factory">A delegate that is used to create an instance of <typeparamref name="TClient"/>.</param>
  1091. <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> that can be used to configure the client.</returns>
  1092. <remarks>
  1093. <para>
  1094. <see cref="T:System.Net.Http.HttpClient"/> instances that apply the provided configuration can be retrieved using
  1095. <see cref="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)"/> and providing the matching name.
  1096. </para>
  1097. <para>
  1098. <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="T:System.Net.Http.HttpClient" />
  1099. can be retrieved from <see cref="M:System.IServiceProvider.GetService(System.Type)" /> (and related methods) by providing
  1100. <typeparamref name="TClient"/> as the service type.
  1101. </para>
  1102. </remarks>
  1103. </member>
  1104. <member name="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder">
  1105. <summary>
  1106. A builder for configuring named <see cref="T:System.Net.Http.HttpClient"/> instances returned by <see cref="T:System.Net.Http.IHttpClientFactory"/>.
  1107. </summary>
  1108. </member>
  1109. <member name="P:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder.Name">
  1110. <summary>
  1111. Gets the name of the client configured by this builder.
  1112. </summary>
  1113. </member>
  1114. <member name="P:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder.Services">
  1115. <summary>
  1116. Gets the application service collection.
  1117. </summary>
  1118. </member>
  1119. <member name="M:Microsoft.Extensions.Internal.TypeNameHelper.GetTypeDisplayName(System.Type,System.Boolean,System.Boolean,System.Boolean,System.Char)">
  1120. <summary>
  1121. Pretty print a type name.
  1122. </summary>
  1123. <param name="type">The <see cref="T:System.Type"/>.</param>
  1124. <param name="fullName"><c>true</c> to print a fully qualified name.</param>
  1125. <param name="includeGenericParameterNames"><c>true</c> to include generic parameter names.</param>
  1126. <param name="includeGenericParameters"><c>true</c> to include generic parameters.</param>
  1127. <param name="nestedTypeDelimiter">Character to use as a delimiter in nested type names</param>
  1128. <returns>The pretty printed type name.</returns>
  1129. </member>
  1130. <member name="T:System.Net.Http.HttpClientFactoryExtensions">
  1131. <summary>
  1132. Extensions methods for <see cref="T:System.Net.Http.IHttpClientFactory"/>.
  1133. </summary>
  1134. </member>
  1135. <member name="M:System.Net.Http.HttpClientFactoryExtensions.CreateClient(System.Net.Http.IHttpClientFactory)">
  1136. <summary>
  1137. Creates a new <see cref="T:System.Net.Http.HttpClient"/> using the default configuration.
  1138. </summary>
  1139. <param name="factory">The <see cref="T:System.Net.Http.IHttpClientFactory"/>.</param>
  1140. <returns>An <see cref="T:System.Net.Http.HttpClient"/> configured using the default configuration.</returns>
  1141. </member>
  1142. <member name="T:System.Net.Http.HttpMessageHandlerFactoryExtensions">
  1143. <summary>
  1144. Extensions methods for <see cref="T:System.Net.Http.IHttpMessageHandlerFactory"/>.
  1145. </summary>
  1146. </member>
  1147. <member name="M:System.Net.Http.HttpMessageHandlerFactoryExtensions.CreateHandler(System.Net.Http.IHttpMessageHandlerFactory)">
  1148. <summary>
  1149. Creates a new <see cref="T:System.Net.Http.HttpMessageHandler"/> using the default configuration.
  1150. </summary>
  1151. <param name="factory">The <see cref="T:System.Net.Http.IHttpMessageHandlerFactory"/>.</param>
  1152. <returns>An <see cref="T:System.Net.Http.HttpMessageHandler"/> configured using the default configuration.</returns>
  1153. </member>
  1154. <member name="T:System.Net.Http.IHttpClientFactory">
  1155. <summary>
  1156. A factory abstraction for a component that can create <see cref="T:System.Net.Http.HttpClient"/> instances with custom
  1157. configuration for a given logical name.
  1158. </summary>
  1159. <remarks>
  1160. A default <see cref="T:System.Net.Http.IHttpClientFactory"/> can be registered in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>
  1161. by calling <see cref="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient(Microsoft.Extensions.DependencyInjection.IServiceCollection)"/>.
  1162. The default <see cref="T:System.Net.Http.IHttpClientFactory"/> will be registered in the service collection as a singleton.
  1163. </remarks>
  1164. </member>
  1165. <member name="M:System.Net.Http.IHttpClientFactory.CreateClient(System.String)">
  1166. <summary>
  1167. Creates and configures an <see cref="T:System.Net.Http.HttpClient"/> instance using the configuration that corresponds
  1168. to the logical name specified by <paramref name="name"/>.
  1169. </summary>
  1170. <param name="name">The logical name of the client to create.</param>
  1171. <returns>A new <see cref="T:System.Net.Http.HttpClient"/> instance.</returns>
  1172. <remarks>
  1173. <para>
  1174. 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"/>
  1175. instance. It is generally not necessary to dispose of the <see cref="T:System.Net.Http.HttpClient"/> as the
  1176. <see cref="T:System.Net.Http.IHttpClientFactory"/> tracks and disposes resources used by the <see cref="T:System.Net.Http.HttpClient"/>.
  1177. </para>
  1178. <para>
  1179. Callers are also free to mutate the returned <see cref="T:System.Net.Http.HttpClient"/> instance's public properties
  1180. as desired.
  1181. </para>
  1182. </remarks>
  1183. </member>
  1184. <member name="T:System.Net.Http.IHttpMessageHandlerFactory">
  1185. <summary>
  1186. A factory abstraction for a component that can create <see cref="T:System.Net.Http.HttpMessageHandler"/> instances with custom
  1187. configuration for a given logical name.
  1188. </summary>
  1189. <remarks>
  1190. A default <see cref="T:System.Net.Http.IHttpMessageHandlerFactory"/> can be registered in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>
  1191. by calling <see cref="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient(Microsoft.Extensions.DependencyInjection.IServiceCollection)"/>.
  1192. The default <see cref="T:System.Net.Http.IHttpMessageHandlerFactory"/> will be registered in the service collection as a singleton.
  1193. </remarks>
  1194. </member>
  1195. <member name="M:System.Net.Http.IHttpMessageHandlerFactory.CreateHandler(System.String)">
  1196. <summary>
  1197. Creates and configures an <see cref="T:System.Net.Http.HttpMessageHandler"/> instance using the configuration that corresponds
  1198. to the logical name specified by <paramref name="name"/>.
  1199. </summary>
  1200. <param name="name">The logical name of the message handler to create.</param>
  1201. <returns>A new <see cref="T:System.Net.Http.HttpMessageHandler"/> instance.</returns>
  1202. <remarks>
  1203. <para>
  1204. The default <see cref="T:System.Net.Http.IHttpMessageHandlerFactory"/> implementation may cache the underlying
  1205. <see cref="T:System.Net.Http.HttpMessageHandler"/> instances to improve performance.
  1206. </para>
  1207. <para>
  1208. The default <see cref="T:System.Net.Http.IHttpMessageHandlerFactory"/> implementation also manages the lifetime of the
  1209. handler created, so disposing of the <see cref="T:System.Net.Http.HttpMessageHandler"/> returned by this method may
  1210. have no effect.
  1211. </para>
  1212. </remarks>
  1213. </member>
  1214. <member name="M:System.ThrowHelper.ThrowIfNull(System.Object,System.String)">
  1215. <summary>Throws an <see cref="T:System.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary>
  1216. <param name="argument">The reference type argument to validate as non-null.</param>
  1217. <param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param>
  1218. </member>
  1219. <member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
  1220. <summary>
  1221. Attribute used to indicate a source generator should create a function for marshalling
  1222. arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
  1223. </summary>
  1224. <remarks>
  1225. This attribute is meaningless if the source generator associated with it is not enabled.
  1226. The current built-in source generator only supports C# and only supplies an implementation when
  1227. applied to static, partial, non-generic methods.
  1228. </remarks>
  1229. </member>
  1230. <member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
  1231. <summary>
  1232. Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
  1233. </summary>
  1234. <param name="libraryName">Name of the library containing the import.</param>
  1235. </member>
  1236. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
  1237. <summary>
  1238. Gets the name of the library containing the import.
  1239. </summary>
  1240. </member>
  1241. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
  1242. <summary>
  1243. Gets or sets the name of the entry point to be called.
  1244. </summary>
  1245. </member>
  1246. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
  1247. <summary>
  1248. Gets or sets how to marshal string arguments to the method.
  1249. </summary>
  1250. <remarks>
  1251. If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
  1252. <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
  1253. </remarks>
  1254. </member>
  1255. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
  1256. <summary>
  1257. Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
  1258. </summary>
  1259. <remarks>
  1260. If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
  1261. or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
  1262. </remarks>
  1263. </member>
  1264. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
  1265. <summary>
  1266. Gets or sets whether the callee sets an error (SetLastError on Windows or errno
  1267. on other platforms) before returning from the attributed method.
  1268. </summary>
  1269. </member>
  1270. <member name="T:System.Runtime.InteropServices.StringMarshalling">
  1271. <summary>
  1272. Specifies how strings should be marshalled for generated p/invokes
  1273. </summary>
  1274. </member>
  1275. <member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
  1276. <summary>
  1277. Indicates the user is suppling a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
  1278. </summary>
  1279. </member>
  1280. <member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
  1281. <summary>
  1282. Use the platform-provided UTF-8 marshaller.
  1283. </summary>
  1284. </member>
  1285. <member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
  1286. <summary>
  1287. Use the platform-provided UTF-16 marshaller.
  1288. </summary>
  1289. </member>
  1290. <member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute">
  1291. <summary>
  1292. Indicates that certain members on a specified <see cref="T:System.Type"/> are accessed dynamically,
  1293. for example through <see cref="N:System.Reflection"/>.
  1294. </summary>
  1295. <remarks>
  1296. This allows tools to understand which members are being accessed during the execution
  1297. of a program.
  1298. This attribute is valid on members whose type is <see cref="T:System.Type"/> or <see cref="T:System.String"/>.
  1299. When this attribute is applied to a location of type <see cref="T:System.String"/>, the assumption is
  1300. that the string represents a fully qualified type name.
  1301. When this attribute is applied to a class, interface, or struct, the members specified
  1302. can be accessed dynamically on <see cref="T:System.Type"/> instances returned from calling
  1303. <see cref="M:System.Object.GetType"/> on instances of that class, interface, or struct.
  1304. If the attribute is applied to a method it's treated as a special case and it implies
  1305. the attribute should be applied to the "this" parameter of the method. As such the attribute
  1306. should only be used on instance methods of types assignable to System.Type (or string, but no methods
  1307. will use it there).
  1308. </remarks>
  1309. </member>
  1310. <member name="M:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes)">
  1311. <summary>
  1312. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute"/> class
  1313. with the specified member types.
  1314. </summary>
  1315. <param name="memberTypes">The types of members dynamically accessed.</param>
  1316. </member>
  1317. <member name="P:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.MemberTypes">
  1318. <summary>
  1319. Gets the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes"/> which specifies the type
  1320. of members dynamically accessed.
  1321. </summary>
  1322. </member>
  1323. <member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes">
  1324. <summary>
  1325. Specifies the types of members that are dynamically accessed.
  1326. This enumeration has a <see cref="T:System.FlagsAttribute"/> attribute that allows a
  1327. bitwise combination of its member values.
  1328. </summary>
  1329. </member>
  1330. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None">
  1331. <summary>
  1332. Specifies no members.
  1333. </summary>
  1334. </member>
  1335. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicParameterlessConstructor">
  1336. <summary>
  1337. Specifies the default, parameterless public constructor.
  1338. </summary>
  1339. </member>
  1340. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors">
  1341. <summary>
  1342. Specifies all public constructors.
  1343. </summary>
  1344. </member>
  1345. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructors">
  1346. <summary>
  1347. Specifies all non-public constructors.
  1348. </summary>
  1349. </member>
  1350. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods">
  1351. <summary>
  1352. Specifies all public methods.
  1353. </summary>
  1354. </member>
  1355. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods">
  1356. <summary>
  1357. Specifies all non-public methods.
  1358. </summary>
  1359. </member>
  1360. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields">
  1361. <summary>
  1362. Specifies all public fields.
  1363. </summary>
  1364. </member>
  1365. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields">
  1366. <summary>
  1367. Specifies all non-public fields.
  1368. </summary>
  1369. </member>
  1370. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes">
  1371. <summary>
  1372. Specifies all public nested types.
  1373. </summary>
  1374. </member>
  1375. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes">
  1376. <summary>
  1377. Specifies all non-public nested types.
  1378. </summary>
  1379. </member>
  1380. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties">
  1381. <summary>
  1382. Specifies all public properties.
  1383. </summary>
  1384. </member>
  1385. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties">
  1386. <summary>
  1387. Specifies all non-public properties.
  1388. </summary>
  1389. </member>
  1390. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents">
  1391. <summary>
  1392. Specifies all public events.
  1393. </summary>
  1394. </member>
  1395. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEvents">
  1396. <summary>
  1397. Specifies all non-public events.
  1398. </summary>
  1399. </member>
  1400. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.Interfaces">
  1401. <summary>
  1402. Specifies all interfaces implemented by the type.
  1403. </summary>
  1404. </member>
  1405. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All">
  1406. <summary>
  1407. Specifies all members.
  1408. </summary>
  1409. </member>
  1410. <member name="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute">
  1411. <summary>
  1412. Suppresses reporting of a specific rule violation, allowing multiple suppressions on a
  1413. single code artifact.
  1414. </summary>
  1415. <remarks>
  1416. <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> is different than
  1417. <see cref="T:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute"/> in that it doesn't have a
  1418. <see cref="T:System.Diagnostics.ConditionalAttribute"/>. So it is always preserved in the compiled assembly.
  1419. </remarks>
  1420. </member>
  1421. <member name="M:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.#ctor(System.String,System.String)">
  1422. <summary>
  1423. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/>
  1424. class, specifying the category of the tool and the identifier for an analysis rule.
  1425. </summary>
  1426. <param name="category">The category for the attribute.</param>
  1427. <param name="checkId">The identifier of the analysis rule the attribute applies to.</param>
  1428. </member>
  1429. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category">
  1430. <summary>
  1431. Gets the category identifying the classification of the attribute.
  1432. </summary>
  1433. <remarks>
  1434. The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> property describes the tool or tool analysis category
  1435. for which a message suppression attribute applies.
  1436. </remarks>
  1437. </member>
  1438. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId">
  1439. <summary>
  1440. Gets the identifier of the analysis tool rule to be suppressed.
  1441. </summary>
  1442. <remarks>
  1443. Concatenated together, the <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> and <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId"/>
  1444. properties form a unique check identifier.
  1445. </remarks>
  1446. </member>
  1447. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Scope">
  1448. <summary>
  1449. Gets or sets the scope of the code that is relevant for the attribute.
  1450. </summary>
  1451. <remarks>
  1452. The Scope property is an optional argument that specifies the metadata scope for which
  1453. the attribute is relevant.
  1454. </remarks>
  1455. </member>
  1456. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target">
  1457. <summary>
  1458. Gets or sets a fully qualified path that represents the target of the attribute.
  1459. </summary>
  1460. <remarks>
  1461. The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target"/> property is an optional argument identifying the analysis target
  1462. of the attribute. An example value is "System.IO.Stream.ctor():System.Void".
  1463. Because it is fully qualified, it can be long, particularly for targets such as parameters.
  1464. The analysis tool user interface should be capable of automatically formatting the parameter.
  1465. </remarks>
  1466. </member>
  1467. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId">
  1468. <summary>
  1469. Gets or sets an optional argument expanding on exclusion criteria.
  1470. </summary>
  1471. <remarks>
  1472. The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId"/> property is an optional argument that specifies additional
  1473. exclusion where the literal metadata target is not sufficiently precise. For example,
  1474. the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> cannot be applied within a method,
  1475. and it may be desirable to suppress a violation against a statement in the method that will
  1476. give a rule violation, but not against all statements in the method.
  1477. </remarks>
  1478. </member>
  1479. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Justification">
  1480. <summary>
  1481. Gets or sets the justification for suppressing the code analysis message.
  1482. </summary>
  1483. </member>
  1484. <member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
  1485. <summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
  1486. </member>
  1487. <member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
  1488. <summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
  1489. </member>
  1490. <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
  1491. <summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
  1492. </member>
  1493. <member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
  1494. <summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
  1495. </member>
  1496. <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
  1497. <summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
  1498. </member>
  1499. <member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
  1500. <summary>Initializes the attribute with the specified return value condition.</summary>
  1501. <param name="returnValue">
  1502. The return value condition. If the method returns this value, the associated parameter may be null.
  1503. </param>
  1504. </member>
  1505. <member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
  1506. <summary>Gets the return value condition.</summary>
  1507. </member>
  1508. <member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
  1509. <summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
  1510. </member>
  1511. <member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
  1512. <summary>Initializes the attribute with the specified return value condition.</summary>
  1513. <param name="returnValue">
  1514. The return value condition. If the method returns this value, the associated parameter will not be null.
  1515. </param>
  1516. </member>
  1517. <member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
  1518. <summary>Gets the return value condition.</summary>
  1519. </member>
  1520. <member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
  1521. <summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
  1522. </member>
  1523. <member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
  1524. <summary>Initializes the attribute with the associated parameter name.</summary>
  1525. <param name="parameterName">
  1526. The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
  1527. </param>
  1528. </member>
  1529. <member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
  1530. <summary>Gets the associated parameter name.</summary>
  1531. </member>
  1532. <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
  1533. <summary>Applied to a method that will never return under any circumstance.</summary>
  1534. </member>
  1535. <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
  1536. <summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
  1537. </member>
  1538. <member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
  1539. <summary>Initializes the attribute with the specified parameter value.</summary>
  1540. <param name="parameterValue">
  1541. The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
  1542. the associated parameter matches this value.
  1543. </param>
  1544. </member>
  1545. <member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
  1546. <summary>Gets the condition parameter value.</summary>
  1547. </member>
  1548. <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
  1549. <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
  1550. </member>
  1551. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
  1552. <summary>Initializes the attribute with a field or property member.</summary>
  1553. <param name="member">
  1554. The field or property member that is promised to be not-null.
  1555. </param>
  1556. </member>
  1557. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
  1558. <summary>Initializes the attribute with the list of field and property members.</summary>
  1559. <param name="members">
  1560. The list of field and property members that are promised to be not-null.
  1561. </param>
  1562. </member>
  1563. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
  1564. <summary>Gets field or property member names.</summary>
  1565. </member>
  1566. <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
  1567. <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
  1568. </member>
  1569. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
  1570. <summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
  1571. <param name="returnValue">
  1572. The return value condition. If the method returns this value, the associated parameter will not be null.
  1573. </param>
  1574. <param name="member">
  1575. The field or property member that is promised to be not-null.
  1576. </param>
  1577. </member>
  1578. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
  1579. <summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
  1580. <param name="returnValue">
  1581. The return value condition. If the method returns this value, the associated parameter will not be null.
  1582. </param>
  1583. <param name="members">
  1584. The list of field and property members that are promised to be not-null.
  1585. </param>
  1586. </member>
  1587. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
  1588. <summary>Gets the return value condition.</summary>
  1589. </member>
  1590. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
  1591. <summary>Gets field or property member names.</summary>
  1592. </member>
  1593. <member name="P:System.SR.HttpMessageHandlerBuilder_AdditionalHandlerIsNull">
  1594. <summary>The '{0}' must not contain a null entry.</summary>
  1595. </member>
  1596. <member name="P:System.SR.HttpMessageHandlerBuilder_AdditionHandlerIsInvalid">
  1597. <summary>The '{0}' property must be null. '{1}' instances provided to '{2}' must not be reused or cached.{3}Handler: '{4}'</summary>
  1598. </member>
  1599. <member name="P:System.SR.HttpMessageHandlerBuilder_PrimaryHandlerIsNull">
  1600. <summary>The '{0}' must not be null.</summary>
  1601. </member>
  1602. <member name="P:System.SR.HandlerLifetime_InvalidValue">
  1603. <summary>The handler lifetime must be at least 1 second.</summary>
  1604. </member>
  1605. </members>
  1606. </doc>