Microsoft.Extensions.Configuration.Abstractions.xml 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.Configuration.Abstractions</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.Configuration.ConfigurationExtensions">
  8. <summary>Extension methods for configuration classes.</summary>
  9. </member>
  10. <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Add``1(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{``0})">
  11. <summary>Adds a new configuration source.</summary>
  12. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" /> to add to.</param>
  13. <param name="configureSource">Configures the source secrets.</param>
  14. <typeparam name="TSource" />
  15. <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" />.</returns>
  16. </member>
  17. <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AsEnumerable(Microsoft.Extensions.Configuration.IConfiguration)">
  18. <summary>Get the enumeration of key value pairs within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" /></summary>
  19. <param name="configuration">The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" /> to enumerate.</param>
  20. <returns>An enumeration of key value pairs.</returns>
  21. </member>
  22. <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AsEnumerable(Microsoft.Extensions.Configuration.IConfiguration,System.Boolean)">
  23. <summary>Get the enumeration of key value pairs within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" /></summary>
  24. <param name="configuration">The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" /> to enumerate.</param>
  25. <param name="makePathsRelative">If true, the child keys returned will have the current configuration's Path trimmed from the front.</param>
  26. <returns>An enumeration of key value pairs.</returns>
  27. </member>
  28. <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Exists(Microsoft.Extensions.Configuration.IConfigurationSection)">
  29. <summary>Determines whether the section has a <see cref="P:Microsoft.Extensions.Configuration.IConfigurationSection.Value" /> or has children.</summary>
  30. <param name="section" />
  31. </member>
  32. <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.GetConnectionString(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
  33. <summary>Shorthand for GetSection("ConnectionStrings")[name].</summary>
  34. <param name="configuration">The configuration.</param>
  35. <param name="name">The connection string key.</param>
  36. <returns>The connection string.</returns>
  37. </member>
  38. <member name="T:Microsoft.Extensions.Configuration.ConfigurationPath">
  39. <summary>Utility methods and constants for manipulating Configuration paths.</summary>
  40. </member>
  41. <member name="F:Microsoft.Extensions.Configuration.ConfigurationPath.KeyDelimiter">
  42. <summary>The delimiter ":" used to separate individual keys in a path.</summary>
  43. </member>
  44. <member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.Combine(System.Collections.Generic.IEnumerable{System.String})">
  45. <summary>Combines path segments into one path.</summary>
  46. <param name="pathSegments">The path segments to combine.</param>
  47. <returns>The combined path.</returns>
  48. </member>
  49. <member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.Combine(System.String[])">
  50. <summary>Combines path segments into one path.</summary>
  51. <param name="pathSegments">The path segments to combine.</param>
  52. <returns>The combined path.</returns>
  53. </member>
  54. <member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.GetParentPath(System.String)">
  55. <summary>Extracts the path corresponding to the parent node for a given path.</summary>
  56. <param name="path">The path.</param>
  57. <returns>The original path minus the last individual segment found in it. Null if the original path corresponds to a top level node.</returns>
  58. </member>
  59. <member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.GetSectionKey(System.String)">
  60. <summary>Extracts the last path segment from the path.</summary>
  61. <param name="path">The path.</param>
  62. <returns>The last path segment of the path.</returns>
  63. </member>
  64. <member name="T:Microsoft.Extensions.Configuration.ConfigurationRootExtensions">
  65. <summary>Extension methods for <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot" />.</summary>
  66. </member>
  67. <member name="M:Microsoft.Extensions.Configuration.ConfigurationRootExtensions.GetDebugView(Microsoft.Extensions.Configuration.IConfigurationRoot)">
  68. <summary>Generates a human-readable view of the configuration showing where each value came from.</summary>
  69. <param name="root" />
  70. <returns>The debug view.</returns>
  71. </member>
  72. <member name="T:Microsoft.Extensions.Configuration.IConfiguration">
  73. <summary>Represents a set of key/value application configuration properties.</summary>
  74. </member>
  75. <member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetChildren">
  76. <summary>Gets the immediate descendant configuration sub-sections.</summary>
  77. <returns>The configuration sub-sections.</returns>
  78. </member>
  79. <member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetReloadToken">
  80. <summary>Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> that can be used to observe when this configuration is reloaded.</summary>
  81. <returns>A <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" />.</returns>
  82. </member>
  83. <member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetSection(System.String)">
  84. <summary>Gets a configuration sub-section with the specified key.</summary>
  85. <param name="key">The key of the configuration section.</param>
  86. <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection" />.</returns>
  87. </member>
  88. <member name="P:Microsoft.Extensions.Configuration.IConfiguration.Item(System.String)">
  89. <summary>Gets or sets a configuration value.</summary>
  90. <param name="key">The configuration key.</param>
  91. <returns>The configuration value.</returns>
  92. </member>
  93. <member name="T:Microsoft.Extensions.Configuration.IConfigurationBuilder">
  94. <summary>Represents a type used to build application configuration.</summary>
  95. </member>
  96. <member name="M:Microsoft.Extensions.Configuration.IConfigurationBuilder.Add(Microsoft.Extensions.Configuration.IConfigurationSource)">
  97. <summary>Adds a new configuration source.</summary>
  98. <param name="source">The configuration source to add.</param>
  99. <returns>The same <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" />.</returns>
  100. </member>
  101. <member name="M:Microsoft.Extensions.Configuration.IConfigurationBuilder.Build">
  102. <summary>Builds an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" /> with keys and values from the set of sources registered in
  103. <see cref="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Sources" />.</summary>
  104. <returns>An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot" /> with keys and values from the registered sources.</returns>
  105. </member>
  106. <member name="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties">
  107. <summary>Gets a key/value collection that can be used to share data between the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" />
  108. and the registered <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource" />s.</summary>
  109. </member>
  110. <member name="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Sources">
  111. <summary>Gets the sources used to obtain configuration values.</summary>
  112. </member>
  113. <member name="T:Microsoft.Extensions.Configuration.IConfigurationProvider">
  114. <summary>Provides configuration key/values for an application.</summary>
  115. </member>
  116. <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.GetChildKeys(System.Collections.Generic.IEnumerable{System.String},System.String)">
  117. <summary>Returns the immediate descendant configuration keys for a given parent path based on this
  118. <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" />s data and the set of keys returned by all the preceding
  119. <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" />s.</summary>
  120. <param name="earlierKeys">The child keys returned by the preceding providers for the same parent path.</param>
  121. <param name="parentPath">The parent path.</param>
  122. <returns>The child keys.</returns>
  123. </member>
  124. <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.GetReloadToken">
  125. <summary>Returns a change token if this provider supports change tracking, null otherwise.</summary>
  126. <returns>The change token.</returns>
  127. </member>
  128. <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.Load">
  129. <summary>Loads configuration values from the source represented by this <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" />.</summary>
  130. </member>
  131. <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.Set(System.String,System.String)">
  132. <summary>Sets a configuration value for the specified key.</summary>
  133. <param name="key">The key.</param>
  134. <param name="value">The value.</param>
  135. </member>
  136. <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.TryGet(System.String,System.String@)">
  137. <summary>Tries to get a configuration value for the specified key.</summary>
  138. <param name="key">The key.</param>
  139. <param name="value">The value.</param>
  140. <returns>
  141. <see langword="true" /> if a value for the specified key was found; otherwise, <see langword="false" />.</returns>
  142. </member>
  143. <member name="T:Microsoft.Extensions.Configuration.IConfigurationRoot">
  144. <summary>Represents the root of an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" /> hierarchy.</summary>
  145. </member>
  146. <member name="M:Microsoft.Extensions.Configuration.IConfigurationRoot.Reload">
  147. <summary>Force the configuration values to be reloaded from the underlying <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" />s.</summary>
  148. </member>
  149. <member name="P:Microsoft.Extensions.Configuration.IConfigurationRoot.Providers">
  150. <summary>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" />s for this configuration.</summary>
  151. </member>
  152. <member name="T:Microsoft.Extensions.Configuration.IConfigurationSection">
  153. <summary>Represents a section of application configuration values.</summary>
  154. </member>
  155. <member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Key">
  156. <summary>Gets the key this section occupies in its parent.</summary>
  157. </member>
  158. <member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Path">
  159. <summary>Gets the full path to this section within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />.</summary>
  160. </member>
  161. <member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Value">
  162. <summary>Gets or sets the section value.</summary>
  163. </member>
  164. <member name="T:Microsoft.Extensions.Configuration.IConfigurationSource">
  165. <summary>Represents a source of configuration key/values for an application.</summary>
  166. </member>
  167. <member name="M:Microsoft.Extensions.Configuration.IConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
  168. <summary>Builds the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" /> for this source.</summary>
  169. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" />.</param>
  170. <returns>An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" /></returns>
  171. </member>
  172. </members>
  173. </doc>