41bae649d079b3498c3845b5120a831536f3c06a
[platform/core/dotnet/build-tools.git] /
1 <?xml version="1.0"?>\r
2 <doc>\r
3     <assembly>\r
4         <name>Microsoft.Extensions.Configuration.Abstractions</name>\r
5     </assembly>\r
6     <members>\r
7         <member name="T:Microsoft.Extensions.Configuration.ConfigurationExtensions">\r
8             <summary>\r
9             Extension methods for configuration classes./>.\r
10             </summary>\r
11         </member>\r
12         <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Add``1(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{``0})">\r
13             <summary>\r
14             Adds a new configuration source.\r
15             </summary>\r
16             <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>\r
17             <param name="configureSource">Configures the source secrets.</param>\r
18             <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>\r
19         </member>\r
20         <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.GetConnectionString(Microsoft.Extensions.Configuration.IConfiguration,System.String)">\r
21             <summary>\r
22             Shorthand for GetSection("ConnectionStrings")[name].\r
23             </summary>\r
24             <param name="configuration">The configuration.</param>\r
25             <param name="name">The connection string key.</param>\r
26             <returns>The connection string.</returns>\r
27         </member>\r
28         <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AsEnumerable(Microsoft.Extensions.Configuration.IConfiguration)">\r
29             <summary>\r
30             Get the enumeration of key value pairs within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />\r
31             </summary>\r
32             <param name="configuration">The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> to enumerate.</param>\r
33             <returns>An enumeration of key value pairs.</returns>\r
34         </member>\r
35         <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AsEnumerable(Microsoft.Extensions.Configuration.IConfiguration,System.Boolean)">\r
36             <summary>\r
37             Get the enumeration of key value pairs within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />\r
38             </summary>\r
39             <param name="configuration">The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> to enumerate.</param>\r
40             <param name="makePathsRelative">If true, the child keys returned will have the current configuration's Path trimmed from the front.</param>\r
41             <returns>An enumeration of key value pairs.</returns>\r
42         </member>\r
43         <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Exists(Microsoft.Extensions.Configuration.IConfigurationSection)">\r
44             <summary>\r
45             Determines whether the section has a <see cref="P:Microsoft.Extensions.Configuration.IConfigurationSection.Value"/> or has children\r
46             </summary>\r
47         </member>\r
48         <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.GetRequiredSection(Microsoft.Extensions.Configuration.IConfiguration,System.String)">\r
49             <summary>\r
50             Gets a configuration sub-section with the specified key.\r
51             </summary>\r
52             <param name="configuration"></param>\r
53             <param name="key">The key of the configuration section.</param>\r
54             <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/>.</returns>\r
55             <remarks>\r
56                 If no matching sub-section is found with the specified key, an exception is raised.\r
57             </remarks>\r
58             <exception cref="T:System.InvalidOperationException">There is no section with key <paramref name="key"/>.</exception>\r
59         </member>\r
60         <member name="T:Microsoft.Extensions.Configuration.ConfigurationPath">\r
61             <summary>\r
62             Utility methods and constants for manipulating Configuration paths\r
63             </summary>\r
64         </member>\r
65         <member name="F:Microsoft.Extensions.Configuration.ConfigurationPath.KeyDelimiter">\r
66             <summary>\r
67             The delimiter ":" used to separate individual keys in a path.\r
68             </summary>\r
69         </member>\r
70         <member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.Combine(System.String[])">\r
71             <summary>\r
72             Combines path segments into one path.\r
73             </summary>\r
74             <param name="pathSegments">The path segments to combine.</param>\r
75             <returns>The combined path.</returns>\r
76         </member>\r
77         <member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.Combine(System.Collections.Generic.IEnumerable{System.String})">\r
78             <summary>\r
79             Combines path segments into one path.\r
80             </summary>\r
81             <param name="pathSegments">The path segments to combine.</param>\r
82             <returns>The combined path.</returns>\r
83         </member>\r
84         <member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.GetSectionKey(System.String)">\r
85             <summary>\r
86             Extracts the last path segment from the path.\r
87             </summary>\r
88             <param name="path">The path.</param>\r
89             <returns>The last path segment of the path.</returns>\r
90         </member>\r
91         <member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.GetParentPath(System.String)">\r
92             <summary>\r
93             Extracts the path corresponding to the parent node for a given path.\r
94             </summary>\r
95             <param name="path">The path.</param>\r
96             <returns>The original path minus the last individual segment found in it. Null if the original path corresponds to a top level node.</returns>\r
97         </member>\r
98         <member name="T:Microsoft.Extensions.Configuration.ConfigurationRootExtensions">\r
99             <summary>\r
100             Extension methods for <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot"/>.\r
101             </summary>\r
102         </member>\r
103         <member name="M:Microsoft.Extensions.Configuration.ConfigurationRootExtensions.GetDebugView(Microsoft.Extensions.Configuration.IConfigurationRoot)">\r
104             <summary>\r
105             Generates a human-readable view of the configuration showing where each value came from.\r
106             </summary>\r
107             <returns> The debug view. </returns>\r
108         </member>\r
109         <member name="T:Microsoft.Extensions.Configuration.IConfiguration">\r
110             <summary>\r
111             Represents a set of key/value application configuration properties.\r
112             </summary>\r
113         </member>\r
114         <member name="P:Microsoft.Extensions.Configuration.IConfiguration.Item(System.String)">\r
115             <summary>\r
116             Gets or sets a configuration value.\r
117             </summary>\r
118             <param name="key">The configuration key.</param>\r
119             <returns>The configuration value.</returns>\r
120         </member>\r
121         <member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetSection(System.String)">\r
122             <summary>\r
123             Gets a configuration sub-section with the specified key.\r
124             </summary>\r
125             <param name="key">The key of the configuration section.</param>\r
126             <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/>.</returns>\r
127             <remarks>\r
128                 This method will never return <c>null</c>. If no matching sub-section is found with the specified key,\r
129                 an empty <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/> will be returned.\r
130             </remarks>\r
131         </member>\r
132         <member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetChildren">\r
133             <summary>\r
134             Gets the immediate descendant configuration sub-sections.\r
135             </summary>\r
136             <returns>The configuration sub-sections.</returns>\r
137         </member>\r
138         <member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetReloadToken">\r
139             <summary>\r
140             Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that can be used to observe when this configuration is reloaded.\r
141             </summary>\r
142             <returns>A <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/>.</returns>\r
143         </member>\r
144         <member name="T:Microsoft.Extensions.Configuration.IConfigurationBuilder">\r
145             <summary>\r
146             Represents a type used to build application configuration.\r
147             </summary>\r
148         </member>\r
149         <member name="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties">\r
150             <summary>\r
151             Gets a key/value collection that can be used to share data between the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>\r
152             and the registered <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>s.\r
153             </summary>\r
154         </member>\r
155         <member name="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Sources">\r
156             <summary>\r
157             Gets the sources used to obtain configuration values\r
158             </summary>\r
159         </member>\r
160         <member name="M:Microsoft.Extensions.Configuration.IConfigurationBuilder.Add(Microsoft.Extensions.Configuration.IConfigurationSource)">\r
161             <summary>\r
162             Adds a new configuration source.\r
163             </summary>\r
164             <param name="source">The configuration source to add.</param>\r
165             <returns>The same <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>\r
166         </member>\r
167         <member name="M:Microsoft.Extensions.Configuration.IConfigurationBuilder.Build">\r
168             <summary>\r
169             Builds an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> with keys and values from the set of sources registered in\r
170             <see cref="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Sources"/>.\r
171             </summary>\r
172             <returns>An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot"/> with keys and values from the registered sources.</returns>\r
173         </member>\r
174         <member name="T:Microsoft.Extensions.Configuration.IConfigurationProvider">\r
175             <summary>\r
176             Provides configuration key/values for an application.\r
177             </summary>\r
178         </member>\r
179         <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.TryGet(System.String,System.String@)">\r
180             <summary>\r
181             Tries to get a configuration value for the specified key.\r
182             </summary>\r
183             <param name="key">The key.</param>\r
184             <param name="value">The value.</param>\r
185             <returns><c>True</c> if a value for the specified key was found, otherwise <c>false</c>.</returns>\r
186         </member>\r
187         <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.Set(System.String,System.String)">\r
188             <summary>\r
189             Sets a configuration value for the specified key.\r
190             </summary>\r
191             <param name="key">The key.</param>\r
192             <param name="value">The value.</param>\r
193         </member>\r
194         <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.GetReloadToken">\r
195             <summary>\r
196             Returns a change token if this provider supports change tracking, null otherwise.\r
197             </summary>\r
198             <returns>The change token.</returns>\r
199         </member>\r
200         <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.Load">\r
201             <summary>\r
202             Loads configuration values from the source represented by this <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>.\r
203             </summary>\r
204         </member>\r
205         <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.GetChildKeys(System.Collections.Generic.IEnumerable{System.String},System.String)">\r
206             <summary>\r
207             Returns the immediate descendant configuration keys for a given parent path based on this\r
208             <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s data and the set of keys returned by all the preceding\r
209             <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s.\r
210             </summary>\r
211             <param name="earlierKeys">The child keys returned by the preceding providers for the same parent path.</param>\r
212             <param name="parentPath">The parent path.</param>\r
213             <returns>The child keys.</returns>\r
214         </member>\r
215         <member name="T:Microsoft.Extensions.Configuration.IConfigurationRoot">\r
216             <summary>\r
217             Represents the root of an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> hierarchy.\r
218             </summary>\r
219         </member>\r
220         <member name="M:Microsoft.Extensions.Configuration.IConfigurationRoot.Reload">\r
221             <summary>\r
222             Force the configuration values to be reloaded from the underlying <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s.\r
223             </summary>\r
224         </member>\r
225         <member name="P:Microsoft.Extensions.Configuration.IConfigurationRoot.Providers">\r
226             <summary>\r
227             The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s for this configuration.\r
228             </summary>\r
229         </member>\r
230         <member name="T:Microsoft.Extensions.Configuration.IConfigurationSection">\r
231             <summary>\r
232             Represents a section of application configuration values.\r
233             </summary>\r
234         </member>\r
235         <member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Key">\r
236             <summary>\r
237             Gets the key this section occupies in its parent.\r
238             </summary>\r
239         </member>\r
240         <member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Path">\r
241             <summary>\r
242             Gets the full path to this section within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.\r
243             </summary>\r
244         </member>\r
245         <member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Value">\r
246             <summary>\r
247             Gets or sets the section value.\r
248             </summary>\r
249         </member>\r
250         <member name="T:Microsoft.Extensions.Configuration.IConfigurationSource">\r
251             <summary>\r
252             Represents a source of configuration key/values for an application.\r
253             </summary>\r
254         </member>\r
255         <member name="M:Microsoft.Extensions.Configuration.IConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">\r
256             <summary>\r
257             Builds the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> for this source.\r
258             </summary>\r
259             <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>\r
260             <returns>An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/></returns>\r
261         </member>\r
262         <member name="P:System.SR.InvalidSectionName">\r
263             <summary>Section '{0}' not found in configuration.</summary>\r
264         </member>\r
265     </members>\r
266 </doc>\r