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