Microsoft.Extensions.Options.xml 47 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.Options</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.Options.ConfigureNamedOptions`1">
  8. <summary>
  9. Implementation of IConfigureNamedOptions.
  10. </summary>
  11. <typeparam name="TOptions"></typeparam>
  12. </member>
  13. <member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`1.#ctor(System.String,System.Action{`0})">
  14. <summary>
  15. Constructor.
  16. </summary>
  17. <param name="name">The name of the options.</param>
  18. <param name="action">The action to register.</param>
  19. </member>
  20. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`1.Name">
  21. <summary>
  22. The options name.
  23. </summary>
  24. </member>
  25. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`1.Action">
  26. <summary>
  27. The configuration action.
  28. </summary>
  29. </member>
  30. <member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`1.Configure(System.String,`0)">
  31. <summary>
  32. Invokes the registered configure Action if the name matches.
  33. </summary>
  34. <param name="name"></param>
  35. <param name="options"></param>
  36. </member>
  37. <member name="T:Microsoft.Extensions.Options.ConfigureNamedOptions`2">
  38. <summary>
  39. Implementation of IConfigureNamedOptions.
  40. </summary>
  41. <typeparam name="TOptions"></typeparam>
  42. <typeparam name="TDep"></typeparam>
  43. </member>
  44. <member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`2.#ctor(System.String,`1,System.Action{`0,`1})">
  45. <summary>
  46. Constructor.
  47. </summary>
  48. <param name="name">The name of the options.</param>
  49. <param name="dependency">A dependency.</param>
  50. <param name="action">The action to register.</param>
  51. </member>
  52. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`2.Name">
  53. <summary>
  54. The options name.
  55. </summary>
  56. </member>
  57. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`2.Action">
  58. <summary>
  59. The configuration action.
  60. </summary>
  61. </member>
  62. <member name="T:Microsoft.Extensions.Options.ConfigureNamedOptions`3">
  63. <summary>
  64. Implementation of IConfigureNamedOptions.
  65. </summary>
  66. <typeparam name="TOptions"></typeparam>
  67. <typeparam name="TDep1"></typeparam>
  68. <typeparam name="TDep2"></typeparam>
  69. </member>
  70. <member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`3.#ctor(System.String,`1,`2,System.Action{`0,`1,`2})">
  71. <summary>
  72. Constructor.
  73. </summary>
  74. <param name="name">The name of the options.</param>
  75. <param name="dependency">A dependency.</param>
  76. <param name="dependency2">A second dependency.</param>
  77. <param name="action">The action to register.</param>
  78. </member>
  79. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`3.Name">
  80. <summary>
  81. The options name.
  82. </summary>
  83. </member>
  84. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`3.Action">
  85. <summary>
  86. The configuration action.
  87. </summary>
  88. </member>
  89. <member name="T:Microsoft.Extensions.Options.ConfigureNamedOptions`4">
  90. <summary>
  91. Implementation of IConfigureNamedOptions.
  92. </summary>
  93. <typeparam name="TOptions"></typeparam>
  94. <typeparam name="TDep1"></typeparam>
  95. <typeparam name="TDep2"></typeparam>
  96. <typeparam name="TDep3"></typeparam>
  97. </member>
  98. <member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`4.#ctor(System.String,`1,`2,`3,System.Action{`0,`1,`2,`3})">
  99. <summary>
  100. Constructor.
  101. </summary>
  102. <param name="name">The name of the options.</param>
  103. <param name="dependency">A dependency.</param>
  104. <param name="dependency2">A second dependency.</param>
  105. <param name="dependency3">A third dependency.</param>
  106. <param name="action">The action to register.</param>
  107. </member>
  108. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`4.Name">
  109. <summary>
  110. The options name.
  111. </summary>
  112. </member>
  113. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`4.Action">
  114. <summary>
  115. The configuration action.
  116. </summary>
  117. </member>
  118. <member name="T:Microsoft.Extensions.Options.ConfigureNamedOptions`5">
  119. <summary>
  120. Implementation of IConfigureNamedOptions.
  121. </summary>
  122. <typeparam name="TOptions"></typeparam>
  123. <typeparam name="TDep1"></typeparam>
  124. <typeparam name="TDep2"></typeparam>
  125. <typeparam name="TDep3"></typeparam>
  126. <typeparam name="TDep4"></typeparam>
  127. </member>
  128. <member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`5.#ctor(System.String,`1,`2,`3,`4,System.Action{`0,`1,`2,`3,`4})">
  129. <summary>
  130. Constructor.
  131. </summary>
  132. <param name="name">The name of the options.</param>
  133. <param name="dependency1">A dependency.</param>
  134. <param name="dependency2">A second dependency.</param>
  135. <param name="dependency3">A third dependency.</param>
  136. <param name="dependency4">A fourth dependency.</param>
  137. <param name="action">The action to register.</param>
  138. </member>
  139. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`5.Name">
  140. <summary>
  141. The options name.
  142. </summary>
  143. </member>
  144. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`5.Action">
  145. <summary>
  146. The configuration action.
  147. </summary>
  148. </member>
  149. <member name="T:Microsoft.Extensions.Options.ConfigureNamedOptions`6">
  150. <summary>
  151. Implementation of IConfigureNamedOptions.
  152. </summary>
  153. <typeparam name="TOptions"></typeparam>
  154. <typeparam name="TDep1"></typeparam>
  155. <typeparam name="TDep2"></typeparam>
  156. <typeparam name="TDep3"></typeparam>
  157. <typeparam name="TDep4"></typeparam>
  158. <typeparam name="TDep5"></typeparam>
  159. </member>
  160. <member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`6.#ctor(System.String,`1,`2,`3,`4,`5,System.Action{`0,`1,`2,`3,`4,`5})">
  161. <summary>
  162. Constructor.
  163. </summary>
  164. <param name="name">The name of the options.</param>
  165. <param name="dependency1">A dependency.</param>
  166. <param name="dependency2">A second dependency.</param>
  167. <param name="dependency3">A third dependency.</param>
  168. <param name="dependency4">A fourth dependency.</param>
  169. <param name="dependency5">A fifth dependency.</param>
  170. <param name="action">The action to register.</param>
  171. </member>
  172. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`6.Name">
  173. <summary>
  174. The options name.
  175. </summary>
  176. </member>
  177. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`6.Action">
  178. <summary>
  179. The configuration action.
  180. </summary>
  181. </member>
  182. <member name="T:Microsoft.Extensions.Options.ConfigureOptions`1">
  183. <summary>
  184. Implementation of IConfigureOptions.
  185. </summary>
  186. <typeparam name="TOptions"></typeparam>
  187. </member>
  188. <member name="M:Microsoft.Extensions.Options.ConfigureOptions`1.#ctor(System.Action{`0})">
  189. <summary>
  190. Constructor.
  191. </summary>
  192. <param name="action">The action to register.</param>
  193. </member>
  194. <member name="P:Microsoft.Extensions.Options.ConfigureOptions`1.Action">
  195. <summary>
  196. The configuration action.
  197. </summary>
  198. </member>
  199. <member name="M:Microsoft.Extensions.Options.ConfigureOptions`1.Configure(`0)">
  200. <summary>
  201. Invokes the registered configure Action if the name matches.
  202. </summary>
  203. <param name="options"></param>
  204. </member>
  205. <member name="T:Microsoft.Extensions.Options.IConfigureNamedOptions`1">
  206. <summary>
  207. Represents something that configures the TOptions type.
  208. </summary>
  209. <typeparam name="TOptions"></typeparam>
  210. </member>
  211. <member name="M:Microsoft.Extensions.Options.IConfigureNamedOptions`1.Configure(System.String,`0)">
  212. <summary>
  213. Invoked to configure a TOptions instance.
  214. </summary>
  215. <param name="name">The name of the options instance being configured.</param>
  216. <param name="options">The options instance to configure.</param>
  217. </member>
  218. <member name="T:Microsoft.Extensions.Options.IConfigureOptions`1">
  219. <summary>
  220. Represents something that configures the TOptions type.
  221. Note: These are run before all <see cref="T:Microsoft.Extensions.Options.IPostConfigureOptions`1"/>.
  222. </summary>
  223. <typeparam name="TOptions"></typeparam>
  224. </member>
  225. <member name="M:Microsoft.Extensions.Options.IConfigureOptions`1.Configure(`0)">
  226. <summary>
  227. Invoked to configure a TOptions instance.
  228. </summary>
  229. <param name="options">The options instance to configure.</param>
  230. </member>
  231. <member name="T:Microsoft.Extensions.Options.IOptions`1">
  232. <summary>
  233. Used to retrieve configured TOptions instances.
  234. </summary>
  235. <typeparam name="TOptions">The type of options being requested.</typeparam>
  236. </member>
  237. <member name="P:Microsoft.Extensions.Options.IOptions`1.Value">
  238. <summary>
  239. The default configured TOptions instance, equivalent to Get(string.Empty).
  240. </summary>
  241. </member>
  242. <member name="T:Microsoft.Extensions.Options.IOptionsChangeTokenSource`1">
  243. <summary>
  244. Used to fetch IChangeTokens used for tracking options changes.
  245. </summary>
  246. <typeparam name="TOptions"></typeparam>
  247. </member>
  248. <member name="M:Microsoft.Extensions.Options.IOptionsChangeTokenSource`1.GetChangeToken">
  249. <summary>
  250. Returns a IChangeToken which can be used to register a change notification callback.
  251. </summary>
  252. <returns></returns>
  253. </member>
  254. <member name="P:Microsoft.Extensions.Options.IOptionsChangeTokenSource`1.Name">
  255. <summary>
  256. The name of the option instance being changed.
  257. </summary>
  258. </member>
  259. <member name="T:Microsoft.Extensions.Options.IOptionsFactory`1">
  260. <summary>
  261. Used to create TOptions instances.
  262. </summary>
  263. <typeparam name="TOptions">The type of options being requested.</typeparam>
  264. </member>
  265. <member name="M:Microsoft.Extensions.Options.IOptionsFactory`1.Create(System.String)">
  266. <summary>
  267. Returns a configured TOptions instance with the given name.
  268. </summary>
  269. </member>
  270. <member name="T:Microsoft.Extensions.Options.IOptionsMonitor`1">
  271. <summary>
  272. Used for notifications when TOptions instances change.
  273. </summary>
  274. <typeparam name="TOptions">The options type.</typeparam>
  275. </member>
  276. <member name="P:Microsoft.Extensions.Options.IOptionsMonitor`1.CurrentValue">
  277. <summary>
  278. Returns the current TOptions instance with the <see cref="F:Microsoft.Extensions.Options.Options.DefaultName"/>.
  279. </summary>
  280. </member>
  281. <member name="M:Microsoft.Extensions.Options.IOptionsMonitor`1.Get(System.String)">
  282. <summary>
  283. Returns a configured TOptions instance with the given name.
  284. </summary>
  285. </member>
  286. <member name="M:Microsoft.Extensions.Options.IOptionsMonitor`1.OnChange(System.Action{`0,System.String})">
  287. <summary>
  288. Registers a listener to be called whenever a named TOptions changes.
  289. </summary>
  290. <param name="listener">The action to be invoked when TOptions has changed.</param>
  291. <returns>An IDisposable which should be disposed to stop listening for changes.</returns>
  292. </member>
  293. <member name="T:Microsoft.Extensions.Options.IOptionsMonitorCache`1">
  294. <summary>
  295. Used by <see cref="T:Microsoft.Extensions.Options.IOptionsMonitor`1"/> to cache TOptions instances.
  296. </summary>
  297. <typeparam name="TOptions">The type of options being requested.</typeparam>
  298. </member>
  299. <member name="M:Microsoft.Extensions.Options.IOptionsMonitorCache`1.GetOrAdd(System.String,System.Func{`0})">
  300. <summary>
  301. Gets a named options instance, or adds a new instance created with createOptions.
  302. </summary>
  303. <param name="name">The name of the options instance.</param>
  304. <param name="createOptions">The func used to create the new instance.</param>
  305. <returns>The options instance.</returns>
  306. </member>
  307. <member name="M:Microsoft.Extensions.Options.IOptionsMonitorCache`1.TryAdd(System.String,`0)">
  308. <summary>
  309. Tries to adds a new option to the cache, will return false if the name already exists.
  310. </summary>
  311. <param name="name">The name of the options instance.</param>
  312. <param name="options">The options instance.</param>
  313. <returns>Whether anything was added.</returns>
  314. </member>
  315. <member name="M:Microsoft.Extensions.Options.IOptionsMonitorCache`1.TryRemove(System.String)">
  316. <summary>
  317. Try to remove an options instance.
  318. </summary>
  319. <param name="name">The name of the options instance.</param>
  320. <returns>Whether anything was removed.</returns>
  321. </member>
  322. <member name="M:Microsoft.Extensions.Options.IOptionsMonitorCache`1.Clear">
  323. <summary>
  324. Clears all options instances from the cache.
  325. </summary>
  326. </member>
  327. <member name="T:Microsoft.Extensions.Options.IOptionsSnapshot`1">
  328. <summary>
  329. Used to access the value of TOptions for the lifetime of a request.
  330. </summary>
  331. <typeparam name="TOptions"></typeparam>
  332. </member>
  333. <member name="M:Microsoft.Extensions.Options.IOptionsSnapshot`1.Get(System.String)">
  334. <summary>
  335. Returns a configured TOptions instance with the given name.
  336. </summary>
  337. </member>
  338. <member name="T:Microsoft.Extensions.Options.IPostConfigureOptions`1">
  339. <summary>
  340. Represents something that configures the TOptions type.
  341. Note: These are run after all <see cref="T:Microsoft.Extensions.Options.IConfigureOptions`1"/>.
  342. </summary>
  343. <typeparam name="TOptions"></typeparam>
  344. </member>
  345. <member name="M:Microsoft.Extensions.Options.IPostConfigureOptions`1.PostConfigure(System.String,`0)">
  346. <summary>
  347. Invoked to configure a TOptions instance.
  348. </summary>
  349. <param name="name">The name of the options instance being configured.</param>
  350. <param name="options">The options instance to configured.</param>
  351. </member>
  352. <member name="T:Microsoft.Extensions.Options.Options">
  353. <summary>
  354. Helper class.
  355. </summary>
  356. </member>
  357. <member name="M:Microsoft.Extensions.Options.Options.Create``1(``0)">
  358. <summary>
  359. Creates a wrapper around an instance of TOptions to return itself as an IOptions.
  360. </summary>
  361. <typeparam name="TOptions"></typeparam>
  362. <param name="options"></param>
  363. <returns></returns>
  364. </member>
  365. <member name="T:Microsoft.Extensions.Options.OptionsBuilder`1">
  366. <summary>
  367. Used to configure TOptions instances.
  368. </summary>
  369. <typeparam name="TOptions">The type of options being requested.</typeparam>
  370. </member>
  371. <member name="P:Microsoft.Extensions.Options.OptionsBuilder`1.Name">
  372. <summary>
  373. The default name of the TOptions instance.
  374. </summary>
  375. </member>
  376. <member name="P:Microsoft.Extensions.Options.OptionsBuilder`1.Services">
  377. <summary>
  378. The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> for the options being configured.
  379. </summary>
  380. </member>
  381. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.#ctor(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String)">
  382. <summary>
  383. Constructor.
  384. </summary>
  385. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> for the options being configured.</param>
  386. <param name="name">The default name of the TOptions instance, if null Options.DefaultName is used.</param>
  387. </member>
  388. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure(System.Action{`0})">
  389. <summary>
  390. Registers an action used to configure a particular type of options.
  391. Note: These are run before all <seealso cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure(System.Action{`0})"/>.
  392. </summary>
  393. <param name="configureOptions">The action used to configure the options.</param>
  394. </member>
  395. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure(System.Action{`0})">
  396. <summary>
  397. Registers an action used to configure a particular type of options.
  398. Note: These are run after all <seealso cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure(System.Action{`0})"/>.
  399. </summary>
  400. <param name="configureOptions">The action used to configure the options.</param>
  401. </member>
  402. <member name="T:Microsoft.Extensions.Options.OptionsCache`1">
  403. <summary>
  404. Used to cache TOptions instances.
  405. </summary>
  406. <typeparam name="TOptions">The type of options being requested.</typeparam>
  407. </member>
  408. <member name="M:Microsoft.Extensions.Options.OptionsCache`1.Clear">
  409. <summary>
  410. Clears all options instances from the cache.
  411. </summary>
  412. </member>
  413. <member name="M:Microsoft.Extensions.Options.OptionsCache`1.GetOrAdd(System.String,System.Func{`0})">
  414. <summary>
  415. Gets a named options instance, or adds a new instance created with createOptions.
  416. </summary>
  417. <param name="name">The name of the options instance.</param>
  418. <param name="createOptions">The func used to create the new instance.</param>
  419. <returns>The options instance.</returns>
  420. </member>
  421. <member name="M:Microsoft.Extensions.Options.OptionsCache`1.TryAdd(System.String,`0)">
  422. <summary>
  423. Tries to adds a new option to the cache, will return false if the name already exists.
  424. </summary>
  425. <param name="name">The name of the options instance.</param>
  426. <param name="options">The options instance.</param>
  427. <returns>Whether anything was added.</returns>
  428. </member>
  429. <member name="M:Microsoft.Extensions.Options.OptionsCache`1.TryRemove(System.String)">
  430. <summary>
  431. Try to remove an options instance.
  432. </summary>
  433. <param name="name">The name of the options instance.</param>
  434. <returns>Whether anything was removed.</returns>
  435. </member>
  436. <member name="T:Microsoft.Extensions.Options.OptionsFactory`1">
  437. <summary>
  438. Implementation of IOptionsFactory.
  439. </summary>
  440. <typeparam name="TOptions">The type of options being requested.</typeparam>
  441. </member>
  442. <member name="M:Microsoft.Extensions.Options.OptionsFactory`1.#ctor(System.Collections.Generic.IEnumerable{Microsoft.Extensions.Options.IConfigureOptions{`0}},System.Collections.Generic.IEnumerable{Microsoft.Extensions.Options.IPostConfigureOptions{`0}})">
  443. <summary>
  444. Initializes a new instance with the specified options configurations.
  445. </summary>
  446. <param name="setups">The configuration actions to run.</param>
  447. <param name="postConfigures">The initialization actions to run.</param>
  448. </member>
  449. <member name="T:Microsoft.Extensions.Options.OptionsManager`1">
  450. <summary>
  451. Implementation of IOptions and IOptionsSnapshot.
  452. </summary>
  453. <typeparam name="TOptions"></typeparam>
  454. </member>
  455. <member name="M:Microsoft.Extensions.Options.OptionsManager`1.#ctor(Microsoft.Extensions.Options.IOptionsFactory{`0})">
  456. <summary>
  457. Initializes a new instance with the specified options configurations.
  458. </summary>
  459. <param name="factory">The factory to use to create options.</param>
  460. </member>
  461. <member name="T:Microsoft.Extensions.Options.OptionsMonitor`1">
  462. <summary>
  463. Implementation of IOptionsMonitor.
  464. </summary>
  465. <typeparam name="TOptions"></typeparam>
  466. </member>
  467. <member name="M:Microsoft.Extensions.Options.OptionsMonitor`1.#ctor(Microsoft.Extensions.Options.IOptionsFactory{`0},System.Collections.Generic.IEnumerable{Microsoft.Extensions.Options.IOptionsChangeTokenSource{`0}},Microsoft.Extensions.Options.IOptionsMonitorCache{`0})">
  468. <summary>
  469. Constructor.
  470. </summary>
  471. <param name="factory">The factory to use to create options.</param>
  472. <param name="sources">The sources used to listen for changes to the options instance.</param>
  473. <param name="cache">The cache used to store options.</param>
  474. </member>
  475. <member name="P:Microsoft.Extensions.Options.OptionsMonitor`1.CurrentValue">
  476. <summary>
  477. The present value of the options.
  478. </summary>
  479. </member>
  480. <member name="M:Microsoft.Extensions.Options.OptionsMonitor`1.OnChange(System.Action{`0,System.String})">
  481. <summary>
  482. Registers a listener to be called whenever TOptions changes.
  483. </summary>
  484. <param name="listener">The action to be invoked when TOptions has changed.</param>
  485. <returns>An IDisposable which should be disposed to stop listening for changes.</returns>
  486. </member>
  487. <member name="T:Microsoft.Extensions.Options.OptionsMonitorExtensions">
  488. <summary>
  489. Extension methods for IOptionsMonitor.
  490. </summary>
  491. </member>
  492. <member name="M:Microsoft.Extensions.Options.OptionsMonitorExtensions.OnChange``1(Microsoft.Extensions.Options.IOptionsMonitor{``0},System.Action{``0})">
  493. <summary>
  494. Registers a listener to be called whenever TOptions changes.
  495. </summary>
  496. <param name="monitor">The IOptionsMonitor.</param>
  497. <param name="listener">The action to be invoked when TOptions has changed.</param>
  498. <returns>An IDisposable which should be disposed to stop listening for changes.</returns>
  499. </member>
  500. <member name="T:Microsoft.Extensions.Options.OptionsWrapper`1">
  501. <summary>
  502. IOptions wrapper that returns the options instance.
  503. </summary>
  504. <typeparam name="TOptions"></typeparam>
  505. </member>
  506. <member name="M:Microsoft.Extensions.Options.OptionsWrapper`1.#ctor(`0)">
  507. <summary>
  508. Intializes the wrapper with the options instance to return.
  509. </summary>
  510. <param name="options">The options instance to return.</param>
  511. </member>
  512. <member name="P:Microsoft.Extensions.Options.OptionsWrapper`1.Value">
  513. <summary>
  514. The options instance.
  515. </summary>
  516. </member>
  517. <member name="M:Microsoft.Extensions.Options.OptionsWrapper`1.Add(System.String,`0)">
  518. <summary>
  519. This method is obsolete and will be removed in a future version.
  520. </summary>
  521. </member>
  522. <member name="M:Microsoft.Extensions.Options.OptionsWrapper`1.Get(System.String)">
  523. <summary>
  524. This method is obsolete and will be removed in a future version.
  525. </summary>
  526. <param name="name">This parameter is ignored.</param>
  527. <returns>The <see cref="P:Microsoft.Extensions.Options.OptionsWrapper`1.Value"/>.</returns>
  528. </member>
  529. <member name="M:Microsoft.Extensions.Options.OptionsWrapper`1.Remove(System.String)">
  530. <summary>
  531. This method is obsolete and will be removed in a future version.
  532. </summary>
  533. </member>
  534. <member name="T:Microsoft.Extensions.Options.PostConfigureOptions`1">
  535. <summary>
  536. Implementation of <see cref="T:Microsoft.Extensions.Options.IPostConfigureOptions`1"/>.
  537. </summary>
  538. <typeparam name="TOptions"></typeparam>
  539. </member>
  540. <member name="M:Microsoft.Extensions.Options.PostConfigureOptions`1.#ctor(System.String,System.Action{`0})">
  541. <summary>
  542. Creates a new instance of <see cref="T:Microsoft.Extensions.Options.PostConfigureOptions`1"/>.
  543. </summary>
  544. <param name="name">The name of the options.</param>
  545. <param name="action">The action to register.</param>
  546. </member>
  547. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`1.Name">
  548. <summary>
  549. The options name.
  550. </summary>
  551. </member>
  552. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`1.Action">
  553. <summary>
  554. The initialization action.
  555. </summary>
  556. </member>
  557. <member name="M:Microsoft.Extensions.Options.PostConfigureOptions`1.PostConfigure(System.String,`0)">
  558. <summary>
  559. Invokes the registered initialization Action if the name matches.
  560. </summary>
  561. <param name="name"></param>
  562. <param name="options"></param>
  563. </member>
  564. <member name="T:Microsoft.Extensions.Options.PostConfigureOptions`2">
  565. <summary>
  566. Implementation of IPostConfigureOptions.
  567. </summary>
  568. <typeparam name="TOptions"></typeparam>
  569. <typeparam name="TDep"></typeparam>
  570. </member>
  571. <member name="M:Microsoft.Extensions.Options.PostConfigureOptions`2.#ctor(System.String,`1,System.Action{`0,`1})">
  572. <summary>
  573. Constructor.
  574. </summary>
  575. <param name="name">The name of the options.</param>
  576. <param name="dependency">A dependency.</param>
  577. <param name="action">The action to register.</param>
  578. </member>
  579. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`2.Name">
  580. <summary>
  581. The options name.
  582. </summary>
  583. </member>
  584. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`2.Action">
  585. <summary>
  586. The configuration action.
  587. </summary>
  588. </member>
  589. <member name="T:Microsoft.Extensions.Options.PostConfigureOptions`3">
  590. <summary>
  591. Implementation of IPostConfigureOptions.
  592. </summary>
  593. <typeparam name="TOptions"></typeparam>
  594. <typeparam name="TDep1"></typeparam>
  595. <typeparam name="TDep2"></typeparam>
  596. </member>
  597. <member name="M:Microsoft.Extensions.Options.PostConfigureOptions`3.#ctor(System.String,`1,`2,System.Action{`0,`1,`2})">
  598. <summary>
  599. Constructor.
  600. </summary>
  601. <param name="name">The name of the options.</param>
  602. <param name="dependency">A dependency.</param>
  603. <param name="dependency2">A second dependency.</param>
  604. <param name="action">The action to register.</param>
  605. </member>
  606. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`3.Name">
  607. <summary>
  608. The options name.
  609. </summary>
  610. </member>
  611. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`3.Action">
  612. <summary>
  613. The configuration action.
  614. </summary>
  615. </member>
  616. <member name="T:Microsoft.Extensions.Options.PostConfigureOptions`4">
  617. <summary>
  618. Implementation of IPostConfigureOptions.
  619. </summary>
  620. <typeparam name="TOptions"></typeparam>
  621. <typeparam name="TDep1"></typeparam>
  622. <typeparam name="TDep2"></typeparam>
  623. <typeparam name="TDep3"></typeparam>
  624. </member>
  625. <member name="M:Microsoft.Extensions.Options.PostConfigureOptions`4.#ctor(System.String,`1,`2,`3,System.Action{`0,`1,`2,`3})">
  626. <summary>
  627. Constructor.
  628. </summary>
  629. <param name="name">The name of the options.</param>
  630. <param name="dependency">A dependency.</param>
  631. <param name="dependency2">A second dependency.</param>
  632. <param name="dependency3">A third dependency.</param>
  633. <param name="action">The action to register.</param>
  634. </member>
  635. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`4.Name">
  636. <summary>
  637. The options name.
  638. </summary>
  639. </member>
  640. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`4.Action">
  641. <summary>
  642. The configuration action.
  643. </summary>
  644. </member>
  645. <member name="T:Microsoft.Extensions.Options.PostConfigureOptions`5">
  646. <summary>
  647. Implementation of IPostConfigureOptions.
  648. </summary>
  649. <typeparam name="TOptions"></typeparam>
  650. <typeparam name="TDep1"></typeparam>
  651. <typeparam name="TDep2"></typeparam>
  652. <typeparam name="TDep3"></typeparam>
  653. <typeparam name="TDep4"></typeparam>
  654. </member>
  655. <member name="M:Microsoft.Extensions.Options.PostConfigureOptions`5.#ctor(System.String,`1,`2,`3,`4,System.Action{`0,`1,`2,`3,`4})">
  656. <summary>
  657. Constructor.
  658. </summary>
  659. <param name="name">The name of the options.</param>
  660. <param name="dependency1">A dependency.</param>
  661. <param name="dependency2">A second dependency.</param>
  662. <param name="dependency3">A third dependency.</param>
  663. <param name="dependency4">A fourth dependency.</param>
  664. <param name="action">The action to register.</param>
  665. </member>
  666. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`5.Name">
  667. <summary>
  668. The options name.
  669. </summary>
  670. </member>
  671. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`5.Action">
  672. <summary>
  673. The configuration action.
  674. </summary>
  675. </member>
  676. <member name="T:Microsoft.Extensions.Options.PostConfigureOptions`6">
  677. <summary>
  678. Implementation of IPostConfigureOptions.
  679. </summary>
  680. <typeparam name="TOptions"></typeparam>
  681. <typeparam name="TDep1"></typeparam>
  682. <typeparam name="TDep2"></typeparam>
  683. <typeparam name="TDep3"></typeparam>
  684. <typeparam name="TDep4"></typeparam>
  685. <typeparam name="TDep5"></typeparam>
  686. </member>
  687. <member name="M:Microsoft.Extensions.Options.PostConfigureOptions`6.#ctor(System.String,`1,`2,`3,`4,`5,System.Action{`0,`1,`2,`3,`4,`5})">
  688. <summary>
  689. Constructor.
  690. </summary>
  691. <param name="name">The name of the options.</param>
  692. <param name="dependency1">A dependency.</param>
  693. <param name="dependency2">A second dependency.</param>
  694. <param name="dependency3">A third dependency.</param>
  695. <param name="dependency4">A fourth dependency.</param>
  696. <param name="dependency5">A fifth dependency.</param>
  697. <param name="action">The action to register.</param>
  698. </member>
  699. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`6.Name">
  700. <summary>
  701. The options name.
  702. </summary>
  703. </member>
  704. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`6.Action">
  705. <summary>
  706. The configuration action.
  707. </summary>
  708. </member>
  709. <member name="P:Microsoft.Extensions.Options.Resources.Error_CannotActivateAbstractOrInterface">
  710. <summary>
  711. Cannot create instance of type '{0}' because it is either abstract or an interface.
  712. </summary>
  713. </member>
  714. <member name="M:Microsoft.Extensions.Options.Resources.FormatError_CannotActivateAbstractOrInterface(System.Object)">
  715. <summary>
  716. Cannot create instance of type '{0}' because it is either abstract or an interface.
  717. </summary>
  718. </member>
  719. <member name="P:Microsoft.Extensions.Options.Resources.Error_FailedBinding">
  720. <summary>
  721. Failed to convert '{0}' to type '{1}'.
  722. </summary>
  723. </member>
  724. <member name="M:Microsoft.Extensions.Options.Resources.FormatError_FailedBinding(System.Object,System.Object)">
  725. <summary>
  726. Failed to convert '{0}' to type '{1}'.
  727. </summary>
  728. </member>
  729. <member name="P:Microsoft.Extensions.Options.Resources.Error_FailedToActivate">
  730. <summary>
  731. Failed to create instance of type '{0}'.
  732. </summary>
  733. </member>
  734. <member name="M:Microsoft.Extensions.Options.Resources.FormatError_FailedToActivate(System.Object)">
  735. <summary>
  736. Failed to create instance of type '{0}'.
  737. </summary>
  738. </member>
  739. <member name="P:Microsoft.Extensions.Options.Resources.Error_MissingParameterlessConstructor">
  740. <summary>
  741. Cannot create instance of type '{0}' because it is missing a public parameterless constructor.
  742. </summary>
  743. </member>
  744. <member name="M:Microsoft.Extensions.Options.Resources.FormatError_MissingParameterlessConstructor(System.Object)">
  745. <summary>
  746. Cannot create instance of type '{0}' because it is missing a public parameterless constructor.
  747. </summary>
  748. </member>
  749. <member name="P:Microsoft.Extensions.Options.Resources.Error_NoIConfigureOptions">
  750. <summary>
  751. No IConfigureOptions&lt;&gt; or IPostConfigureOptions&lt;&gt; implementations were found.
  752. </summary>
  753. </member>
  754. <member name="M:Microsoft.Extensions.Options.Resources.FormatError_NoIConfigureOptions">
  755. <summary>
  756. No IConfigureOptions&lt;&gt; or IPostConfigureOptions&lt;&gt; implementations were found.
  757. </summary>
  758. </member>
  759. <member name="P:Microsoft.Extensions.Options.Resources.Error_NoIConfigureOptionsAndAction">
  760. <summary>
  761. No IConfigureOptions&lt;&gt; or IPostConfigureOptions&lt;&gt; implementations were found, did you mean to call Configure&lt;&gt; or PostConfigure&lt;&gt;?
  762. </summary>
  763. </member>
  764. <member name="M:Microsoft.Extensions.Options.Resources.FormatError_NoIConfigureOptionsAndAction">
  765. <summary>
  766. No IConfigureOptions&lt;&gt; or IPostConfigureOptions&lt;&gt; implementations were found, did you mean to call Configure&lt;&gt; or PostConfigure&lt;&gt;?
  767. </summary>
  768. </member>
  769. <member name="T:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions">
  770. <summary>
  771. Extension methods for adding options services to the DI container.
  772. </summary>
  773. </member>
  774. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.AddOptions(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
  775. <summary>
  776. Adds services required for using options.
  777. </summary>
  778. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
  779. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
  780. </member>
  781. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})">
  782. <summary>
  783. Registers an action used to configure a particular type of options.
  784. Note: These are run before all <seealso cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.PostConfigure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})"/>.
  785. </summary>
  786. <typeparam name="TOptions">The options type to be configured.</typeparam>
  787. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
  788. <param name="configureOptions">The action used to configure the options.</param>
  789. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
  790. </member>
  791. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.Action{``0})">
  792. <summary>
  793. Registers an action used to configure a particular type of options.
  794. Note: These are run before all <seealso cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.PostConfigure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})"/>.
  795. </summary>
  796. <typeparam name="TOptions">The options type to be configured.</typeparam>
  797. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
  798. <param name="name">The name of the options instance.</param>
  799. <param name="configureOptions">The action used to configure the options.</param>
  800. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
  801. </member>
  802. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.ConfigureAll``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})">
  803. <summary>
  804. Registers an action used to configure all instances of a particular type of options.
  805. </summary>
  806. <typeparam name="TOptions">The options type to be configured.</typeparam>
  807. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
  808. <param name="configureOptions">The action used to configure the options.</param>
  809. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
  810. </member>
  811. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.PostConfigure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})">
  812. <summary>
  813. Registers an action used to initialize a particular type of options.
  814. Note: These are run after all <seealso cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})"/>.
  815. </summary>
  816. <typeparam name="TOptions">The options type to be configured.</typeparam>
  817. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
  818. <param name="configureOptions">The action used to configure the options.</param>
  819. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
  820. </member>
  821. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.PostConfigure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.Action{``0})">
  822. <summary>
  823. Registers an action used to configure a particular type of options.
  824. Note: These are run after all <seealso cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})"/>.
  825. </summary>
  826. <typeparam name="TOptions">The options type to be configure.</typeparam>
  827. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
  828. <param name="name">The name of the options instance.</param>
  829. <param name="configureOptions">The action used to configure the options.</param>
  830. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
  831. </member>
  832. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.PostConfigureAll``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})">
  833. <summary>
  834. Registers an action used to post configure all instances of a particular type of options.
  835. Note: These are run after all <seealso cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})"/>.
  836. </summary>
  837. <typeparam name="TOptions">The options type to be configured.</typeparam>
  838. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
  839. <param name="configureOptions">The action used to configure the options.</param>
  840. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
  841. </member>
  842. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.ConfigureOptions``1(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
  843. <summary>
  844. Registers a type that will have all of its I[Post]ConfigureOptions registered.
  845. </summary>
  846. <typeparam name="TConfigureOptions">The type that will configure options.</typeparam>
  847. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
  848. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
  849. </member>
  850. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.ConfigureOptions(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Type)">
  851. <summary>
  852. Registers a type that will have all of its I[Post]ConfigureOptions registered.
  853. </summary>
  854. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
  855. <param name="configureType">The type that will configure options.</param>
  856. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
  857. </member>
  858. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.ConfigureOptions(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Object)">
  859. <summary>
  860. Registers an object that will have all of its I[Post]ConfigureOptions registered.
  861. </summary>
  862. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
  863. <param name="configureInstance">The instance that will configure options.</param>
  864. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
  865. </member>
  866. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.AddOptions``1(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
  867. <summary>
  868. Gets an options builder that forwards Configure calls for the same <typeparamref name="TOptions"/> to the underlying service collection.
  869. </summary>
  870. <typeparam name="TOptions">The options type to be configured.</typeparam>
  871. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
  872. <returns>The <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/> so that configure calls can be chained in it.</returns>
  873. </member>
  874. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.AddOptions``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String)">
  875. <summary>
  876. Gets an options builder that forwards Configure calls for the same named <typeparamref name="TOptions"/> to the underlying service collection.
  877. </summary>
  878. <typeparam name="TOptions">The options type to be configured.</typeparam>
  879. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
  880. <param name="name">The name of the options instance.</param>
  881. <returns>The <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/> so that configure calls can be chained in it.</returns>
  882. </member>
  883. </members>
  884. </doc>