[Tizen] Add BuildTools 2.1.0-rc1-02804-05
[platform/upstream/coreclr.git] / Tools / dotnetcli / sdk / NuGetFallbackFolder / microsoft.aspnetcore.localization / 2.0.1 / lib / netstandard2.0 / Microsoft.AspNetCore.Localization.xml
1 <?xml version="1.0"?>
2 <doc>
3     <assembly>
4         <name>Microsoft.AspNetCore.Localization</name>
5     </assembly>
6     <members>
7         <member name="T:Microsoft.AspNetCore.Localization.AcceptLanguageHeaderRequestCultureProvider">
8             <summary>
9             Determines the culture information for a request via the value of the Accept-Language header.
10             </summary>
11         </member>
12         <member name="P:Microsoft.AspNetCore.Localization.AcceptLanguageHeaderRequestCultureProvider.MaximumAcceptLanguageHeaderValuesToTry">
13             <summary>
14             The maximum number of values in the Accept-Language header to attempt to create a <see cref="T:System.Globalization.CultureInfo"/>
15             from for the current request.
16             Defaults to <c>3</c>.
17             </summary>
18         </member>
19         <member name="M:Microsoft.AspNetCore.Localization.AcceptLanguageHeaderRequestCultureProvider.DetermineProviderCultureResult(Microsoft.AspNetCore.Http.HttpContext)">
20             <inheritdoc />
21         </member>
22         <member name="T:Microsoft.AspNetCore.Localization.CookieRequestCultureProvider">
23             <summary>
24             Determines the culture information for a request via the value of a cookie.
25             </summary>
26         </member>
27         <member name="F:Microsoft.AspNetCore.Localization.CookieRequestCultureProvider.DefaultCookieName">
28             <summary>
29             Represent the default cookie name used to track the user's preferred culture information, which is ".AspNetCore.Culture".
30             </summary>
31         </member>
32         <member name="P:Microsoft.AspNetCore.Localization.CookieRequestCultureProvider.CookieName">
33             <summary>
34             The name of the cookie that contains the user's preferred culture information.
35             Defaults to <see cref="F:Microsoft.AspNetCore.Localization.CookieRequestCultureProvider.DefaultCookieName"/>.
36             </summary>
37         </member>
38         <member name="M:Microsoft.AspNetCore.Localization.CookieRequestCultureProvider.DetermineProviderCultureResult(Microsoft.AspNetCore.Http.HttpContext)">
39             <inheritdoc />
40         </member>
41         <member name="M:Microsoft.AspNetCore.Localization.CookieRequestCultureProvider.MakeCookieValue(Microsoft.AspNetCore.Localization.RequestCulture)">
42             <summary>
43             Creates a string representation of a <see cref="T:Microsoft.AspNetCore.Localization.RequestCulture"/> for placement in a cookie.
44             </summary>
45             <param name="requestCulture">The <see cref="T:Microsoft.AspNetCore.Localization.RequestCulture"/>.</param>
46             <returns>The cookie value.</returns>
47         </member>
48         <member name="M:Microsoft.AspNetCore.Localization.CookieRequestCultureProvider.ParseCookieValue(System.String)">
49             <summary>
50             Parses a <see cref="T:Microsoft.AspNetCore.Localization.RequestCulture"/> from the specified cookie value.
51             Returns <c>null</c> if parsing fails.
52             </summary>
53             <param name="value">The cookie value to parse.</param>
54             <returns>The <see cref="T:Microsoft.AspNetCore.Localization.RequestCulture"/> or <c>null</c> if parsing fails.</returns>
55         </member>
56         <member name="T:Microsoft.AspNetCore.Localization.CustomRequestCultureProvider">
57             <summary>
58             Determines the culture information for a request via the configured delegate.
59             </summary>
60         </member>
61         <member name="M:Microsoft.AspNetCore.Localization.CustomRequestCultureProvider.#ctor(System.Func{Microsoft.AspNetCore.Http.HttpContext,System.Threading.Tasks.Task{Microsoft.AspNetCore.Localization.ProviderCultureResult}})">
62             <summary>
63             Creates a new <see cref="T:Microsoft.AspNetCore.Localization.CustomRequestCultureProvider"/> using the specified delegate.
64             </summary>
65             <param name="provider">The provider delegate.</param>
66         </member>
67         <member name="M:Microsoft.AspNetCore.Localization.CustomRequestCultureProvider.DetermineProviderCultureResult(Microsoft.AspNetCore.Http.HttpContext)">
68             <inheritdoc />
69         </member>
70         <member name="T:Microsoft.AspNetCore.Localization.IRequestCultureFeature">
71             <summary>
72             Represents the feature that provides the current request's culture information.
73             </summary>
74         </member>
75         <member name="P:Microsoft.AspNetCore.Localization.IRequestCultureFeature.RequestCulture">
76             <summary>
77             The <see cref="T:Microsoft.AspNetCore.Localization.RequestCulture"/> of the request.
78             </summary>
79         </member>
80         <member name="P:Microsoft.AspNetCore.Localization.IRequestCultureFeature.Provider">
81             <summary>
82             The <see cref="T:Microsoft.AspNetCore.Localization.IRequestCultureProvider"/> that determined the request's culture information.
83             If the value is <c>null</c> then no provider was used and the request's culture was set to the value of
84             <see cref="P:Microsoft.AspNetCore.Builder.RequestLocalizationOptions.DefaultRequestCulture"/>.
85             </summary>
86         </member>
87         <member name="T:Microsoft.AspNetCore.Localization.IRequestCultureProvider">
88             <summary>
89             Represents a provider for determining the culture information of an <see cref="T:Microsoft.AspNetCore.Http.HttpRequest"/>.
90             </summary>
91         </member>
92         <member name="M:Microsoft.AspNetCore.Localization.IRequestCultureProvider.DetermineProviderCultureResult(Microsoft.AspNetCore.Http.HttpContext)">
93             <summary>
94             Implements the provider to determine the culture of the given request.
95             </summary>
96             <param name="httpContext">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> for the request.</param>
97             <returns>
98                 The determined <see cref="T:Microsoft.AspNetCore.Localization.ProviderCultureResult"/>.
99                 Returns <c>null</c> if the provider couldn't determine a <see cref="T:Microsoft.AspNetCore.Localization.ProviderCultureResult"/>.
100             </returns>
101         </member>
102         <member name="T:Microsoft.AspNetCore.Localization.ProviderCultureResult">
103             <summary>
104             Details about the cultures obtained from <see cref="T:Microsoft.AspNetCore.Localization.IRequestCultureProvider"/>.
105             </summary>
106         </member>
107         <member name="M:Microsoft.AspNetCore.Localization.ProviderCultureResult.#ctor(Microsoft.Extensions.Primitives.StringSegment)">
108             <summary>
109             Creates a new <see cref="T:Microsoft.AspNetCore.Localization.ProviderCultureResult"/> object that has its <see cref="P:Microsoft.AspNetCore.Localization.ProviderCultureResult.Cultures"/> and
110             <see cref="P:Microsoft.AspNetCore.Localization.ProviderCultureResult.UICultures"/> properties set to the same culture value.
111             </summary>
112             <param name="culture">The name of the culture to be used for formatting, text, i.e. language.</param>
113         </member>
114         <member name="M:Microsoft.AspNetCore.Localization.ProviderCultureResult.#ctor(Microsoft.Extensions.Primitives.StringSegment,Microsoft.Extensions.Primitives.StringSegment)">
115             <summary>
116             Creates a new <see cref="T:Microsoft.AspNetCore.Localization.ProviderCultureResult"/> object has its <see cref="P:Microsoft.AspNetCore.Localization.ProviderCultureResult.Cultures"/> and
117             <see cref="P:Microsoft.AspNetCore.Localization.ProviderCultureResult.UICultures"/> properties set to the respective culture values provided.
118             </summary>
119             <param name="culture">The name of the culture to be used for formatting.</param>
120             <param name="uiCulture"> The name of the ui culture to be used for text, i.e. language.</param>
121         </member>
122         <member name="M:Microsoft.AspNetCore.Localization.ProviderCultureResult.#ctor(System.Collections.Generic.IList{Microsoft.Extensions.Primitives.StringSegment})">
123             <summary>
124             Creates a new <see cref="T:Microsoft.AspNetCore.Localization.ProviderCultureResult"/> object that has its <see cref="P:Microsoft.AspNetCore.Localization.ProviderCultureResult.Cultures"/> and
125             <see cref="P:Microsoft.AspNetCore.Localization.ProviderCultureResult.UICultures"/> properties set to the same culture value.
126             </summary>
127             <param name="cultures">The list of cultures to be used for formatting, text, i.e. language.</param>
128         </member>
129         <member name="M:Microsoft.AspNetCore.Localization.ProviderCultureResult.#ctor(System.Collections.Generic.IList{Microsoft.Extensions.Primitives.StringSegment},System.Collections.Generic.IList{Microsoft.Extensions.Primitives.StringSegment})">
130             <summary>
131             Creates a new <see cref="T:Microsoft.AspNetCore.Localization.ProviderCultureResult"/> object has its <see cref="P:Microsoft.AspNetCore.Localization.ProviderCultureResult.Cultures"/> and
132             <see cref="P:Microsoft.AspNetCore.Localization.ProviderCultureResult.UICultures"/> properties set to the respective culture values provided.
133             </summary>
134             <param name="cultures">The list of cultures to be used for formatting.</param>
135             <param name="uiCultures">The list of ui cultures to be used for text, i.e. language.</param>
136         </member>
137         <member name="P:Microsoft.AspNetCore.Localization.ProviderCultureResult.Cultures">
138             <summary>
139             Gets the list of cultures to be used for formatting.
140             </summary>
141         </member>
142         <member name="P:Microsoft.AspNetCore.Localization.ProviderCultureResult.UICultures">
143             <summary>
144             Gets the list of ui cultures to be used for text, i.e. language;
145             </summary>
146         </member>
147         <member name="T:Microsoft.AspNetCore.Localization.QueryStringRequestCultureProvider">
148             <summary>
149             Determines the culture information for a request via values in the query string.
150             </summary>
151         </member>
152         <member name="P:Microsoft.AspNetCore.Localization.QueryStringRequestCultureProvider.QueryStringKey">
153             <summary>
154             The key that contains the culture name.
155             Defaults to "culture".
156             </summary>
157         </member>
158         <member name="P:Microsoft.AspNetCore.Localization.QueryStringRequestCultureProvider.UIQueryStringKey">
159             <summary>
160             The key that contains the UI culture name. If not specified or no value is found,
161             <see cref="P:Microsoft.AspNetCore.Localization.QueryStringRequestCultureProvider.QueryStringKey"/> will be used.
162             Defaults to "ui-culture".
163             </summary>
164         </member>
165         <member name="M:Microsoft.AspNetCore.Localization.QueryStringRequestCultureProvider.DetermineProviderCultureResult(Microsoft.AspNetCore.Http.HttpContext)">
166             <inheritdoc />
167         </member>
168         <member name="T:Microsoft.AspNetCore.Localization.RequestCulture">
169             <summary>
170             Details about the culture for an <see cref="T:Microsoft.AspNetCore.Http.HttpRequest"/>.
171             </summary>
172         </member>
173         <member name="M:Microsoft.AspNetCore.Localization.RequestCulture.#ctor(System.Globalization.CultureInfo)">
174             <summary>
175             Creates a new <see cref="T:Microsoft.AspNetCore.Localization.RequestCulture"/> object has its <see cref="P:Microsoft.AspNetCore.Localization.RequestCulture.Culture"/> and <see cref="P:Microsoft.AspNetCore.Localization.RequestCulture.UICulture"/>
176             properties set to the same <see cref="T:System.Globalization.CultureInfo"/> value.
177             </summary>
178             <param name="culture">The <see cref="T:System.Globalization.CultureInfo"/> for the request.</param>
179         </member>
180         <member name="M:Microsoft.AspNetCore.Localization.RequestCulture.#ctor(System.String)">
181             <summary>
182             Creates a new <see cref="T:Microsoft.AspNetCore.Localization.RequestCulture"/> object has its <see cref="P:Microsoft.AspNetCore.Localization.RequestCulture.Culture"/> and <see cref="P:Microsoft.AspNetCore.Localization.RequestCulture.UICulture"/>
183             properties set to the same <see cref="T:System.Globalization.CultureInfo"/> value.
184             </summary>
185             <param name="culture">The culture for the request.</param>
186         </member>
187         <member name="M:Microsoft.AspNetCore.Localization.RequestCulture.#ctor(System.String,System.String)">
188             <summary>
189             Creates a new <see cref="T:Microsoft.AspNetCore.Localization.RequestCulture"/> object has its <see cref="P:Microsoft.AspNetCore.Localization.RequestCulture.Culture"/> and <see cref="P:Microsoft.AspNetCore.Localization.RequestCulture.UICulture"/>
190             properties set to the respective <see cref="T:System.Globalization.CultureInfo"/> values provided.
191             </summary>
192             <param name="culture">The culture for the request to be used for formatting.</param>
193             <param name="uiCulture">The culture for the request to be used for text, i.e. language.</param>
194         </member>
195         <member name="M:Microsoft.AspNetCore.Localization.RequestCulture.#ctor(System.Globalization.CultureInfo,System.Globalization.CultureInfo)">
196             <summary>
197             Creates a new <see cref="T:Microsoft.AspNetCore.Localization.RequestCulture"/> object has its <see cref="P:Microsoft.AspNetCore.Localization.RequestCulture.Culture"/> and <see cref="P:Microsoft.AspNetCore.Localization.RequestCulture.UICulture"/>
198             properties set to the respective <see cref="T:System.Globalization.CultureInfo"/> values provided.
199             </summary>
200             <param name="culture">The <see cref="T:System.Globalization.CultureInfo"/> for the request to be used for formatting.</param>
201             <param name="uiCulture">The <see cref="T:System.Globalization.CultureInfo"/> for the request to be used for text, i.e. language.</param>
202         </member>
203         <member name="P:Microsoft.AspNetCore.Localization.RequestCulture.Culture">
204             <summary>
205             Gets the <see cref="T:System.Globalization.CultureInfo"/> for the request to be used for formatting.
206             </summary>
207         </member>
208         <member name="P:Microsoft.AspNetCore.Localization.RequestCulture.UICulture">
209             <summary>
210             Gets the <see cref="T:System.Globalization.CultureInfo"/> for the request to be used for text, i.e. language;
211             </summary>
212         </member>
213         <member name="T:Microsoft.AspNetCore.Localization.RequestCultureFeature">
214             <summary>
215             Provides the current request's culture information.
216             </summary>
217         </member>
218         <member name="M:Microsoft.AspNetCore.Localization.RequestCultureFeature.#ctor(Microsoft.AspNetCore.Localization.RequestCulture,Microsoft.AspNetCore.Localization.IRequestCultureProvider)">
219             <summary>
220             Creates a new <see cref="T:Microsoft.AspNetCore.Localization.RequestCultureFeature"/> with the specified <see cref="T:Microsoft.AspNetCore.Localization.RequestCulture"/>.
221             </summary>
222             <param name="requestCulture">The <see cref="T:Microsoft.AspNetCore.Localization.RequestCulture"/>.</param>
223             <param name="provider">The <see cref="T:Microsoft.AspNetCore.Localization.IRequestCultureProvider"/>.</param>
224         </member>
225         <member name="P:Microsoft.AspNetCore.Localization.RequestCultureFeature.RequestCulture">
226             <inheritdoc />
227         </member>
228         <member name="P:Microsoft.AspNetCore.Localization.RequestCultureFeature.Provider">
229             <inheritdoc />
230         </member>
231         <member name="T:Microsoft.AspNetCore.Localization.RequestCultureProvider">
232             <summary>
233             An abstract base class provider for determining the culture information of an <see cref="T:Microsoft.AspNetCore.Http.HttpRequest"/>.
234             </summary>
235         </member>
236         <member name="F:Microsoft.AspNetCore.Localization.RequestCultureProvider.NullProviderCultureResult">
237             <summary>
238             Result that indicates that this instance of <see cref="T:Microsoft.AspNetCore.Localization.RequestCultureProvider" /> could not determine the
239             request culture.
240             </summary>
241         </member>
242         <member name="P:Microsoft.AspNetCore.Localization.RequestCultureProvider.Options">
243             <summary>
244             The current options for the <see cref="T:Microsoft.AspNetCore.Localization.RequestLocalizationMiddleware"/>.
245             </summary>
246         </member>
247         <member name="M:Microsoft.AspNetCore.Localization.RequestCultureProvider.DetermineProviderCultureResult(Microsoft.AspNetCore.Http.HttpContext)">
248             <inheritdoc />
249         </member>
250         <member name="T:Microsoft.AspNetCore.Localization.RequestLocalizationMiddleware">
251             <summary>
252             Enables automatic setting of the culture for <see cref="T:Microsoft.AspNetCore.Http.HttpRequest"/>s based on information
253             sent by the client in headers and logic provided by the application.
254             </summary>
255         </member>
256         <member name="M:Microsoft.AspNetCore.Localization.RequestLocalizationMiddleware.#ctor(Microsoft.AspNetCore.Http.RequestDelegate,Microsoft.Extensions.Options.IOptions{Microsoft.AspNetCore.Builder.RequestLocalizationOptions})">
257             <summary>
258             Creates a new <see cref="T:Microsoft.AspNetCore.Localization.RequestLocalizationMiddleware"/>.
259             </summary>
260             <param name="next">The <see cref="T:Microsoft.AspNetCore.Http.RequestDelegate"/> representing the next middleware in the pipeline.</param>
261             <param name="options">The <see cref="T:Microsoft.AspNetCore.Builder.RequestLocalizationOptions"/> representing the options for the
262             <see cref="T:Microsoft.AspNetCore.Localization.RequestLocalizationMiddleware"/>.</param>
263         </member>
264         <member name="M:Microsoft.AspNetCore.Localization.RequestLocalizationMiddleware.Invoke(Microsoft.AspNetCore.Http.HttpContext)">
265             <summary>
266             Invokes the logic of the middleware.
267             </summary>
268             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
269             <returns>A <see cref="T:System.Threading.Tasks.Task"/> that completes when the middleware has completed processing.</returns>
270         </member>
271         <member name="T:Microsoft.AspNetCore.Builder.ApplicationBuilderExtensions">
272             <summary>
273             Extension methods for adding the <see cref="T:Microsoft.AspNetCore.Localization.RequestLocalizationMiddleware"/> to an application.
274             </summary>
275         </member>
276         <member name="M:Microsoft.AspNetCore.Builder.ApplicationBuilderExtensions.UseRequestLocalization(Microsoft.AspNetCore.Builder.IApplicationBuilder)">
277             <summary>
278             Adds the <see cref="T:Microsoft.AspNetCore.Localization.RequestLocalizationMiddleware"/> to automatically set culture information for
279             requests based on information provided by the client.
280             </summary>
281             <param name="app">The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/>.</param>
282             <returns>The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/>.</returns>
283         </member>
284         <member name="M:Microsoft.AspNetCore.Builder.ApplicationBuilderExtensions.UseRequestLocalization(Microsoft.AspNetCore.Builder.IApplicationBuilder,Microsoft.AspNetCore.Builder.RequestLocalizationOptions)">
285             <summary>
286             Adds the <see cref="T:Microsoft.AspNetCore.Localization.RequestLocalizationMiddleware"/> to automatically set culture information for
287             requests based on information provided by the client.
288             </summary>
289             <param name="app">The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/>.</param>
290             <param name="options">The <see cref="T:Microsoft.AspNetCore.Builder.RequestLocalizationOptions"/> to configure the middleware with.</param>
291             <returns>The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/>.</returns>
292         </member>
293         <member name="T:Microsoft.AspNetCore.Builder.RequestLocalizationOptions">
294             <summary>
295             Specifies options for the <see cref="T:Microsoft.AspNetCore.Localization.RequestLocalizationMiddleware"/>.
296             </summary>
297         </member>
298         <member name="M:Microsoft.AspNetCore.Builder.RequestLocalizationOptions.#ctor">
299             <summary>
300             Creates a new <see cref="T:Microsoft.AspNetCore.Builder.RequestLocalizationOptions"/> with default values.
301             </summary>
302         </member>
303         <member name="P:Microsoft.AspNetCore.Builder.RequestLocalizationOptions.DefaultRequestCulture">
304             <summary>
305             Gets or sets the default culture to use for requests when a supported culture could not be determined by
306             one of the configured <see cref="T:Microsoft.AspNetCore.Localization.IRequestCultureProvider"/>s.
307             Defaults to <see cref="P:System.Globalization.CultureInfo.CurrentCulture"/> and <see cref="P:System.Globalization.CultureInfo.CurrentUICulture"/>.
308             </summary>
309         </member>
310         <member name="P:Microsoft.AspNetCore.Builder.RequestLocalizationOptions.FallBackToParentCultures">
311             <summary>
312             Gets or sets a value indicating whether to set a request culture to an parent culture in the case the
313             culture determined by the configured <see cref="T:Microsoft.AspNetCore.Localization.IRequestCultureProvider"/>s is not in the
314             <see cref="P:Microsoft.AspNetCore.Builder.RequestLocalizationOptions.SupportedCultures"/> list but a parent culture is.
315             Defaults to <c>true</c>;
316             </summary>
317             <remarks>
318             Note that the parent culture check is done using only the culture name.
319             </remarks>
320             <example>
321             If this property is <c>true</c> and the application is configured to support the culture "fr", but not the
322             culture "fr-FR", and a configured <see cref="T:Microsoft.AspNetCore.Localization.IRequestCultureProvider"/> determines a request's culture is
323             "fr-FR", then the request's culture will be set to the culture "fr", as it is a parent of "fr-FR".
324             </example>
325         </member>
326         <member name="P:Microsoft.AspNetCore.Builder.RequestLocalizationOptions.FallBackToParentUICultures">
327             <summary>
328             Gets or sets a value indicating whether to set a request UI culture to a parent culture in the case the
329             UI culture determined by the configured <see cref="T:Microsoft.AspNetCore.Localization.IRequestCultureProvider"/>s is not in the
330             <see cref="P:Microsoft.AspNetCore.Builder.RequestLocalizationOptions.SupportedUICultures"/> list but a parent culture is.
331             Defaults to <c>true</c>;
332             </summary>
333             <remarks>
334             Note that the parent culture check is done using ony the culture name.
335             </remarks>
336             <example>
337             If this property is <c>true</c> and the application is configured to support the UI culture "fr", but not
338             the UI culture "fr-FR", and a configured <see cref="T:Microsoft.AspNetCore.Localization.IRequestCultureProvider"/> determines a request's UI
339             culture is "fr-FR", then the request's UI culture will be set to the culture "fr", as it is a parent of
340             "fr-FR".
341             </example>
342         </member>
343         <member name="P:Microsoft.AspNetCore.Builder.RequestLocalizationOptions.SupportedCultures">
344             <summary>
345             The cultures supported by the application. The <see cref="T:Microsoft.AspNetCore.Localization.RequestLocalizationMiddleware"/> will only set
346             the current request culture to an entry in this list.
347             Defaults to <see cref="P:System.Globalization.CultureInfo.CurrentCulture"/>.
348             </summary>
349         </member>
350         <member name="P:Microsoft.AspNetCore.Builder.RequestLocalizationOptions.SupportedUICultures">
351             <summary>
352             The UI cultures supported by the application. The <see cref="T:Microsoft.AspNetCore.Localization.RequestLocalizationMiddleware"/> will only set
353             the current request culture to an entry in this list.
354             Defaults to <see cref="P:System.Globalization.CultureInfo.CurrentUICulture"/>.
355             </summary>
356         </member>
357         <member name="P:Microsoft.AspNetCore.Builder.RequestLocalizationOptions.RequestCultureProviders">
358             <summary>
359             An ordered list of providers used to determine a request's culture information. The first provider that
360             returns a non-<c>null</c> result for a given request will be used.
361             Defaults to the following:
362             <list type="number">
363                 <item><description><see cref="T:Microsoft.AspNetCore.Localization.QueryStringRequestCultureProvider"/></description></item>
364                 <item><description><see cref="T:Microsoft.AspNetCore.Localization.CookieRequestCultureProvider"/></description></item>
365                 <item><description><see cref="T:Microsoft.AspNetCore.Localization.AcceptLanguageHeaderRequestCultureProvider"/></description></item>
366             </list>
367             </summary>
368         </member>
369     </members>
370 </doc>