38dd4cdfea741bdbe7749af4970778bca732ba48
[platform/core/dotnet/build-tools.git] /
1 <?xml version="1.0"?>\r
2 <doc>\r
3     <assembly>\r
4         <name>Microsoft.AspNetCore.ResponseCompression</name>\r
5     </assembly>\r
6     <members>\r
7         <member name="T:Microsoft.AspNetCore.ResponseCompression.BrotliCompressionProvider">\r
8             <summary>\r
9             Brotli compression provider.\r
10             </summary>\r
11         </member>\r
12         <member name="M:Microsoft.AspNetCore.ResponseCompression.BrotliCompressionProvider.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.AspNetCore.ResponseCompression.BrotliCompressionProviderOptions})">\r
13             <summary>\r
14             Creates a new instance of <see cref="T:Microsoft.AspNetCore.ResponseCompression.BrotliCompressionProvider"/> with options.\r
15             </summary>\r
16             <param name="options"></param>\r
17         </member>\r
18         <member name="P:Microsoft.AspNetCore.ResponseCompression.BrotliCompressionProvider.EncodingName">\r
19             <inheritdoc />\r
20         </member>\r
21         <member name="P:Microsoft.AspNetCore.ResponseCompression.BrotliCompressionProvider.SupportsFlush">\r
22             <inheritdoc />\r
23         </member>\r
24         <member name="M:Microsoft.AspNetCore.ResponseCompression.BrotliCompressionProvider.CreateStream(System.IO.Stream)">\r
25             <inheritdoc />\r
26         </member>\r
27         <member name="T:Microsoft.AspNetCore.ResponseCompression.BrotliCompressionProviderOptions">\r
28             <summary>\r
29             Options for the <see cref="T:Microsoft.AspNetCore.ResponseCompression.BrotliCompressionProvider"/>\r
30             </summary>\r
31         </member>\r
32         <member name="P:Microsoft.AspNetCore.ResponseCompression.BrotliCompressionProviderOptions.Level">\r
33             <summary>\r
34             What level of compression to use for the stream. The default is <see cref="F:System.IO.Compression.CompressionLevel.Fastest"/>.\r
35             </summary>\r
36         </member>\r
37         <member name="P:Microsoft.AspNetCore.ResponseCompression.BrotliCompressionProviderOptions.Microsoft#Extensions#Options#IOptions{Microsoft#AspNetCore#ResponseCompression#BrotliCompressionProviderOptions}#Value">\r
38             <inheritdoc />\r
39         </member>\r
40         <member name="T:Microsoft.AspNetCore.ResponseCompression.CompressionProviderCollection">\r
41             <summary>\r
42             A Collection of ICompressionProvider's that also allows them to be instantiated from an <see cref="T:System.IServiceProvider" />.\r
43             </summary>\r
44         </member>\r
45         <member name="M:Microsoft.AspNetCore.ResponseCompression.CompressionProviderCollection.Add``1">\r
46             <summary>\r
47             Adds a type representing an <see cref="T:Microsoft.AspNetCore.ResponseCompression.ICompressionProvider"/>.\r
48             </summary>\r
49             <remarks>\r
50             Provider instances will be created using an <see cref="T:System.IServiceProvider" />.\r
51             </remarks>\r
52         </member>\r
53         <member name="M:Microsoft.AspNetCore.ResponseCompression.CompressionProviderCollection.Add(System.Type)">\r
54             <summary>\r
55             Adds a type representing an <see cref="T:Microsoft.AspNetCore.ResponseCompression.ICompressionProvider"/>.\r
56             </summary>\r
57             <param name="providerType">Type representing an <see cref="T:Microsoft.AspNetCore.ResponseCompression.ICompressionProvider"/>.</param>\r
58             <remarks>\r
59             Provider instances will be created using an <see cref="T:System.IServiceProvider" />.\r
60             </remarks>\r
61         </member>\r
62         <member name="T:Microsoft.AspNetCore.ResponseCompression.CompressionProviderFactory">\r
63             <summary>\r
64             This is a placeholder for the CompressionProviderCollection that allows creating the given type via\r
65             an <see cref="T:System.IServiceProvider" />.\r
66             </summary>\r
67         </member>\r
68         <member name="T:Microsoft.AspNetCore.ResponseCompression.GzipCompressionProvider">\r
69             <summary>\r
70             GZIP compression provider.\r
71             </summary>\r
72         </member>\r
73         <member name="M:Microsoft.AspNetCore.ResponseCompression.GzipCompressionProvider.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.AspNetCore.ResponseCompression.GzipCompressionProviderOptions})">\r
74             <summary>\r
75             Creates a new instance of GzipCompressionProvider with options.\r
76             </summary>\r
77             <param name="options"></param>\r
78         </member>\r
79         <member name="P:Microsoft.AspNetCore.ResponseCompression.GzipCompressionProvider.EncodingName">\r
80             <inheritdoc />\r
81         </member>\r
82         <member name="P:Microsoft.AspNetCore.ResponseCompression.GzipCompressionProvider.SupportsFlush">\r
83             <inheritdoc />\r
84         </member>\r
85         <member name="M:Microsoft.AspNetCore.ResponseCompression.GzipCompressionProvider.CreateStream(System.IO.Stream)">\r
86             <inheritdoc />\r
87         </member>\r
88         <member name="T:Microsoft.AspNetCore.ResponseCompression.GzipCompressionProviderOptions">\r
89             <summary>\r
90             Options for the GzipCompressionProvider\r
91             </summary>\r
92         </member>\r
93         <member name="P:Microsoft.AspNetCore.ResponseCompression.GzipCompressionProviderOptions.Level">\r
94             <summary>\r
95             What level of compression to use for the stream. The default is Fastest.\r
96             </summary>\r
97         </member>\r
98         <member name="P:Microsoft.AspNetCore.ResponseCompression.GzipCompressionProviderOptions.Microsoft#Extensions#Options#IOptions{Microsoft#AspNetCore#ResponseCompression#GzipCompressionProviderOptions}#Value">\r
99             <inheritdoc />\r
100         </member>\r
101         <member name="T:Microsoft.AspNetCore.ResponseCompression.ICompressionProvider">\r
102             <summary>\r
103             Provides a specific compression implementation to compress HTTP responses.\r
104             </summary>\r
105         </member>\r
106         <member name="P:Microsoft.AspNetCore.ResponseCompression.ICompressionProvider.EncodingName">\r
107             <summary>\r
108             The encoding name used in the 'Accept-Encoding' request header and 'Content-Encoding' response header.\r
109             </summary>\r
110         </member>\r
111         <member name="P:Microsoft.AspNetCore.ResponseCompression.ICompressionProvider.SupportsFlush">\r
112             <summary>\r
113             Indicates if the given provider supports Flush and FlushAsync. If not, compression may be disabled in some scenarios.\r
114             </summary>\r
115         </member>\r
116         <member name="M:Microsoft.AspNetCore.ResponseCompression.ICompressionProvider.CreateStream(System.IO.Stream)">\r
117             <summary>\r
118             Create a new compression stream.\r
119             </summary>\r
120             <param name="outputStream">The stream where the compressed data have to be written.</param>\r
121             <returns>The compression stream.</returns>\r
122         </member>\r
123         <member name="T:Microsoft.AspNetCore.ResponseCompression.IResponseCompressionProvider">\r
124             <summary>\r
125             Used to examine requests and responses to see if compression should be enabled.\r
126             </summary>\r
127         </member>\r
128         <member name="M:Microsoft.AspNetCore.ResponseCompression.IResponseCompressionProvider.GetCompressionProvider(Microsoft.AspNetCore.Http.HttpContext)">\r
129             <summary>\r
130             Examines the request and selects an acceptable compression provider, if any.\r
131             </summary>\r
132             <param name="context"></param>\r
133             <returns>A compression provider or null if compression should not be used.</returns>\r
134         </member>\r
135         <member name="M:Microsoft.AspNetCore.ResponseCompression.IResponseCompressionProvider.ShouldCompressResponse(Microsoft.AspNetCore.Http.HttpContext)">\r
136             <summary>\r
137             Examines the response on first write to see if compression should be used.\r
138             </summary>\r
139             <param name="context"></param>\r
140             <returns></returns>\r
141         </member>\r
142         <member name="M:Microsoft.AspNetCore.ResponseCompression.IResponseCompressionProvider.CheckRequestAcceptsCompression(Microsoft.AspNetCore.Http.HttpContext)">\r
143             <summary>\r
144             Examines the request to see if compression should be used for response.\r
145             </summary>\r
146             <param name="context"></param>\r
147             <returns></returns>\r
148         </member>\r
149         <member name="T:Microsoft.AspNetCore.ResponseCompression.ResponseCompressionBody">\r
150             <summary>\r
151             Stream wrapper that create specific compression stream only if necessary.\r
152             </summary>\r
153         </member>\r
154         <member name="T:Microsoft.AspNetCore.ResponseCompression.ResponseCompressionDefaults">\r
155             <summary>\r
156             Defaults for the ResponseCompressionMiddleware\r
157             </summary>\r
158         </member>\r
159         <member name="F:Microsoft.AspNetCore.ResponseCompression.ResponseCompressionDefaults.MimeTypes">\r
160             <summary>\r
161             Default MIME types to compress responses for.\r
162             </summary>\r
163         </member>\r
164         <member name="T:Microsoft.AspNetCore.ResponseCompression.ResponseCompressionMiddleware">\r
165             <summary>\r
166             Enable HTTP response compression.\r
167             </summary>\r
168         </member>\r
169         <member name="M:Microsoft.AspNetCore.ResponseCompression.ResponseCompressionMiddleware.#ctor(Microsoft.AspNetCore.Http.RequestDelegate,Microsoft.AspNetCore.ResponseCompression.IResponseCompressionProvider)">\r
170             <summary>\r
171             Initialize the Response Compression middleware.\r
172             </summary>\r
173             <param name="next"></param>\r
174             <param name="provider"></param>\r
175         </member>\r
176         <member name="M:Microsoft.AspNetCore.ResponseCompression.ResponseCompressionMiddleware.Invoke(Microsoft.AspNetCore.Http.HttpContext)">\r
177             <summary>\r
178             Invoke the middleware.\r
179             </summary>\r
180             <param name="context"></param>\r
181             <returns></returns>\r
182         </member>\r
183         <member name="T:Microsoft.AspNetCore.ResponseCompression.ResponseCompressionOptions">\r
184             <summary>\r
185             Options for the HTTP response compression middleware.\r
186             </summary>\r
187         </member>\r
188         <member name="P:Microsoft.AspNetCore.ResponseCompression.ResponseCompressionOptions.MimeTypes">\r
189             <summary>\r
190             Response Content-Type MIME types to compress.\r
191             </summary>\r
192         </member>\r
193         <member name="P:Microsoft.AspNetCore.ResponseCompression.ResponseCompressionOptions.ExcludedMimeTypes">\r
194             <summary>\r
195             Response Content-Type MIME types to not compress.\r
196             </summary>\r
197         </member>\r
198         <member name="P:Microsoft.AspNetCore.ResponseCompression.ResponseCompressionOptions.EnableForHttps">\r
199             <summary>\r
200             Indicates if responses over HTTPS connections should be compressed. The default is 'false'.\r
201             Enabling compression on HTTPS requests for remotely manipulable content may expose security problems.\r
202             </summary>\r
203             <remarks>\r
204             This can be overridden per request using <see cref="T:Microsoft.AspNetCore.Http.Features.IHttpsCompressionFeature"/>.\r
205             </remarks>\r
206         </member>\r
207         <member name="P:Microsoft.AspNetCore.ResponseCompression.ResponseCompressionOptions.Providers">\r
208             <summary>\r
209             The <see cref="T:Microsoft.AspNetCore.ResponseCompression.ICompressionProvider"/> types to use for responses.\r
210             Providers are prioritized based on the order they are added.\r
211             </summary>\r
212         </member>\r
213         <member name="T:Microsoft.AspNetCore.ResponseCompression.ResponseCompressionProvider">\r
214             <inheritdoc />\r
215         </member>\r
216         <member name="M:Microsoft.AspNetCore.ResponseCompression.ResponseCompressionProvider.#ctor(System.IServiceProvider,Microsoft.Extensions.Options.IOptions{Microsoft.AspNetCore.ResponseCompression.ResponseCompressionOptions})">\r
217             <summary>\r
218             If no compression providers are specified then GZip is used by default.\r
219             </summary>\r
220             <param name="services">Services to use when instantiating compression providers.</param>\r
221             <param name="options"></param>\r
222         </member>\r
223         <member name="M:Microsoft.AspNetCore.ResponseCompression.ResponseCompressionProvider.GetCompressionProvider(Microsoft.AspNetCore.Http.HttpContext)">\r
224             <inheritdoc />\r
225         </member>\r
226         <member name="M:Microsoft.AspNetCore.ResponseCompression.ResponseCompressionProvider.ShouldCompressResponse(Microsoft.AspNetCore.Http.HttpContext)">\r
227             <inheritdoc />\r
228         </member>\r
229         <member name="M:Microsoft.AspNetCore.ResponseCompression.ResponseCompressionProvider.CheckRequestAcceptsCompression(Microsoft.AspNetCore.Http.HttpContext)">\r
230             <inheritdoc />\r
231         </member>\r
232         <member name="T:Microsoft.AspNetCore.Builder.ResponseCompressionBuilderExtensions">\r
233             <summary>\r
234             Extension methods for the ResponseCompression middleware.\r
235             </summary>\r
236         </member>\r
237         <member name="M:Microsoft.AspNetCore.Builder.ResponseCompressionBuilderExtensions.UseResponseCompression(Microsoft.AspNetCore.Builder.IApplicationBuilder)">\r
238             <summary>\r
239             Adds middleware for dynamically compressing HTTP Responses.\r
240             </summary>\r
241             <param name="builder">The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/> instance this method extends.</param>\r
242         </member>\r
243         <member name="T:Microsoft.AspNetCore.Builder.ResponseCompressionServicesExtensions">\r
244             <summary>\r
245             Extension methods for the ResponseCompression middleware.\r
246             </summary>\r
247         </member>\r
248         <member name="M:Microsoft.AspNetCore.Builder.ResponseCompressionServicesExtensions.AddResponseCompression(Microsoft.Extensions.DependencyInjection.IServiceCollection)">\r
249             <summary>\r
250             Add response compression services.\r
251             </summary>\r
252             <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> for adding services.</param>\r
253             <returns></returns>\r
254         </member>\r
255         <member name="M:Microsoft.AspNetCore.Builder.ResponseCompressionServicesExtensions.AddResponseCompression(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.AspNetCore.ResponseCompression.ResponseCompressionOptions})">\r
256             <summary>\r
257             Add response compression services and configure the related options.\r
258             </summary>\r
259             <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> for adding services.</param>\r
260             <param name="configureOptions">A delegate to configure the <see cref="T:Microsoft.AspNetCore.ResponseCompression.ResponseCompressionOptions"/>.</param>\r
261             <returns></returns>\r
262         </member>\r
263     </members>\r
264 </doc>\r