Nav apraksta
Nevar pievienot vairāk kā 25 tēmas Tēmai ir jāsākas ar burtu vai ciparu, tā var saturēt domu zīmes ('-') un var būt līdz 35 simboliem gara.

Microsoft.Extensions.Options.xml 88KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.Options</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions">
  8. <summary>Extension methods for adding options services to the DI container.</summary>
  9. </member>
  10. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.AddOptions(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
  11. <summary>Adds services required for using options.</summary>
  12. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
  13. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> so that additional calls can be chained.</returns>
  14. </member>
  15. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.AddOptions``1(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
  16. <summary>Gets an options builder that forwards <c>Configure</c> calls for the same named <typeparamref name="TOptions" /> to the underlying service collection.</summary>
  17. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
  18. <typeparam name="TOptions">The options type to be configured.</typeparam>
  19. <returns>The <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> so that configure calls can be chained in it.</returns>
  20. </member>
  21. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.AddOptions``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String)">
  22. <summary>Gets an options builder that forwards <c>Configure</c> calls for the same named <typeparamref name="TOptions" /> to the underlying service collection.</summary>
  23. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
  24. <param name="name">The name of the options instance.</param>
  25. <typeparam name="TOptions">The options type to be configured.</typeparam>
  26. <returns>The <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> so that <c>Configure</c> calls can be chained in it.</returns>
  27. </member>
  28. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})">
  29. <summary>Registers an action used to configure a particular type of options. These are run before <see cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.PostConfigure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})" />.</summary>
  30. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
  31. <param name="configureOptions">The action used to configure the options.</param>
  32. <typeparam name="TOptions">The options type to be configured.</typeparam>
  33. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> so that additional calls can be chained.</returns>
  34. </member>
  35. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.Action{``0})">
  36. <summary>Registers an action used to configure a particular type of options. These are run before <see cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.PostConfigure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})" />.</summary>
  37. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
  38. <param name="name">The name of the options instance.</param>
  39. <param name="configureOptions">The action used to configure the options.</param>
  40. <typeparam name="TOptions">The options type to be configured.</typeparam>
  41. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> so that additional calls can be chained.</returns>
  42. </member>
  43. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.ConfigureAll``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})">
  44. <summary>Registers an action used to configure all instances of a particular type of options.</summary>
  45. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
  46. <param name="configureOptions">The action used to configure the options.</param>
  47. <typeparam name="TOptions">The options type to be configured.</typeparam>
  48. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> so that additional calls can be chained.</returns>
  49. </member>
  50. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.ConfigureOptions(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Object)">
  51. <summary>Registers an object that will have all of its <c>I[Post]ConfigureOptions</c> registered.</summary>
  52. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
  53. <param name="configureInstance">The instance that will configure options.</param>
  54. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> so that additional calls can be chained.</returns>
  55. </member>
  56. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.ConfigureOptions(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Type)">
  57. <summary>Registers a type that will have all of its <c>I[Post]ConfigureOptions</c> registered.</summary>
  58. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
  59. <param name="configureType">The type that will configure options.</param>
  60. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> so that additional calls can be chained.</returns>
  61. </member>
  62. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.ConfigureOptions``1(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
  63. <summary>Registers a type that will have all of its <c>I[Post]ConfigureOptions</c> registered.</summary>
  64. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
  65. <typeparam name="TConfigureOptions">The type that will configure options.</typeparam>
  66. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> so that additional calls can be chained.</returns>
  67. </member>
  68. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.PostConfigure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})">
  69. <summary>Registers an action used to initialize a particular type of options. These are run after <see cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})" />.</summary>
  70. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
  71. <param name="configureOptions">The action used to configure the options.</param>
  72. <typeparam name="TOptions">The options type to be configured.</typeparam>
  73. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> so that additional calls can be chained.</returns>
  74. </member>
  75. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.PostConfigure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.Action{``0})">
  76. <summary>Registers an action used to configure a particular type of options. These are run after <see cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})" />.</summary>
  77. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
  78. <param name="name">The name of the options instance.</param>
  79. <param name="configureOptions">The action used to configure the options.</param>
  80. <typeparam name="TOptions">The options type to be configure.</typeparam>
  81. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> so that additional calls can be chained.</returns>
  82. </member>
  83. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.PostConfigureAll``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})">
  84. <summary>Registers an action used to post configure all instances of a particular type of options. These are run after <see cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})" />.</summary>
  85. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
  86. <param name="configureOptions">The action used to configure the options.</param>
  87. <typeparam name="TOptions">The options type to be configured.</typeparam>
  88. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> so that additional calls can be chained.</returns>
  89. </member>
  90. <member name="T:Microsoft.Extensions.Options.ConfigureNamedOptions`1">
  91. <summary>Implementation of <see cref="T:Microsoft.Extensions.Options.IConfigureNamedOptions`1" />.</summary>
  92. <typeparam name="TOptions">Options type being configured.</typeparam>
  93. </member>
  94. <member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`1.#ctor(System.String,System.Action{`0})">
  95. <summary>Constructor.</summary>
  96. <param name="name">The name of the options.</param>
  97. <param name="action">The action to register.</param>
  98. </member>
  99. <member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`1.Configure(`0)">
  100. <summary>Invoked to configure a <typeparamref name="TOptions" /> instance with the <see cref="F:Microsoft.Extensions.Options.Options.DefaultName" />.</summary>
  101. <param name="options">The options instance to configure.</param>
  102. </member>
  103. <member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`1.Configure(System.String,`0)">
  104. <summary>Invokes the registered configure <see cref="P:Microsoft.Extensions.Options.ConfigureNamedOptions`1.Action" /> if the <paramref name="name" /> matches.</summary>
  105. <param name="name">The name of the options instance being configured.</param>
  106. <param name="options">The options instance to configure.</param>
  107. </member>
  108. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`1.Action">
  109. <summary>The configuration action.</summary>
  110. </member>
  111. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`1.Name">
  112. <summary>The options name.</summary>
  113. </member>
  114. <member name="T:Microsoft.Extensions.Options.ConfigureNamedOptions`2">
  115. <summary>Implementation of <see cref="T:Microsoft.Extensions.Options.IConfigureNamedOptions`1" />.</summary>
  116. <typeparam name="TOptions">Options type being configured.</typeparam>
  117. <typeparam name="TDep">Dependency type.</typeparam>
  118. </member>
  119. <member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`2.#ctor(System.String,`1,System.Action{`0,`1})">
  120. <summary>Constructor.</summary>
  121. <param name="name">The name of the options.</param>
  122. <param name="dependency">A dependency.</param>
  123. <param name="action">The action to register.</param>
  124. </member>
  125. <member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`2.Configure(`0)">
  126. <summary>Invoked to configure a <typeparamref name="TOptions" /> instance with the <see cref="F:Microsoft.Extensions.Options.Options.DefaultName" />.</summary>
  127. <param name="options">The options instance to configure.</param>
  128. </member>
  129. <member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`2.Configure(System.String,`0)">
  130. <summary>Invokes the registered configure <see cref="P:Microsoft.Extensions.Options.ConfigureNamedOptions`2.Action" /> if the <paramref name="name" /> matches.</summary>
  131. <param name="name">The name of the options instance being configured.</param>
  132. <param name="options">The options instance to configure.</param>
  133. </member>
  134. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`2.Action">
  135. <summary>The configuration action.</summary>
  136. </member>
  137. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`2.Dependency">
  138. <summary>The dependency.</summary>
  139. </member>
  140. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`2.Name">
  141. <summary>The options name.</summary>
  142. </member>
  143. <member name="T:Microsoft.Extensions.Options.ConfigureNamedOptions`3">
  144. <summary>Implementation of <see cref="T:Microsoft.Extensions.Options.IConfigureNamedOptions`1" />.</summary>
  145. <typeparam name="TOptions">Options type being configured.</typeparam>
  146. <typeparam name="TDep1">First dependency type.</typeparam>
  147. <typeparam name="TDep2">Second dependency type.</typeparam>
  148. </member>
  149. <member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`3.#ctor(System.String,`1,`2,System.Action{`0,`1,`2})">
  150. <summary>Constructor.</summary>
  151. <param name="name">The name of the options.</param>
  152. <param name="dependency">A dependency.</param>
  153. <param name="dependency2">A second dependency.</param>
  154. <param name="action">The action to register.</param>
  155. </member>
  156. <member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`3.Configure(`0)">
  157. <summary>Invoked to configure a <typeparamref name="TOptions" /> instance with the <see cref="F:Microsoft.Extensions.Options.Options.DefaultName" />.</summary>
  158. <param name="options">The options instance to configure.</param>
  159. </member>
  160. <member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`3.Configure(System.String,`0)">
  161. <summary>Invokes the registered configure <see cref="P:Microsoft.Extensions.Options.ConfigureNamedOptions`3.Action" /> if the <paramref name="name" /> matches.</summary>
  162. <param name="name">The name of the options instance being configured.</param>
  163. <param name="options">The options instance to configure.</param>
  164. </member>
  165. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`3.Action">
  166. <summary>The configuration action.</summary>
  167. </member>
  168. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`3.Dependency1">
  169. <summary>The first dependency.</summary>
  170. </member>
  171. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`3.Dependency2">
  172. <summary>The second dependency.</summary>
  173. </member>
  174. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`3.Name">
  175. <summary>The options name.</summary>
  176. </member>
  177. <member name="T:Microsoft.Extensions.Options.ConfigureNamedOptions`4">
  178. <summary>Implementation of <see cref="T:Microsoft.Extensions.Options.IConfigureNamedOptions`1" />.</summary>
  179. <typeparam name="TOptions">Options type being configured.</typeparam>
  180. <typeparam name="TDep1">First dependency type.</typeparam>
  181. <typeparam name="TDep2">Second dependency type.</typeparam>
  182. <typeparam name="TDep3">Third dependency type.</typeparam>
  183. </member>
  184. <member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`4.#ctor(System.String,`1,`2,`3,System.Action{`0,`1,`2,`3})">
  185. <summary>Constructor.</summary>
  186. <param name="name">The name of the options.</param>
  187. <param name="dependency">A dependency.</param>
  188. <param name="dependency2">A second dependency.</param>
  189. <param name="dependency3">A third dependency.</param>
  190. <param name="action">The action to register.</param>
  191. </member>
  192. <member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`4.Configure(`0)">
  193. <summary>Invoked to configure a <typeparamref name="TOptions" /> instance with the <see cref="F:Microsoft.Extensions.Options.Options.DefaultName" />.</summary>
  194. <param name="options">The options instance to configure.</param>
  195. </member>
  196. <member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`4.Configure(System.String,`0)">
  197. <summary>Invokes the registered configure <see cref="P:Microsoft.Extensions.Options.ConfigureNamedOptions`4.Action" /> if the <paramref name="name" /> matches.</summary>
  198. <param name="name">The name of the options instance being configured.</param>
  199. <param name="options">The options instance to configure.</param>
  200. </member>
  201. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`4.Action">
  202. <summary>The configuration action.</summary>
  203. </member>
  204. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`4.Dependency1">
  205. <summary>The first dependency.</summary>
  206. </member>
  207. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`4.Dependency2">
  208. <summary>The second dependency.</summary>
  209. </member>
  210. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`4.Dependency3">
  211. <summary>The third dependency.</summary>
  212. </member>
  213. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`4.Name">
  214. <summary>The options name.</summary>
  215. </member>
  216. <member name="T:Microsoft.Extensions.Options.ConfigureNamedOptions`5">
  217. <summary>Implementation of <see cref="T:Microsoft.Extensions.Options.IConfigureNamedOptions`1" />.</summary>
  218. <typeparam name="TOptions">Options type being configured.</typeparam>
  219. <typeparam name="TDep1">First dependency type.</typeparam>
  220. <typeparam name="TDep2">Second dependency type.</typeparam>
  221. <typeparam name="TDep3">Third dependency type.</typeparam>
  222. <typeparam name="TDep4">Fourth dependency type.</typeparam>
  223. </member>
  224. <member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`5.#ctor(System.String,`1,`2,`3,`4,System.Action{`0,`1,`2,`3,`4})">
  225. <summary>Constructor.</summary>
  226. <param name="name">The name of the options.</param>
  227. <param name="dependency1">A dependency.</param>
  228. <param name="dependency2">A second dependency.</param>
  229. <param name="dependency3">A third dependency.</param>
  230. <param name="dependency4">A fourth dependency.</param>
  231. <param name="action">The action to register.</param>
  232. </member>
  233. <member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`5.Configure(`0)">
  234. <summary>Invoked to configure a <typeparamref name="TOptions" /> instance with the <see cref="F:Microsoft.Extensions.Options.Options.DefaultName" />.</summary>
  235. <param name="options">The options instance to configure.</param>
  236. </member>
  237. <member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`5.Configure(System.String,`0)">
  238. <summary>Invokes the registered configure <see cref="P:Microsoft.Extensions.Options.ConfigureNamedOptions`5.Action" /> if the <paramref name="name" /> matches.</summary>
  239. <param name="name">The name of the options instance being configured.</param>
  240. <param name="options">The options instance to configure.</param>
  241. </member>
  242. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`5.Action">
  243. <summary>The configuration action.</summary>
  244. </member>
  245. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`5.Dependency1">
  246. <summary>The first dependency.</summary>
  247. </member>
  248. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`5.Dependency2">
  249. <summary>The second dependency.</summary>
  250. </member>
  251. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`5.Dependency3">
  252. <summary>The third dependency.</summary>
  253. </member>
  254. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`5.Dependency4">
  255. <summary>The fourth dependency.</summary>
  256. </member>
  257. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`5.Name">
  258. <summary>The options name.</summary>
  259. </member>
  260. <member name="T:Microsoft.Extensions.Options.ConfigureNamedOptions`6">
  261. <summary>Implementation of <see cref="T:Microsoft.Extensions.Options.IConfigureNamedOptions`1" />.</summary>
  262. <typeparam name="TOptions">Options type being configured.</typeparam>
  263. <typeparam name="TDep1">First dependency type.</typeparam>
  264. <typeparam name="TDep2">Second dependency type.</typeparam>
  265. <typeparam name="TDep3">Third dependency type.</typeparam>
  266. <typeparam name="TDep4">Fourth dependency type.</typeparam>
  267. <typeparam name="TDep5">Fifth dependency type.</typeparam>
  268. </member>
  269. <member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`6.#ctor(System.String,`1,`2,`3,`4,`5,System.Action{`0,`1,`2,`3,`4,`5})">
  270. <summary>Constructor.</summary>
  271. <param name="name">The name of the options.</param>
  272. <param name="dependency1">A dependency.</param>
  273. <param name="dependency2">A second dependency.</param>
  274. <param name="dependency3">A third dependency.</param>
  275. <param name="dependency4">A fourth dependency.</param>
  276. <param name="dependency5">A fifth dependency.</param>
  277. <param name="action">The action to register.</param>
  278. </member>
  279. <member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`6.Configure(`0)">
  280. <summary>Invoked to configure a <typeparamref name="TOptions" /> instance with the <see cref="F:Microsoft.Extensions.Options.Options.DefaultName" />.</summary>
  281. <param name="options">The options instance to configure.</param>
  282. </member>
  283. <member name="M:Microsoft.Extensions.Options.ConfigureNamedOptions`6.Configure(System.String,`0)">
  284. <summary>Invokes the registered configure <see cref="P:Microsoft.Extensions.Options.ConfigureNamedOptions`6.Action" /> if the <paramref name="name" /> matches.</summary>
  285. <param name="name">The name of the options instance being configured.</param>
  286. <param name="options">The options instance to configure.</param>
  287. </member>
  288. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`6.Action">
  289. <summary>The configuration action.</summary>
  290. </member>
  291. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`6.Dependency1">
  292. <summary>The first dependency.</summary>
  293. </member>
  294. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`6.Dependency2">
  295. <summary>The second dependency.</summary>
  296. </member>
  297. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`6.Dependency3">
  298. <summary>The third dependency.</summary>
  299. </member>
  300. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`6.Dependency4">
  301. <summary>The fourth dependency.</summary>
  302. </member>
  303. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`6.Dependency5">
  304. <summary>The fifth dependency.</summary>
  305. </member>
  306. <member name="P:Microsoft.Extensions.Options.ConfigureNamedOptions`6.Name">
  307. <summary>The options name.</summary>
  308. </member>
  309. <member name="T:Microsoft.Extensions.Options.ConfigureOptions`1">
  310. <summary>Implementation of <see cref="T:Microsoft.Extensions.Options.IConfigureOptions`1" />.</summary>
  311. <typeparam name="TOptions">Options type being configured.</typeparam>
  312. </member>
  313. <member name="M:Microsoft.Extensions.Options.ConfigureOptions`1.#ctor(System.Action{`0})">
  314. <summary>Constructor.</summary>
  315. <param name="action">The action to register.</param>
  316. </member>
  317. <member name="M:Microsoft.Extensions.Options.ConfigureOptions`1.Configure(`0)">
  318. <summary>Invokes the registered configure <see cref="P:Microsoft.Extensions.Options.ConfigureOptions`1.Action" />.</summary>
  319. <param name="options">The options instance to configure.</param>
  320. </member>
  321. <member name="P:Microsoft.Extensions.Options.ConfigureOptions`1.Action">
  322. <summary>The configuration action.</summary>
  323. </member>
  324. <member name="T:Microsoft.Extensions.Options.IConfigureNamedOptions`1">
  325. <summary>Represents something that configures the <typeparamref name="TOptions" /> type.</summary>
  326. <typeparam name="TOptions"></typeparam>
  327. </member>
  328. <member name="M:Microsoft.Extensions.Options.IConfigureNamedOptions`1.Configure(System.String,`0)">
  329. <summary>Invoked to configure a <typeparamref name="TOptions" /> instance.</summary>
  330. <param name="name">The name of the options instance being configured.</param>
  331. <param name="options">The options instance to configure.</param>
  332. </member>
  333. <member name="T:Microsoft.Extensions.Options.IConfigureOptions`1">
  334. <summary>Represents something that configures the <typeparamref name="TOptions" /> type.
  335. Note: These are run before all <see cref="T:Microsoft.Extensions.Options.IPostConfigureOptions`1" />.</summary>
  336. <typeparam name="TOptions"></typeparam>
  337. </member>
  338. <member name="M:Microsoft.Extensions.Options.IConfigureOptions`1.Configure(`0)">
  339. <summary>Invoked to configure a <typeparamref name="TOptions" /> instance.</summary>
  340. <param name="options">The options instance to configure.</param>
  341. </member>
  342. <member name="T:Microsoft.Extensions.Options.IOptions`1">
  343. <summary>Used to retrieve configured <typeparamref name="TOptions" /> instances.</summary>
  344. <typeparam name="TOptions">The type of options being requested.</typeparam>
  345. </member>
  346. <member name="P:Microsoft.Extensions.Options.IOptions`1.Value">
  347. <summary>Gets the default configured <typeparamref name="TOptions" /> instance.</summary>
  348. </member>
  349. <member name="T:Microsoft.Extensions.Options.IOptionsChangeTokenSource`1">
  350. <summary>Used to fetch <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> used for tracking options changes.</summary>
  351. <typeparam name="TOptions">Options type.</typeparam>
  352. </member>
  353. <member name="M:Microsoft.Extensions.Options.IOptionsChangeTokenSource`1.GetChangeToken">
  354. <summary>Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> which can be used to register a change notification callback.</summary>
  355. <returns>Change token.</returns>
  356. </member>
  357. <member name="P:Microsoft.Extensions.Options.IOptionsChangeTokenSource`1.Name">
  358. <summary>The name of the option instance being changed.</summary>
  359. </member>
  360. <member name="T:Microsoft.Extensions.Options.IOptionsFactory`1">
  361. <summary>Used to create <typeparamref name="TOptions" /> instances.</summary>
  362. <typeparam name="TOptions">The type of options being requested.</typeparam>
  363. </member>
  364. <member name="M:Microsoft.Extensions.Options.IOptionsFactory`1.Create(System.String)">
  365. <summary>Returns a configured <typeparamref name="TOptions" /> instance with the given name.</summary>
  366. <param name="name" />
  367. </member>
  368. <member name="T:Microsoft.Extensions.Options.IOptionsMonitor`1">
  369. <summary>Used for notifications when <typeparamref name="TOptions" /> instances change.</summary>
  370. <typeparam name="TOptions">The options type.</typeparam>
  371. </member>
  372. <member name="M:Microsoft.Extensions.Options.IOptionsMonitor`1.Get(System.String)">
  373. <summary>Returns a configured <typeparamref name="TOptions" /> instance with the given name.</summary>
  374. <param name="name" />
  375. </member>
  376. <member name="M:Microsoft.Extensions.Options.IOptionsMonitor`1.OnChange(System.Action{`0,System.String})">
  377. <summary>Registers a listener to be called whenever a named <typeparamref name="TOptions" /> changes.</summary>
  378. <param name="listener">The action to be invoked when <typeparamref name="TOptions" /> has changed.</param>
  379. <returns>An <see cref="T:System.IDisposable" /> which should be disposed to stop listening for changes.</returns>
  380. </member>
  381. <member name="P:Microsoft.Extensions.Options.IOptionsMonitor`1.CurrentValue">
  382. <summary>Returns the current <typeparamref name="TOptions" /> instance with the <see cref="F:Microsoft.Extensions.Options.Options.DefaultName" />.</summary>
  383. </member>
  384. <member name="T:Microsoft.Extensions.Options.IOptionsMonitorCache`1">
  385. <summary>Used by <see cref="T:Microsoft.Extensions.Options.IOptionsMonitor`1" /> to cache <typeparamref name="TOptions" /> instances.</summary>
  386. <typeparam name="TOptions">The type of options being requested.</typeparam>
  387. </member>
  388. <member name="M:Microsoft.Extensions.Options.IOptionsMonitorCache`1.Clear">
  389. <summary>Clears all options instances from the cache.</summary>
  390. </member>
  391. <member name="M:Microsoft.Extensions.Options.IOptionsMonitorCache`1.GetOrAdd(System.String,System.Func{`0})">
  392. <summary>Gets a named options instance, or adds a new instance created with <paramref name="createOptions" />.</summary>
  393. <param name="name">The name of the options instance.</param>
  394. <param name="createOptions">The func used to create the new instance.</param>
  395. <returns>The options instance.</returns>
  396. </member>
  397. <member name="M:Microsoft.Extensions.Options.IOptionsMonitorCache`1.TryAdd(System.String,`0)">
  398. <summary>Tries to adds a new option to the cache, will return false if the name already exists.</summary>
  399. <param name="name">The name of the options instance.</param>
  400. <param name="options">The options instance.</param>
  401. <returns>Whether anything was added.</returns>
  402. </member>
  403. <member name="M:Microsoft.Extensions.Options.IOptionsMonitorCache`1.TryRemove(System.String)">
  404. <summary>Try to remove an options instance.</summary>
  405. <param name="name">The name of the options instance.</param>
  406. <returns>Whether anything was removed.</returns>
  407. </member>
  408. <member name="T:Microsoft.Extensions.Options.IOptionsSnapshot`1">
  409. <summary>Used to access the value of <typeparamref name="TOptions" /> for the lifetime of a request.</summary>
  410. <typeparam name="TOptions">Options type.</typeparam>
  411. </member>
  412. <member name="M:Microsoft.Extensions.Options.IOptionsSnapshot`1.Get(System.String)">
  413. <summary>Returns a configured <typeparamref name="TOptions" /> instance with the given name.</summary>
  414. <param name="name" />
  415. </member>
  416. <member name="T:Microsoft.Extensions.Options.IPostConfigureOptions`1">
  417. <summary>Represents something that configures the <typeparamref name="TOptions" /> type.
  418. Note: These are run after all <see cref="T:Microsoft.Extensions.Options.IConfigureOptions`1" />.</summary>
  419. <typeparam name="TOptions">Options type being configured.</typeparam>
  420. </member>
  421. <member name="M:Microsoft.Extensions.Options.IPostConfigureOptions`1.PostConfigure(System.String,`0)">
  422. <summary>Invoked to configure a <typeparamref name="TOptions" /> instance.</summary>
  423. <param name="name">The name of the options instance being configured.</param>
  424. <param name="options">The options instance to configured.</param>
  425. </member>
  426. <member name="T:Microsoft.Extensions.Options.IValidateOptions`1">
  427. <summary>Interface used to validate options.</summary>
  428. <typeparam name="TOptions">The options type to validate.</typeparam>
  429. </member>
  430. <member name="M:Microsoft.Extensions.Options.IValidateOptions`1.Validate(System.String,`0)">
  431. <summary>Validates a specific named options instance (or all when name is null).</summary>
  432. <param name="name">The name of the options instance being validated.</param>
  433. <param name="options">The options instance.</param>
  434. <returns>The <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult" /> result.</returns>
  435. </member>
  436. <member name="T:Microsoft.Extensions.Options.Options">
  437. <summary>Helper class.</summary>
  438. </member>
  439. <member name="F:Microsoft.Extensions.Options.Options.DefaultName">
  440. <summary>The default name used for options instances: "".</summary>
  441. </member>
  442. <member name="M:Microsoft.Extensions.Options.Options.Create``1(``0)">
  443. <summary>Creates a wrapper around an instance of <typeparamref name="TOptions" /> to return itself as an <see cref="T:Microsoft.Extensions.Options.IOptions`1" />.</summary>
  444. <param name="options">Options object.</param>
  445. <typeparam name="TOptions">Options type.</typeparam>
  446. <returns>Wrapped options object.</returns>
  447. </member>
  448. <member name="T:Microsoft.Extensions.Options.OptionsBuilder`1">
  449. <summary>Used to configure <typeparamref name="TOptions" /> instances.</summary>
  450. <typeparam name="TOptions">The type of options being requested.</typeparam>
  451. </member>
  452. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.#ctor(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String)">
  453. <summary>Constructor.</summary>
  454. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> for the options being configured.</param>
  455. <param name="name">The default name of the <typeparamref name="TOptions" /> instance, if null <see cref="F:Microsoft.Extensions.Options.Options.DefaultName" /> is used.</param>
  456. </member>
  457. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure(System.Action{`0})">
  458. <summary>Registers an action used to configure a particular type of options. These are run before all <see cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure(System.Action{`0})" />.</summary>
  459. <param name="configureOptions">The action used to configure the options.</param>
  460. <returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</returns>
  461. </member>
  462. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure``1(System.Action{`0,``0})">
  463. <summary>Registers an action used to configure a particular type of options. These are run before all <see cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure(System.Action{`0})" />.</summary>
  464. <param name="configureOptions">The action used to configure the options.</param>
  465. <typeparam name="TDep">A dependency used by the action.</typeparam>
  466. <returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</returns>
  467. </member>
  468. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure``2(System.Action{`0,``0,``1})">
  469. <summary>Registers an action used to configure a particular type of options. These are run before all <see cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure(System.Action{`0})" />.</summary>
  470. <param name="configureOptions">The action used to configure the options.</param>
  471. <typeparam name="TDep1">The first dependency used by the action.</typeparam>
  472. <typeparam name="TDep2">The second dependency used by the action.</typeparam>
  473. <returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</returns>
  474. </member>
  475. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure``3(System.Action{`0,``0,``1,``2})">
  476. <summary>Registers an action used to configure a particular type of options. These are run before all <see cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure(System.Action{`0})" />.</summary>
  477. <param name="configureOptions">The action used to configure the options.</param>
  478. <typeparam name="TDep1">The first dependency used by the action.</typeparam>
  479. <typeparam name="TDep2">The second dependency used by the action.</typeparam>
  480. <typeparam name="TDep3">The third dependency used by the action.</typeparam>
  481. <returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</returns>
  482. </member>
  483. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure``4(System.Action{`0,``0,``1,``2,``3})">
  484. <summary>Registers an action used to configure a particular type of options. These are run before all <see cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure(System.Action{`0})" />.</summary>
  485. <param name="configureOptions">The action used to configure the options.</param>
  486. <typeparam name="TDep1">The first dependency used by the action.</typeparam>
  487. <typeparam name="TDep2">The second dependency used by the action.</typeparam>
  488. <typeparam name="TDep3">The third dependency used by the action.</typeparam>
  489. <typeparam name="TDep4">The fourth dependency used by the action.</typeparam>
  490. <returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</returns>
  491. </member>
  492. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure``5(System.Action{`0,``0,``1,``2,``3,``4})">
  493. <summary>Registers an action used to configure a particular type of options. These are run before all <see cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure(System.Action{`0})" />.</summary>
  494. <param name="configureOptions">The action used to configure the options.</param>
  495. <typeparam name="TDep1">The first dependency used by the action.</typeparam>
  496. <typeparam name="TDep2">The second dependency used by the action.</typeparam>
  497. <typeparam name="TDep3">The third dependency used by the action.</typeparam>
  498. <typeparam name="TDep4">The fourth dependency used by the action.</typeparam>
  499. <typeparam name="TDep5">The fifth dependency used by the action.</typeparam>
  500. <returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</returns>
  501. </member>
  502. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure(System.Action{`0})">
  503. <summary>Registers an action used to configure a particular type of options. These are run after all <see cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure(System.Action{`0})" />.</summary>
  504. <param name="configureOptions">The action used to configure the options.</param>
  505. </member>
  506. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure``1(System.Action{`0,``0})">
  507. <summary>Registers an action used to post configure a particular type of options. These are run after all <see cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure(System.Action{`0})" />.</summary>
  508. <param name="configureOptions">The action used to configure the options.</param>
  509. <typeparam name="TDep">The dependency used by the action.</typeparam>
  510. <returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</returns>
  511. </member>
  512. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure``2(System.Action{`0,``0,``1})">
  513. <summary>Registers an action used to post configure a particular type of options. These are run after all <see cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure(System.Action{`0})" />.</summary>
  514. <param name="configureOptions">The action used to configure the options.</param>
  515. <typeparam name="TDep1">The first dependency used by the action.</typeparam>
  516. <typeparam name="TDep2">The second dependency used by the action.</typeparam>
  517. <returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</returns>
  518. </member>
  519. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure``3(System.Action{`0,``0,``1,``2})">
  520. <summary>Registers an action used to post configure a particular type of options. These are run after all <see cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure(System.Action{`0})" />.</summary>
  521. <param name="configureOptions">The action used to configure the options.</param>
  522. <typeparam name="TDep1">The first dependency used by the action.</typeparam>
  523. <typeparam name="TDep2">The second dependency used by the action.</typeparam>
  524. <typeparam name="TDep3">The third dependency used by the action.</typeparam>
  525. <returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</returns>
  526. </member>
  527. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure``4(System.Action{`0,``0,``1,``2,``3})">
  528. <summary>Registers an action used to post configure a particular type of options. These are run after all <see cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure(System.Action{`0})" />.</summary>
  529. <param name="configureOptions">The action used to configure the options.</param>
  530. <typeparam name="TDep1">The first dependency used by the action.</typeparam>
  531. <typeparam name="TDep2">The second dependency used by the action.</typeparam>
  532. <typeparam name="TDep3">The third dependency used by the action.</typeparam>
  533. <typeparam name="TDep4">The fourth dependency used by the action.</typeparam>
  534. <returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</returns>
  535. </member>
  536. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure``5(System.Action{`0,``0,``1,``2,``3,``4})">
  537. <summary>Registers an action used to post configure a particular type of options. These are run after all <see cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure(System.Action{`0})" />.</summary>
  538. <param name="configureOptions">The action used to configure the options.</param>
  539. <typeparam name="TDep1">The first dependency used by the action.</typeparam>
  540. <typeparam name="TDep2">The second dependency used by the action.</typeparam>
  541. <typeparam name="TDep3">The third dependency used by the action.</typeparam>
  542. <typeparam name="TDep4">The fourth dependency used by the action.</typeparam>
  543. <typeparam name="TDep5">The fifth dependency used by the action.</typeparam>
  544. <returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</returns>
  545. </member>
  546. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Validate(System.Func{`0,System.Boolean})">
  547. <summary>Register a validation action for an options type using a default failure message.</summary>
  548. <param name="validation">The validation function.</param>
  549. <returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</returns>
  550. </member>
  551. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Validate(System.Func{`0,System.Boolean},System.String)">
  552. <summary>Register a validation action for an options type.</summary>
  553. <param name="validation">The validation function.</param>
  554. <param name="failureMessage">The failure message to use when validation fails.</param>
  555. <returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</returns>
  556. </member>
  557. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Validate``1(System.Func{`0,``0,System.Boolean})">
  558. <summary>Register a validation action for an options type using a default failure message.</summary>
  559. <param name="validation">The validation function.</param>
  560. <typeparam name="TDep">The dependency used by the validation function.</typeparam>
  561. <returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</returns>
  562. </member>
  563. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Validate``1(System.Func{`0,``0,System.Boolean},System.String)">
  564. <summary>Register a validation action for an options type.</summary>
  565. <param name="validation">The validation function.</param>
  566. <param name="failureMessage">The failure message to use when validation fails.</param>
  567. <typeparam name="TDep">The dependency used by the validation function.</typeparam>
  568. <returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</returns>
  569. </member>
  570. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Validate``2(System.Func{`0,``0,``1,System.Boolean})">
  571. <summary>Register a validation action for an options type using a default failure message.</summary>
  572. <param name="validation">The validation function.</param>
  573. <typeparam name="TDep1">The first dependency used by the validation function.</typeparam>
  574. <typeparam name="TDep2">The second dependency used by the validation function.</typeparam>
  575. <returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</returns>
  576. </member>
  577. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Validate``2(System.Func{`0,``0,``1,System.Boolean},System.String)">
  578. <summary>Register a validation action for an options type.</summary>
  579. <param name="validation">The validation function.</param>
  580. <param name="failureMessage">The failure message to use when validation fails.</param>
  581. <typeparam name="TDep1">The first dependency used by the validation function.</typeparam>
  582. <typeparam name="TDep2">The second dependency used by the validation function.</typeparam>
  583. <returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</returns>
  584. </member>
  585. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Validate``3(System.Func{`0,``0,``1,``2,System.Boolean})">
  586. <summary>Register a validation action for an options type using a default failure message.</summary>
  587. <param name="validation">The validation function.</param>
  588. <typeparam name="TDep1">The first dependency used by the validation function.</typeparam>
  589. <typeparam name="TDep2">The second dependency used by the validation function.</typeparam>
  590. <typeparam name="TDep3">The third dependency used by the validation function.</typeparam>
  591. <returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</returns>
  592. </member>
  593. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Validate``3(System.Func{`0,``0,``1,``2,System.Boolean},System.String)">
  594. <summary>Register a validation action for an options type.</summary>
  595. <param name="validation">The validation function.</param>
  596. <param name="failureMessage">The failure message to use when validation fails.</param>
  597. <typeparam name="TDep1">The first dependency used by the validation function.</typeparam>
  598. <typeparam name="TDep2">The second dependency used by the validation function.</typeparam>
  599. <typeparam name="TDep3">The third dependency used by the validation function.</typeparam>
  600. <returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</returns>
  601. </member>
  602. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Validate``4(System.Func{`0,``0,``1,``2,``3,System.Boolean})">
  603. <summary>Register a validation action for an options type using a default failure message.</summary>
  604. <param name="validation">The validation function.</param>
  605. <typeparam name="TDep1">The first dependency used by the validation function.</typeparam>
  606. <typeparam name="TDep2">The second dependency used by the validation function.</typeparam>
  607. <typeparam name="TDep3">The third dependency used by the validation function.</typeparam>
  608. <typeparam name="TDep4">The fourth dependency used by the validation function.</typeparam>
  609. <returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</returns>
  610. </member>
  611. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Validate``4(System.Func{`0,``0,``1,``2,``3,System.Boolean},System.String)">
  612. <summary>Register a validation action for an options type.</summary>
  613. <param name="validation">The validation function.</param>
  614. <param name="failureMessage">The failure message to use when validation fails.</param>
  615. <typeparam name="TDep1">The first dependency used by the validation function.</typeparam>
  616. <typeparam name="TDep2">The second dependency used by the validation function.</typeparam>
  617. <typeparam name="TDep3">The third dependency used by the validation function.</typeparam>
  618. <typeparam name="TDep4">The fourth dependency used by the validation function.</typeparam>
  619. <returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</returns>
  620. </member>
  621. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Validate``5(System.Func{`0,``0,``1,``2,``3,``4,System.Boolean})">
  622. <summary>Register a validation action for an options type using a default failure message.</summary>
  623. <param name="validation">The validation function.</param>
  624. <typeparam name="TDep1">The first dependency used by the validation function.</typeparam>
  625. <typeparam name="TDep2">The second dependency used by the validation function.</typeparam>
  626. <typeparam name="TDep3">The third dependency used by the validation function.</typeparam>
  627. <typeparam name="TDep4">The fourth dependency used by the validation function.</typeparam>
  628. <typeparam name="TDep5">The fifth dependency used by the validation function.</typeparam>
  629. <returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</returns>
  630. </member>
  631. <member name="M:Microsoft.Extensions.Options.OptionsBuilder`1.Validate``5(System.Func{`0,``0,``1,``2,``3,``4,System.Boolean},System.String)">
  632. <summary>Register a validation action for an options type.</summary>
  633. <param name="validation">The validation function.</param>
  634. <param name="failureMessage">The failure message to use when validation fails.</param>
  635. <typeparam name="TDep1">The first dependency used by the validation function.</typeparam>
  636. <typeparam name="TDep2">The second dependency used by the validation function.</typeparam>
  637. <typeparam name="TDep3">The third dependency used by the validation function.</typeparam>
  638. <typeparam name="TDep4">The fourth dependency used by the validation function.</typeparam>
  639. <typeparam name="TDep5">The fifth dependency used by the validation function.</typeparam>
  640. <returns>The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</returns>
  641. </member>
  642. <member name="P:Microsoft.Extensions.Options.OptionsBuilder`1.Name">
  643. <summary>The default name of the <typeparamref name="TOptions" /> instance.</summary>
  644. </member>
  645. <member name="P:Microsoft.Extensions.Options.OptionsBuilder`1.Services">
  646. <summary>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> for the options being configured.</summary>
  647. </member>
  648. <member name="T:Microsoft.Extensions.Options.OptionsCache`1">
  649. <summary>Used to cache <typeparamref name="TOptions" /> instances.</summary>
  650. <typeparam name="TOptions">The type of options being requested.</typeparam>
  651. </member>
  652. <member name="M:Microsoft.Extensions.Options.OptionsCache`1.#ctor" />
  653. <member name="M:Microsoft.Extensions.Options.OptionsCache`1.Clear">
  654. <summary>Clears all options instances from the cache.</summary>
  655. </member>
  656. <member name="M:Microsoft.Extensions.Options.OptionsCache`1.GetOrAdd(System.String,System.Func{`0})">
  657. <summary>Gets a named options instance, or adds a new instance created with <paramref name="createOptions" />.</summary>
  658. <param name="name">The name of the options instance.</param>
  659. <param name="createOptions">The func used to create the new instance.</param>
  660. <returns>The options instance.</returns>
  661. </member>
  662. <member name="M:Microsoft.Extensions.Options.OptionsCache`1.TryAdd(System.String,`0)">
  663. <summary>Tries to adds a new option to the cache, will return false if the name already exists.</summary>
  664. <param name="name">The name of the options instance.</param>
  665. <param name="options">The options instance.</param>
  666. <returns>Whether anything was added.</returns>
  667. </member>
  668. <member name="M:Microsoft.Extensions.Options.OptionsCache`1.TryRemove(System.String)">
  669. <summary>Try to remove an options instance.</summary>
  670. <param name="name">The name of the options instance.</param>
  671. <returns>Whether anything was removed.</returns>
  672. </member>
  673. <member name="T:Microsoft.Extensions.Options.OptionsFactory`1">
  674. <summary>Implementation of <see cref="T:Microsoft.Extensions.Options.IOptionsFactory`1" />.</summary>
  675. <typeparam name="TOptions">The type of options being requested.</typeparam>
  676. </member>
  677. <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}})">
  678. <summary>Initializes a new instance with the specified options configurations.</summary>
  679. <param name="setups">The configuration actions to run.</param>
  680. <param name="postConfigures">The initialization actions to run.</param>
  681. </member>
  682. <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}},System.Collections.Generic.IEnumerable{Microsoft.Extensions.Options.IValidateOptions{`0}})">
  683. <summary>Initializes a new instance with the specified options configurations.</summary>
  684. <param name="setups">The configuration actions to run.</param>
  685. <param name="postConfigures">The initialization actions to run.</param>
  686. <param name="validations">The validations to run.</param>
  687. </member>
  688. <member name="M:Microsoft.Extensions.Options.OptionsFactory`1.Create(System.String)">
  689. <summary>Returns a configured <typeparamref name="TOptions" /> instance with the given <paramref name="name" />.</summary>
  690. <param name="name" />
  691. </member>
  692. <member name="M:Microsoft.Extensions.Options.OptionsFactory`1.CreateInstance(System.String)">
  693. <param name="name" />
  694. </member>
  695. <member name="T:Microsoft.Extensions.Options.OptionsManager`1">
  696. <summary>Implementation of <see cref="T:Microsoft.Extensions.Options.IOptions`1" /> and <see cref="T:Microsoft.Extensions.Options.IOptionsSnapshot`1" />.</summary>
  697. <typeparam name="TOptions">Options type.</typeparam>
  698. </member>
  699. <member name="M:Microsoft.Extensions.Options.OptionsManager`1.#ctor(Microsoft.Extensions.Options.IOptionsFactory{`0})">
  700. <summary>Initializes a new instance with the specified options configurations.</summary>
  701. <param name="factory">The factory to use to create options.</param>
  702. </member>
  703. <member name="M:Microsoft.Extensions.Options.OptionsManager`1.Get(System.String)">
  704. <summary>Returns a configured <typeparamref name="TOptions" /> instance with the given <paramref name="name" />.</summary>
  705. <param name="name" />
  706. </member>
  707. <member name="P:Microsoft.Extensions.Options.OptionsManager`1.Value">
  708. <summary>The default configured <typeparamref name="TOptions" /> instance, equivalent to Get(Options.DefaultName).</summary>
  709. </member>
  710. <member name="T:Microsoft.Extensions.Options.OptionsMonitor`1">
  711. <summary>Implementation of <see cref="T:Microsoft.Extensions.Options.IOptionsMonitor`1" />.</summary>
  712. <typeparam name="TOptions">Options type.</typeparam>
  713. </member>
  714. <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})">
  715. <summary>Constructor.</summary>
  716. <param name="factory">The factory to use to create options.</param>
  717. <param name="sources">The sources used to listen for changes to the options instance.</param>
  718. <param name="cache">The cache used to store options.</param>
  719. </member>
  720. <member name="M:Microsoft.Extensions.Options.OptionsMonitor`1.Dispose">
  721. <summary>Removes all change registration subscriptions.</summary>
  722. </member>
  723. <member name="M:Microsoft.Extensions.Options.OptionsMonitor`1.Get(System.String)">
  724. <summary>Returns a configured <typeparamref name="TOptions" /> instance with the given <paramref name="name" />.</summary>
  725. <param name="name" />
  726. </member>
  727. <member name="M:Microsoft.Extensions.Options.OptionsMonitor`1.OnChange(System.Action{`0,System.String})">
  728. <summary>Registers a listener to be called whenever <typeparamref name="TOptions" /> changes.</summary>
  729. <param name="listener">The action to be invoked when <typeparamref name="TOptions" /> has changed.</param>
  730. <returns>An <see cref="T:System.IDisposable" /> which should be disposed to stop listening for changes.</returns>
  731. </member>
  732. <member name="P:Microsoft.Extensions.Options.OptionsMonitor`1.CurrentValue">
  733. <summary>The present value of the options.</summary>
  734. </member>
  735. <member name="T:Microsoft.Extensions.Options.OptionsMonitorExtensions">
  736. <summary>Extension methods for <see cref="T:Microsoft.Extensions.Options.IOptionsMonitor`1" />.</summary>
  737. </member>
  738. <member name="M:Microsoft.Extensions.Options.OptionsMonitorExtensions.OnChange``1(Microsoft.Extensions.Options.IOptionsMonitor{``0},System.Action{``0})">
  739. <summary>Registers a listener to be called whenever <typeparamref name="TOptions" /> changes.</summary>
  740. <param name="monitor">The IOptionsMonitor.</param>
  741. <param name="listener">The action to be invoked when <typeparamref name="TOptions" /> has changed.</param>
  742. <typeparam name="TOptions" />
  743. <returns>An <see cref="T:System.IDisposable" /> which should be disposed to stop listening for changes.</returns>
  744. </member>
  745. <member name="T:Microsoft.Extensions.Options.OptionsValidationException">
  746. <summary>Thrown when options validation fails.</summary>
  747. </member>
  748. <member name="M:Microsoft.Extensions.Options.OptionsValidationException.#ctor(System.String,System.Type,System.Collections.Generic.IEnumerable{System.String})">
  749. <summary>Constructor.</summary>
  750. <param name="optionsName">The name of the options instance that failed.</param>
  751. <param name="optionsType">The options type that failed.</param>
  752. <param name="failureMessages">The validation failure messages.</param>
  753. </member>
  754. <member name="P:Microsoft.Extensions.Options.OptionsValidationException.Failures">
  755. <summary>The validation failures.</summary>
  756. </member>
  757. <member name="P:Microsoft.Extensions.Options.OptionsValidationException.Message">
  758. <summary>The message is a semicolon separated list of the <see cref="P:Microsoft.Extensions.Options.OptionsValidationException.Failures" />.</summary>
  759. </member>
  760. <member name="P:Microsoft.Extensions.Options.OptionsValidationException.OptionsName">
  761. <summary>The name of the options instance that failed.</summary>
  762. </member>
  763. <member name="P:Microsoft.Extensions.Options.OptionsValidationException.OptionsType">
  764. <summary>The type of the options that failed.</summary>
  765. </member>
  766. <member name="T:Microsoft.Extensions.Options.OptionsWrapper`1">
  767. <summary>
  768. <see cref="T:Microsoft.Extensions.Options.IOptions`1" /> wrapper that returns the options instance.</summary>
  769. <typeparam name="TOptions">Options type.</typeparam>
  770. </member>
  771. <member name="M:Microsoft.Extensions.Options.OptionsWrapper`1.#ctor(`0)">
  772. <summary>Intializes the wrapper with the options instance to return.</summary>
  773. <param name="options">The options instance to return.</param>
  774. </member>
  775. <member name="P:Microsoft.Extensions.Options.OptionsWrapper`1.Value">
  776. <summary>The options instance.</summary>
  777. </member>
  778. <member name="T:Microsoft.Extensions.Options.PostConfigureOptions`1">
  779. <summary>Implementation of <see cref="T:Microsoft.Extensions.Options.IPostConfigureOptions`1" />.</summary>
  780. <typeparam name="TOptions">Options type being configured.</typeparam>
  781. </member>
  782. <member name="M:Microsoft.Extensions.Options.PostConfigureOptions`1.#ctor(System.String,System.Action{`0})">
  783. <summary>Creates a new instance of <see cref="T:Microsoft.Extensions.Options.PostConfigureOptions`1" />.</summary>
  784. <param name="name">The name of the options.</param>
  785. <param name="action">The action to register.</param>
  786. </member>
  787. <member name="M:Microsoft.Extensions.Options.PostConfigureOptions`1.PostConfigure(System.String,`0)">
  788. <summary>Invokes the registered initialization <see cref="P:Microsoft.Extensions.Options.PostConfigureOptions`1.Action" /> if the <paramref name="name" /> matches.</summary>
  789. <param name="name">The name of the action to invoke.</param>
  790. <param name="options">The options to use in initialization.</param>
  791. </member>
  792. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`1.Action">
  793. <summary>The initialization action.</summary>
  794. </member>
  795. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`1.Name">
  796. <summary>The options name.</summary>
  797. </member>
  798. <member name="T:Microsoft.Extensions.Options.PostConfigureOptions`2">
  799. <summary>Implementation of <see cref="T:Microsoft.Extensions.Options.IPostConfigureOptions`1" />.</summary>
  800. <typeparam name="TOptions">Options type being configured.</typeparam>
  801. <typeparam name="TDep">Dependency type.</typeparam>
  802. </member>
  803. <member name="M:Microsoft.Extensions.Options.PostConfigureOptions`2.#ctor(System.String,`1,System.Action{`0,`1})">
  804. <summary>Constructor.</summary>
  805. <param name="name">The name of the options.</param>
  806. <param name="dependency">A dependency.</param>
  807. <param name="action">The action to register.</param>
  808. </member>
  809. <member name="M:Microsoft.Extensions.Options.PostConfigureOptions`2.PostConfigure(`0)">
  810. <summary>Invoked to configure a <typeparamref name="TOptions" /> instance using the <see cref="F:Microsoft.Extensions.Options.Options.DefaultName" />.</summary>
  811. <param name="options">The options instance to configured.</param>
  812. </member>
  813. <member name="M:Microsoft.Extensions.Options.PostConfigureOptions`2.PostConfigure(System.String,`0)">
  814. <summary>Invokes the registered initialization <see cref="P:Microsoft.Extensions.Options.PostConfigureOptions`2.Action" /> if the <paramref name="name" /> matches.</summary>
  815. <param name="name">The name of the options instance being configured.</param>
  816. <param name="options">The options instance to configured.</param>
  817. </member>
  818. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`2.Action">
  819. <summary>The configuration action.</summary>
  820. </member>
  821. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`2.Dependency">
  822. <summary>The dependency.</summary>
  823. </member>
  824. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`2.Name">
  825. <summary>The options name.</summary>
  826. </member>
  827. <member name="T:Microsoft.Extensions.Options.PostConfigureOptions`3">
  828. <summary>Implementation of <see cref="T:Microsoft.Extensions.Options.IPostConfigureOptions`1" />.</summary>
  829. <typeparam name="TOptions">Options type being configured.</typeparam>
  830. <typeparam name="TDep1">First dependency type.</typeparam>
  831. <typeparam name="TDep2">Second dependency type.</typeparam>
  832. </member>
  833. <member name="M:Microsoft.Extensions.Options.PostConfigureOptions`3.#ctor(System.String,`1,`2,System.Action{`0,`1,`2})">
  834. <summary>Constructor.</summary>
  835. <param name="name">The name of the options.</param>
  836. <param name="dependency">A dependency.</param>
  837. <param name="dependency2">A second dependency.</param>
  838. <param name="action">The action to register.</param>
  839. </member>
  840. <member name="M:Microsoft.Extensions.Options.PostConfigureOptions`3.PostConfigure(`0)">
  841. <summary>Invoked to configure a <typeparamref name="TOptions" /> instance using the <see cref="F:Microsoft.Extensions.Options.Options.DefaultName" />.</summary>
  842. <param name="options">The options instance to configured.</param>
  843. </member>
  844. <member name="M:Microsoft.Extensions.Options.PostConfigureOptions`3.PostConfigure(System.String,`0)">
  845. <summary>Invokes the registered initialization <see cref="P:Microsoft.Extensions.Options.PostConfigureOptions`3.Action" /> if the <paramref name="name" /> matches.</summary>
  846. <param name="name">The name of the options instance being configured.</param>
  847. <param name="options">The options instance to configured.</param>
  848. </member>
  849. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`3.Action">
  850. <summary>The configuration action.</summary>
  851. </member>
  852. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`3.Dependency1">
  853. <summary>The first dependency.</summary>
  854. </member>
  855. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`3.Dependency2">
  856. <summary>The second dependency.</summary>
  857. </member>
  858. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`3.Name">
  859. <summary>The options name.</summary>
  860. </member>
  861. <member name="T:Microsoft.Extensions.Options.PostConfigureOptions`4">
  862. <summary>Implementation of <see cref="T:Microsoft.Extensions.Options.IPostConfigureOptions`1" />.</summary>
  863. <typeparam name="TOptions">Options type being configured.</typeparam>
  864. <typeparam name="TDep1">First dependency type.</typeparam>
  865. <typeparam name="TDep2">Second dependency type.</typeparam>
  866. <typeparam name="TDep3">Third dependency type.</typeparam>
  867. </member>
  868. <member name="M:Microsoft.Extensions.Options.PostConfigureOptions`4.#ctor(System.String,`1,`2,`3,System.Action{`0,`1,`2,`3})">
  869. <summary>Constructor.</summary>
  870. <param name="name">The name of the options.</param>
  871. <param name="dependency">A dependency.</param>
  872. <param name="dependency2">A second dependency.</param>
  873. <param name="dependency3">A third dependency.</param>
  874. <param name="action">The action to register.</param>
  875. </member>
  876. <member name="M:Microsoft.Extensions.Options.PostConfigureOptions`4.PostConfigure(`0)">
  877. <summary>Invoked to configure a <typeparamref name="TOptions" /> instance using the <see cref="F:Microsoft.Extensions.Options.Options.DefaultName" />.</summary>
  878. <param name="options">The options instance to configured.</param>
  879. </member>
  880. <member name="M:Microsoft.Extensions.Options.PostConfigureOptions`4.PostConfigure(System.String,`0)">
  881. <summary>Invokes the registered initialization <see cref="P:Microsoft.Extensions.Options.PostConfigureOptions`4.Action" /> if the <paramref name="name" /> matches.</summary>
  882. <param name="name">The name of the options instance being configured.</param>
  883. <param name="options">The options instance to configured.</param>
  884. </member>
  885. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`4.Action">
  886. <summary>The configuration action.</summary>
  887. </member>
  888. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`4.Dependency1">
  889. <summary>The first dependency.</summary>
  890. </member>
  891. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`4.Dependency2">
  892. <summary>The second dependency.</summary>
  893. </member>
  894. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`4.Dependency3">
  895. <summary>The third dependency.</summary>
  896. </member>
  897. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`4.Name">
  898. <summary>The options name.</summary>
  899. </member>
  900. <member name="T:Microsoft.Extensions.Options.PostConfigureOptions`5">
  901. <summary>Implementation of <see cref="T:Microsoft.Extensions.Options.IPostConfigureOptions`1" />.</summary>
  902. <typeparam name="TOptions">Options type being configured.</typeparam>
  903. <typeparam name="TDep1">First dependency type.</typeparam>
  904. <typeparam name="TDep2">Second dependency type.</typeparam>
  905. <typeparam name="TDep3">Third dependency type.</typeparam>
  906. <typeparam name="TDep4">Fourth dependency type.</typeparam>
  907. </member>
  908. <member name="M:Microsoft.Extensions.Options.PostConfigureOptions`5.#ctor(System.String,`1,`2,`3,`4,System.Action{`0,`1,`2,`3,`4})">
  909. <summary>Constructor.</summary>
  910. <param name="name">The name of the options.</param>
  911. <param name="dependency1">A dependency.</param>
  912. <param name="dependency2">A second dependency.</param>
  913. <param name="dependency3">A third dependency.</param>
  914. <param name="dependency4">A fourth dependency.</param>
  915. <param name="action">The action to register.</param>
  916. </member>
  917. <member name="M:Microsoft.Extensions.Options.PostConfigureOptions`5.PostConfigure(`0)">
  918. <summary>Invoked to configure a <typeparamref name="TOptions" /> instance using the <see cref="F:Microsoft.Extensions.Options.Options.DefaultName" />.</summary>
  919. <param name="options">The options instance to configured.</param>
  920. </member>
  921. <member name="M:Microsoft.Extensions.Options.PostConfigureOptions`5.PostConfigure(System.String,`0)">
  922. <summary>Invokes the registered initialization <see cref="P:Microsoft.Extensions.Options.PostConfigureOptions`5.Action" /> if the <paramref name="name" /> matches.</summary>
  923. <param name="name">The name of the options instance being configured.</param>
  924. <param name="options">The options instance to configured.</param>
  925. </member>
  926. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`5.Action">
  927. <summary>The configuration action.</summary>
  928. </member>
  929. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`5.Dependency1">
  930. <summary>The first dependency.</summary>
  931. </member>
  932. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`5.Dependency2">
  933. <summary>The second dependency.</summary>
  934. </member>
  935. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`5.Dependency3">
  936. <summary>The third dependency.</summary>
  937. </member>
  938. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`5.Dependency4">
  939. <summary>The fourth dependency.</summary>
  940. </member>
  941. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`5.Name">
  942. <summary>The options name.</summary>
  943. </member>
  944. <member name="T:Microsoft.Extensions.Options.PostConfigureOptions`6">
  945. <summary>Implementation of <see cref="T:Microsoft.Extensions.Options.IPostConfigureOptions`1" />.</summary>
  946. <typeparam name="TOptions">Options type being configured.</typeparam>
  947. <typeparam name="TDep1">First dependency type.</typeparam>
  948. <typeparam name="TDep2">Second dependency type.</typeparam>
  949. <typeparam name="TDep3">Third dependency type.</typeparam>
  950. <typeparam name="TDep4">Fourth dependency type.</typeparam>
  951. <typeparam name="TDep5">Fifth dependency type.</typeparam>
  952. </member>
  953. <member name="M:Microsoft.Extensions.Options.PostConfigureOptions`6.#ctor(System.String,`1,`2,`3,`4,`5,System.Action{`0,`1,`2,`3,`4,`5})">
  954. <summary>Constructor.</summary>
  955. <param name="name">The name of the options.</param>
  956. <param name="dependency1">A dependency.</param>
  957. <param name="dependency2">A second dependency.</param>
  958. <param name="dependency3">A third dependency.</param>
  959. <param name="dependency4">A fourth dependency.</param>
  960. <param name="dependency5">A fifth dependency.</param>
  961. <param name="action">The action to register.</param>
  962. </member>
  963. <member name="M:Microsoft.Extensions.Options.PostConfigureOptions`6.PostConfigure(`0)">
  964. <summary>Invoked to configure a <typeparamref name="TOptions" /> instance using the <see cref="F:Microsoft.Extensions.Options.Options.DefaultName" />.</summary>
  965. <param name="options">The options instance to configured.</param>
  966. </member>
  967. <member name="M:Microsoft.Extensions.Options.PostConfigureOptions`6.PostConfigure(System.String,`0)">
  968. <summary>Invokes the registered initialization <see cref="P:Microsoft.Extensions.Options.PostConfigureOptions`6.Action" /> if the <paramref name="name" /> matches.</summary>
  969. <param name="name">The name of the options instance being configured.</param>
  970. <param name="options">The options instance to configured.</param>
  971. </member>
  972. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`6.Action">
  973. <summary>The configuration action.</summary>
  974. </member>
  975. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`6.Dependency1">
  976. <summary>The first dependency.</summary>
  977. </member>
  978. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`6.Dependency2">
  979. <summary>The second dependency.</summary>
  980. </member>
  981. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`6.Dependency3">
  982. <summary>The third dependency.</summary>
  983. </member>
  984. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`6.Dependency4">
  985. <summary>The fourth dependency.</summary>
  986. </member>
  987. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`6.Dependency5">
  988. <summary>The fifth dependency.</summary>
  989. </member>
  990. <member name="P:Microsoft.Extensions.Options.PostConfigureOptions`6.Name">
  991. <summary>The options name.</summary>
  992. </member>
  993. <member name="T:Microsoft.Extensions.Options.ValidateOptions`1">
  994. <summary>Implementation of <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1" /></summary>
  995. <typeparam name="TOptions">The options type to validate.</typeparam>
  996. </member>
  997. <member name="M:Microsoft.Extensions.Options.ValidateOptions`1.#ctor(System.String,System.Func{`0,System.Boolean},System.String)">
  998. <summary>Constructor.</summary>
  999. <param name="name">Options name.</param>
  1000. <param name="validation">Validation function.</param>
  1001. <param name="failureMessage">Validation failure message.</param>
  1002. </member>
  1003. <member name="M:Microsoft.Extensions.Options.ValidateOptions`1.Validate(System.String,`0)">
  1004. <summary>Validates a specific named options instance (or all when <paramref name="name" /> is null).</summary>
  1005. <param name="name">The name of the options instance being validated.</param>
  1006. <param name="options">The options instance.</param>
  1007. <returns>The <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult" /> result.</returns>
  1008. </member>
  1009. <member name="P:Microsoft.Extensions.Options.ValidateOptions`1.FailureMessage">
  1010. <summary>The error to return when validation fails.</summary>
  1011. </member>
  1012. <member name="P:Microsoft.Extensions.Options.ValidateOptions`1.Name">
  1013. <summary>The options name.</summary>
  1014. </member>
  1015. <member name="P:Microsoft.Extensions.Options.ValidateOptions`1.Validation">
  1016. <summary>The validation function.</summary>
  1017. </member>
  1018. <member name="T:Microsoft.Extensions.Options.ValidateOptions`2">
  1019. <summary>Implementation of <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1" /></summary>
  1020. <typeparam name="TOptions">The options type to validate.</typeparam>
  1021. <typeparam name="TDep">Dependency type.</typeparam>
  1022. </member>
  1023. <member name="M:Microsoft.Extensions.Options.ValidateOptions`2.#ctor(System.String,`1,System.Func{`0,`1,System.Boolean},System.String)">
  1024. <summary>Constructor.</summary>
  1025. <param name="name">Options name.</param>
  1026. <param name="dependency">The dependency.</param>
  1027. <param name="validation">Validation function.</param>
  1028. <param name="failureMessage">Validation failure message.</param>
  1029. </member>
  1030. <member name="M:Microsoft.Extensions.Options.ValidateOptions`2.Validate(System.String,`0)">
  1031. <summary>Validates a specific named options instance (or all when <paramref name="name" /> is null).</summary>
  1032. <param name="name">The name of the options instance being validated.</param>
  1033. <param name="options">The options instance.</param>
  1034. <returns>The <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult" /> result.</returns>
  1035. </member>
  1036. <member name="P:Microsoft.Extensions.Options.ValidateOptions`2.Dependency">
  1037. <summary>The dependency.</summary>
  1038. </member>
  1039. <member name="P:Microsoft.Extensions.Options.ValidateOptions`2.FailureMessage">
  1040. <summary>The error to return when validation fails.</summary>
  1041. </member>
  1042. <member name="P:Microsoft.Extensions.Options.ValidateOptions`2.Name">
  1043. <summary>The options name.</summary>
  1044. </member>
  1045. <member name="P:Microsoft.Extensions.Options.ValidateOptions`2.Validation">
  1046. <summary>The validation function.</summary>
  1047. </member>
  1048. <member name="T:Microsoft.Extensions.Options.ValidateOptions`3">
  1049. <summary>Implementation of <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1" /></summary>
  1050. <typeparam name="TOptions">The options type to validate.</typeparam>
  1051. <typeparam name="TDep1">First dependency type.</typeparam>
  1052. <typeparam name="TDep2">Second dependency type.</typeparam>
  1053. </member>
  1054. <member name="M:Microsoft.Extensions.Options.ValidateOptions`3.#ctor(System.String,`1,`2,System.Func{`0,`1,`2,System.Boolean},System.String)">
  1055. <summary>Constructor.</summary>
  1056. <param name="name">Options name.</param>
  1057. <param name="dependency1">The first dependency.</param>
  1058. <param name="dependency2">The second dependency.</param>
  1059. <param name="validation">Validation function.</param>
  1060. <param name="failureMessage">Validation failure message.</param>
  1061. </member>
  1062. <member name="M:Microsoft.Extensions.Options.ValidateOptions`3.Validate(System.String,`0)">
  1063. <summary>Validates a specific named options instance (or all when <paramref name="name" /> is null).</summary>
  1064. <param name="name">The name of the options instance being validated.</param>
  1065. <param name="options">The options instance.</param>
  1066. <returns>The <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult" /> result.</returns>
  1067. </member>
  1068. <member name="P:Microsoft.Extensions.Options.ValidateOptions`3.Dependency1">
  1069. <summary>The first dependency.</summary>
  1070. </member>
  1071. <member name="P:Microsoft.Extensions.Options.ValidateOptions`3.Dependency2">
  1072. <summary>The second dependency.</summary>
  1073. </member>
  1074. <member name="P:Microsoft.Extensions.Options.ValidateOptions`3.FailureMessage">
  1075. <summary>The error to return when validation fails.</summary>
  1076. </member>
  1077. <member name="P:Microsoft.Extensions.Options.ValidateOptions`3.Name">
  1078. <summary>The options name.</summary>
  1079. </member>
  1080. <member name="P:Microsoft.Extensions.Options.ValidateOptions`3.Validation">
  1081. <summary>The validation function.</summary>
  1082. </member>
  1083. <member name="T:Microsoft.Extensions.Options.ValidateOptions`4">
  1084. <summary>Implementation of <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1" /></summary>
  1085. <typeparam name="TOptions">The options type to validate.</typeparam>
  1086. <typeparam name="TDep1">First dependency type.</typeparam>
  1087. <typeparam name="TDep2">Second dependency type.</typeparam>
  1088. <typeparam name="TDep3">Third dependency type.</typeparam>
  1089. </member>
  1090. <member name="M:Microsoft.Extensions.Options.ValidateOptions`4.#ctor(System.String,`1,`2,`3,System.Func{`0,`1,`2,`3,System.Boolean},System.String)">
  1091. <summary>Constructor.</summary>
  1092. <param name="name">Options name.</param>
  1093. <param name="dependency1">The first dependency.</param>
  1094. <param name="dependency2">The second dependency.</param>
  1095. <param name="dependency3">The third dependency.</param>
  1096. <param name="validation">Validation function.</param>
  1097. <param name="failureMessage">Validation failure message.</param>
  1098. </member>
  1099. <member name="M:Microsoft.Extensions.Options.ValidateOptions`4.Validate(System.String,`0)">
  1100. <summary>Validates a specific named options instance (or all when <paramref name="name" /> is null).</summary>
  1101. <param name="name">The name of the options instance being validated.</param>
  1102. <param name="options">The options instance.</param>
  1103. <returns>The <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult" /> result.</returns>
  1104. </member>
  1105. <member name="P:Microsoft.Extensions.Options.ValidateOptions`4.Dependency1">
  1106. <summary>The first dependency.</summary>
  1107. </member>
  1108. <member name="P:Microsoft.Extensions.Options.ValidateOptions`4.Dependency2">
  1109. <summary>The second dependency.</summary>
  1110. </member>
  1111. <member name="P:Microsoft.Extensions.Options.ValidateOptions`4.Dependency3">
  1112. <summary>The third dependency.</summary>
  1113. </member>
  1114. <member name="P:Microsoft.Extensions.Options.ValidateOptions`4.FailureMessage">
  1115. <summary>The error to return when validation fails.</summary>
  1116. </member>
  1117. <member name="P:Microsoft.Extensions.Options.ValidateOptions`4.Name">
  1118. <summary>The options name.</summary>
  1119. </member>
  1120. <member name="P:Microsoft.Extensions.Options.ValidateOptions`4.Validation">
  1121. <summary>The validation function.</summary>
  1122. </member>
  1123. <member name="T:Microsoft.Extensions.Options.ValidateOptions`5">
  1124. <summary>Implementation of <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1" /></summary>
  1125. <typeparam name="TOptions">The options type to validate.</typeparam>
  1126. <typeparam name="TDep1">First dependency type.</typeparam>
  1127. <typeparam name="TDep2">Second dependency type.</typeparam>
  1128. <typeparam name="TDep3">Third dependency type.</typeparam>
  1129. <typeparam name="TDep4">Fourth dependency type.</typeparam>
  1130. </member>
  1131. <member name="M:Microsoft.Extensions.Options.ValidateOptions`5.#ctor(System.String,`1,`2,`3,`4,System.Func{`0,`1,`2,`3,`4,System.Boolean},System.String)">
  1132. <summary>Constructor.</summary>
  1133. <param name="name">Options name.</param>
  1134. <param name="dependency1">The first dependency.</param>
  1135. <param name="dependency2">The second dependency.</param>
  1136. <param name="dependency3">The third dependency.</param>
  1137. <param name="dependency4">The fourth dependency.</param>
  1138. <param name="validation">Validation function.</param>
  1139. <param name="failureMessage">Validation failure message.</param>
  1140. </member>
  1141. <member name="M:Microsoft.Extensions.Options.ValidateOptions`5.Validate(System.String,`0)">
  1142. <summary>Validates a specific named options instance (or all when <paramref name="name" /> is null).</summary>
  1143. <param name="name">The name of the options instance being validated.</param>
  1144. <param name="options">The options instance.</param>
  1145. <returns>The <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult" /> result.</returns>
  1146. </member>
  1147. <member name="P:Microsoft.Extensions.Options.ValidateOptions`5.Dependency1">
  1148. <summary>The first dependency.</summary>
  1149. </member>
  1150. <member name="P:Microsoft.Extensions.Options.ValidateOptions`5.Dependency2">
  1151. <summary>The second dependency.</summary>
  1152. </member>
  1153. <member name="P:Microsoft.Extensions.Options.ValidateOptions`5.Dependency3">
  1154. <summary>The third dependency.</summary>
  1155. </member>
  1156. <member name="P:Microsoft.Extensions.Options.ValidateOptions`5.Dependency4">
  1157. <summary>The fourth dependency.</summary>
  1158. </member>
  1159. <member name="P:Microsoft.Extensions.Options.ValidateOptions`5.FailureMessage">
  1160. <summary>The error to return when validation fails.</summary>
  1161. </member>
  1162. <member name="P:Microsoft.Extensions.Options.ValidateOptions`5.Name">
  1163. <summary>The options name.</summary>
  1164. </member>
  1165. <member name="P:Microsoft.Extensions.Options.ValidateOptions`5.Validation">
  1166. <summary>The validation function.</summary>
  1167. </member>
  1168. <member name="T:Microsoft.Extensions.Options.ValidateOptions`6">
  1169. <summary>Implementation of <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1" /></summary>
  1170. <typeparam name="TOptions">The options type to validate.</typeparam>
  1171. <typeparam name="TDep1">First dependency type.</typeparam>
  1172. <typeparam name="TDep2">Second dependency type.</typeparam>
  1173. <typeparam name="TDep3">Third dependency type.</typeparam>
  1174. <typeparam name="TDep4">Fourth dependency type.</typeparam>
  1175. <typeparam name="TDep5">Fifth dependency type.</typeparam>
  1176. </member>
  1177. <member name="M:Microsoft.Extensions.Options.ValidateOptions`6.#ctor(System.String,`1,`2,`3,`4,`5,System.Func{`0,`1,`2,`3,`4,`5,System.Boolean},System.String)">
  1178. <summary>Constructor.</summary>
  1179. <param name="name">Options name.</param>
  1180. <param name="dependency1">The first dependency.</param>
  1181. <param name="dependency2">The second dependency.</param>
  1182. <param name="dependency3">The third dependency.</param>
  1183. <param name="dependency4">The fourth dependency.</param>
  1184. <param name="dependency5">The fifth dependency.</param>
  1185. <param name="validation">Validation function.</param>
  1186. <param name="failureMessage">Validation failure message.</param>
  1187. </member>
  1188. <member name="M:Microsoft.Extensions.Options.ValidateOptions`6.Validate(System.String,`0)">
  1189. <summary>Validates a specific named options instance (or all when <paramref name="name" /> is null).</summary>
  1190. <param name="name">The name of the options instance being validated.</param>
  1191. <param name="options">The options instance.</param>
  1192. <returns>The <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult" /> result.</returns>
  1193. </member>
  1194. <member name="P:Microsoft.Extensions.Options.ValidateOptions`6.Dependency1">
  1195. <summary>The first dependency.</summary>
  1196. </member>
  1197. <member name="P:Microsoft.Extensions.Options.ValidateOptions`6.Dependency2">
  1198. <summary>The second dependency.</summary>
  1199. </member>
  1200. <member name="P:Microsoft.Extensions.Options.ValidateOptions`6.Dependency3">
  1201. <summary>The third dependency.</summary>
  1202. </member>
  1203. <member name="P:Microsoft.Extensions.Options.ValidateOptions`6.Dependency4">
  1204. <summary>The fourth dependency.</summary>
  1205. </member>
  1206. <member name="P:Microsoft.Extensions.Options.ValidateOptions`6.Dependency5">
  1207. <summary>The fifth dependency.</summary>
  1208. </member>
  1209. <member name="P:Microsoft.Extensions.Options.ValidateOptions`6.FailureMessage">
  1210. <summary>The error to return when validation fails.</summary>
  1211. </member>
  1212. <member name="P:Microsoft.Extensions.Options.ValidateOptions`6.Name">
  1213. <summary>The options name.</summary>
  1214. </member>
  1215. <member name="P:Microsoft.Extensions.Options.ValidateOptions`6.Validation">
  1216. <summary>The validation function.</summary>
  1217. </member>
  1218. <member name="T:Microsoft.Extensions.Options.ValidateOptionsResult">
  1219. <summary>Represents the result of an options validation.</summary>
  1220. </member>
  1221. <member name="F:Microsoft.Extensions.Options.ValidateOptionsResult.Skip">
  1222. <summary>Result when validation was skipped due to name not matching.</summary>
  1223. </member>
  1224. <member name="F:Microsoft.Extensions.Options.ValidateOptionsResult.Success">
  1225. <summary>Validation was successful.</summary>
  1226. </member>
  1227. <member name="M:Microsoft.Extensions.Options.ValidateOptionsResult.#ctor" />
  1228. <member name="M:Microsoft.Extensions.Options.ValidateOptionsResult.Fail(System.Collections.Generic.IEnumerable{System.String})">
  1229. <summary>Returns a failure result.</summary>
  1230. <param name="failures">The reasons for the failure.</param>
  1231. <returns>The failure result.</returns>
  1232. </member>
  1233. <member name="M:Microsoft.Extensions.Options.ValidateOptionsResult.Fail(System.String)">
  1234. <summary>Returns a failure result.</summary>
  1235. <param name="failureMessage">The reason for the failure.</param>
  1236. <returns>The failure result.</returns>
  1237. </member>
  1238. <member name="P:Microsoft.Extensions.Options.ValidateOptionsResult.Failed">
  1239. <summary>True if validation failed.</summary>
  1240. </member>
  1241. <member name="P:Microsoft.Extensions.Options.ValidateOptionsResult.FailureMessage">
  1242. <summary>Used to describe why validation failed.</summary>
  1243. </member>
  1244. <member name="P:Microsoft.Extensions.Options.ValidateOptionsResult.Failures">
  1245. <summary>Full list of failures (can be multiple).</summary>
  1246. </member>
  1247. <member name="P:Microsoft.Extensions.Options.ValidateOptionsResult.Skipped">
  1248. <summary>True if validation was not run.</summary>
  1249. </member>
  1250. <member name="P:Microsoft.Extensions.Options.ValidateOptionsResult.Succeeded">
  1251. <summary>True if validation was successful.</summary>
  1252. </member>
  1253. </members>
  1254. </doc>