Microsoft.Extensions.Options.xml 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.Options</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.Options.ConfigureOptions`1">
  8. <summary>
  9. Implementation of IConfigureOptions.
  10. </summary>
  11. <typeparam name="TOptions"></typeparam>
  12. </member>
  13. <member name="M:Microsoft.Extensions.Options.ConfigureOptions`1.#ctor(System.Action{`0})">
  14. <summary>
  15. Constructor.
  16. </summary>
  17. <param name="action">The action to register.</param>
  18. </member>
  19. <member name="P:Microsoft.Extensions.Options.ConfigureOptions`1.Action">
  20. <summary>
  21. The configuration action.
  22. </summary>
  23. </member>
  24. <member name="M:Microsoft.Extensions.Options.ConfigureOptions`1.Configure(`0)">
  25. <summary>
  26. Invokes the registered configure Action.
  27. </summary>
  28. <param name="options"></param>
  29. </member>
  30. <member name="T:Microsoft.Extensions.Options.IConfigureOptions`1">
  31. <summary>
  32. Represents something that configures the TOptions type.
  33. </summary>
  34. <typeparam name="TOptions"></typeparam>
  35. </member>
  36. <member name="M:Microsoft.Extensions.Options.IConfigureOptions`1.Configure(`0)">
  37. <summary>
  38. Invoked to configure a TOptions instance.
  39. </summary>
  40. <param name="options">The options instance to configure.</param>
  41. </member>
  42. <member name="T:Microsoft.Extensions.Options.IOptions`1">
  43. <summary>
  44. Used to retreive configured TOptions instances.
  45. </summary>
  46. <typeparam name="TOptions">The type of options being requested.</typeparam>
  47. </member>
  48. <member name="P:Microsoft.Extensions.Options.IOptions`1.Value">
  49. <summary>
  50. The configured TOptions instance.
  51. </summary>
  52. </member>
  53. <member name="T:Microsoft.Extensions.Options.IOptionsChangeTokenSource`1">
  54. <summary>
  55. Used to fetch IChangeTokens used for tracking options changes.
  56. </summary>
  57. <typeparam name="TOptions"></typeparam>
  58. </member>
  59. <member name="M:Microsoft.Extensions.Options.IOptionsChangeTokenSource`1.GetChangeToken">
  60. <summary>
  61. Returns a IChangeToken which can be used to register a change notification callback.
  62. </summary>
  63. <returns></returns>
  64. </member>
  65. <member name="T:Microsoft.Extensions.Options.IOptionsMonitor`1">
  66. <summary>
  67. Used for notifications when TOptions instances change.
  68. </summary>
  69. <typeparam name="TOptions">The options type.</typeparam>
  70. </member>
  71. <member name="P:Microsoft.Extensions.Options.IOptionsMonitor`1.CurrentValue">
  72. <summary>
  73. Returns the current TOptions instance.
  74. </summary>
  75. </member>
  76. <member name="M:Microsoft.Extensions.Options.IOptionsMonitor`1.OnChange(System.Action{`0})">
  77. <summary>
  78. Registers a listener to be called whenever TOptions changes.
  79. </summary>
  80. <param name="listener">The action to be invoked when TOptions has changed.</param>
  81. <returns>An IDisposable which should be disposed to stop listening for changes.</returns>
  82. </member>
  83. <member name="T:Microsoft.Extensions.Options.IOptionsSnapshot`1">
  84. <summary>
  85. Used to access the value of TOptions for the lifetime of a request.
  86. </summary>
  87. <typeparam name="TOptions"></typeparam>
  88. </member>
  89. <member name="P:Microsoft.Extensions.Options.IOptionsSnapshot`1.Value">
  90. <summary>
  91. Returns the value of the TOptions which will be computed once
  92. </summary>
  93. <returns></returns>
  94. </member>
  95. <member name="T:Microsoft.Extensions.Options.Options">
  96. <summary>
  97. Helper class.
  98. </summary>
  99. </member>
  100. <member name="M:Microsoft.Extensions.Options.Options.Create``1(``0)">
  101. <summary>
  102. Creates a wrapper around an instance of TOptions to return itself as an IOptions.
  103. </summary>
  104. <typeparam name="TOptions"></typeparam>
  105. <param name="options"></param>
  106. <returns></returns>
  107. </member>
  108. <member name="T:Microsoft.Extensions.Options.OptionsManager`1">
  109. <summary>
  110. Implementation of IOptions.
  111. </summary>
  112. <typeparam name="TOptions"></typeparam>
  113. </member>
  114. <member name="M:Microsoft.Extensions.Options.OptionsManager`1.#ctor(System.Collections.Generic.IEnumerable{Microsoft.Extensions.Options.IConfigureOptions{`0}})">
  115. <summary>
  116. Initializes a new instance with the specified options configurations.
  117. </summary>
  118. <param name="setups">The configuration actions to run.</param>
  119. </member>
  120. <member name="P:Microsoft.Extensions.Options.OptionsManager`1.Value">
  121. <summary>
  122. The configured options instance.
  123. </summary>
  124. </member>
  125. <member name="T:Microsoft.Extensions.Options.OptionsMonitor`1">
  126. <summary>
  127. Implementation of IOptionsMonitor.
  128. </summary>
  129. <typeparam name="TOptions"></typeparam>
  130. </member>
  131. <member name="M:Microsoft.Extensions.Options.OptionsMonitor`1.#ctor(System.Collections.Generic.IEnumerable{Microsoft.Extensions.Options.IConfigureOptions{`0}},System.Collections.Generic.IEnumerable{Microsoft.Extensions.Options.IOptionsChangeTokenSource{`0}})">
  132. <summary>
  133. Constructor.
  134. </summary>
  135. <param name="setups">The configuration actions to run on an options instance.</param>
  136. <param name="sources">The sources used to listen for changes to the options instance.</param>
  137. </member>
  138. <member name="P:Microsoft.Extensions.Options.OptionsMonitor`1.CurrentValue">
  139. <summary>
  140. The present value of the options.
  141. </summary>
  142. </member>
  143. <member name="M:Microsoft.Extensions.Options.OptionsMonitor`1.OnChange(System.Action{`0})">
  144. <summary>
  145. Registers a listener to be called whenever TOptions changes.
  146. </summary>
  147. <param name="listener">The action to be invoked when TOptions has changed.</param>
  148. <returns>An IDisposable which should be disposed to stop listening for changes.</returns>
  149. </member>
  150. <member name="T:Microsoft.Extensions.Options.OptionsSnapshot`1">
  151. <summary>
  152. Implementation of IOptionsSnapshot.
  153. </summary>
  154. <typeparam name="TOptions"></typeparam>
  155. </member>
  156. <member name="M:Microsoft.Extensions.Options.OptionsSnapshot`1.#ctor(Microsoft.Extensions.Options.IOptionsMonitor{`0})">
  157. <summary>
  158. Initializes a new instance.
  159. </summary>
  160. <param name="monitor">The monitor to fetch the options value from.</param>
  161. </member>
  162. <member name="P:Microsoft.Extensions.Options.OptionsSnapshot`1.Value">
  163. <summary>
  164. The configured options instance.
  165. </summary>
  166. </member>
  167. <member name="T:Microsoft.Extensions.Options.OptionsWrapper`1">
  168. <summary>
  169. IOptions wrapper that returns the options instance.
  170. </summary>
  171. <typeparam name="TOptions"></typeparam>
  172. </member>
  173. <member name="M:Microsoft.Extensions.Options.OptionsWrapper`1.#ctor(`0)">
  174. <summary>
  175. Intializes the wrapper with the options instance to return.
  176. </summary>
  177. <param name="options">The options instance to return.</param>
  178. </member>
  179. <member name="P:Microsoft.Extensions.Options.OptionsWrapper`1.Value">
  180. <summary>
  181. The options instance.
  182. </summary>
  183. </member>
  184. <member name="P:Microsoft.Extensions.Options.Resources.Error_CannotActivateAbstractOrInterface">
  185. <summary>
  186. Cannot create instance of type '{0}' because it is either abstract or an interface.
  187. </summary>
  188. </member>
  189. <member name="M:Microsoft.Extensions.Options.Resources.FormatError_CannotActivateAbstractOrInterface(System.Object)">
  190. <summary>
  191. Cannot create instance of type '{0}' because it is either abstract or an interface.
  192. </summary>
  193. </member>
  194. <member name="P:Microsoft.Extensions.Options.Resources.Error_FailedBinding">
  195. <summary>
  196. Failed to convert '{0}' to type '{1}'.
  197. </summary>
  198. </member>
  199. <member name="M:Microsoft.Extensions.Options.Resources.FormatError_FailedBinding(System.Object,System.Object)">
  200. <summary>
  201. Failed to convert '{0}' to type '{1}'.
  202. </summary>
  203. </member>
  204. <member name="P:Microsoft.Extensions.Options.Resources.Error_FailedToActivate">
  205. <summary>
  206. Failed to create instance of type '{0}'.
  207. </summary>
  208. </member>
  209. <member name="M:Microsoft.Extensions.Options.Resources.FormatError_FailedToActivate(System.Object)">
  210. <summary>
  211. Failed to create instance of type '{0}'.
  212. </summary>
  213. </member>
  214. <member name="P:Microsoft.Extensions.Options.Resources.Error_MissingParameterlessConstructor">
  215. <summary>
  216. Cannot create instance of type '{0}' because it is missing a public parameterless constructor.
  217. </summary>
  218. </member>
  219. <member name="M:Microsoft.Extensions.Options.Resources.FormatError_MissingParameterlessConstructor(System.Object)">
  220. <summary>
  221. Cannot create instance of type '{0}' because it is missing a public parameterless constructor.
  222. </summary>
  223. </member>
  224. <member name="T:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions">
  225. <summary>
  226. Extension methods for adding options services to the DI container.
  227. </summary>
  228. </member>
  229. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.AddOptions(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
  230. <summary>
  231. Adds services required for using options.
  232. </summary>
  233. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
  234. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
  235. </member>
  236. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})">
  237. <summary>
  238. Registers an action used to configure a particular type of options.
  239. </summary>
  240. <typeparam name="TOptions">The options type to be configured.</typeparam>
  241. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
  242. <param name="configureOptions">The action used to configure the options.</param>
  243. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
  244. </member>
  245. </members>
  246. </doc>