-
Notifications
You must be signed in to change notification settings - Fork 112
/
StaticFileOptions.xml
324 lines (324 loc) · 20.1 KB
/
StaticFileOptions.xml
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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
<Type Name="StaticFileOptions" FullName="Microsoft.AspNetCore.Builder.StaticFileOptions">
<TypeSignature Language="C++ CLI" Value="public ref class StaticFileOptions : Microsoft::AspNetCore::StaticFiles::Infrastructure::SharedOptionsBase" />
<TypeSignature Language="C#" Value="public class StaticFileOptions : Microsoft.AspNetCore.StaticFiles.Infrastructure.SharedOptionsBase" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit StaticFileOptions extends Microsoft.AspNetCore.StaticFiles.Infrastructure.SharedOptionsBase" />
<TypeSignature Language="DocId" Value="T:Microsoft.AspNetCore.Builder.StaticFileOptions" />
<TypeSignature Language="VB.NET" Value="Public Class StaticFileOptions
Inherits SharedOptionsBase" />
<TypeSignature Language="F#" Value="type StaticFileOptions = class
 inherit SharedOptionsBase" />
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.StaticFiles</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.AspNetCore.StaticFiles.Infrastructure.SharedOptionsBase</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Options for serving static files
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C++ CLI" Value="public:
 StaticFileOptions();" />
<MemberSignature Language="C#" Value="public StaticFileOptions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Builder.StaticFileOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.StaticFiles</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Defaults to all request paths
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C++ CLI" Value="public:
 StaticFileOptions(Microsoft::AspNetCore::StaticFiles::Infrastructure::SharedOptions ^ sharedOptions);" />
<MemberSignature Language="C#" Value="public StaticFileOptions (Microsoft.AspNetCore.StaticFiles.Infrastructure.SharedOptions sharedOptions);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.AspNetCore.StaticFiles.Infrastructure.SharedOptions sharedOptions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Builder.StaticFileOptions.#ctor(Microsoft.AspNetCore.StaticFiles.Infrastructure.SharedOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (sharedOptions As SharedOptions)" />
<MemberSignature Language="F#" Value="new Microsoft.AspNetCore.Builder.StaticFileOptions : Microsoft.AspNetCore.StaticFiles.Infrastructure.SharedOptions -> Microsoft.AspNetCore.Builder.StaticFileOptions" Usage="new Microsoft.AspNetCore.Builder.StaticFileOptions sharedOptions" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.StaticFiles</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="sharedOptions" Type="Microsoft.AspNetCore.StaticFiles.Infrastructure.SharedOptions" />
</Parameters>
<Docs>
<param name="sharedOptions" />
<summary>
Defaults to all request paths
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ContentTypeProvider">
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::AspNetCore::StaticFiles::IContentTypeProvider ^ ContentTypeProvider { Microsoft::AspNetCore::StaticFiles::IContentTypeProvider ^ get(); void set(Microsoft::AspNetCore::StaticFiles::IContentTypeProvider ^ value); };" />
<MemberSignature Language="C#" Value="public Microsoft.AspNetCore.StaticFiles.IContentTypeProvider ContentTypeProvider { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.AspNetCore.StaticFiles.IContentTypeProvider ContentTypeProvider" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Builder.StaticFileOptions.ContentTypeProvider" />
<MemberSignature Language="VB.NET" Value="Public Property ContentTypeProvider As IContentTypeProvider" />
<MemberSignature Language="F#" Value="member this.ContentTypeProvider : Microsoft.AspNetCore.StaticFiles.IContentTypeProvider with get, set" Usage="Microsoft.AspNetCore.Builder.StaticFileOptions.ContentTypeProvider" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.StaticFiles</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.AspNetCore.StaticFiles.IContentTypeProvider</ReturnType>
</ReturnValue>
<Docs>
<summary>
Used to map files to content-types.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DefaultContentType">
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ DefaultContentType { System::String ^ get(); void set(System::String ^ value); };" />
<MemberSignature Language="C#" Value="public string DefaultContentType { get; set; }" FrameworkAlternate="aspnetcore-1.0;aspnetcore-1.1;aspnetcore-2.0;aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0" />
<MemberSignature Language="ILAsm" Value=".property instance string DefaultContentType" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Builder.StaticFileOptions.DefaultContentType" />
<MemberSignature Language="VB.NET" Value="Public Property DefaultContentType As String" />
<MemberSignature Language="F#" Value="member this.DefaultContentType : string with get, set" Usage="Microsoft.AspNetCore.Builder.StaticFileOptions.DefaultContentType" />
<MemberSignature Language="C#" Value="public string? DefaultContentType { get; set; }" FrameworkAlternate="aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.StaticFiles</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.NullableContext(2)]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.CompilerServices.NullableContext(2)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[set: System.Runtime.CompilerServices.NullableContext(2)]</AttributeName>
<AttributeName Language="F#">[<set: System.Runtime.CompilerServices.NullableContext(2)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The default content type for a request if the ContentTypeProvider cannot determine one.
None is provided by default, so the client must determine the format themselves.
http://www.w3.org/Protocols/rfc2616/rfc2616-sec7.html#sec7
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HttpsCompression">
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::AspNetCore::Http::Features::HttpsCompressionMode HttpsCompression { Microsoft::AspNetCore::Http::Features::HttpsCompressionMode get(); void set(Microsoft::AspNetCore::Http::Features::HttpsCompressionMode value); };" />
<MemberSignature Language="C#" Value="public Microsoft.AspNetCore.Http.Features.HttpsCompressionMode HttpsCompression { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.AspNetCore.Http.Features.HttpsCompressionMode HttpsCompression" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Builder.StaticFileOptions.HttpsCompression" />
<MemberSignature Language="VB.NET" Value="Public Property HttpsCompression As HttpsCompressionMode" />
<MemberSignature Language="F#" Value="member this.HttpsCompression : Microsoft.AspNetCore.Http.Features.HttpsCompressionMode with get, set" Usage="Microsoft.AspNetCore.Builder.StaticFileOptions.HttpsCompression" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.StaticFiles</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.AspNetCore.Http.Features.HttpsCompressionMode</ReturnType>
</ReturnValue>
<Docs>
<summary>
Indicates if files should be compressed for HTTPS requests when the Response Compression middleware is available.
The default value is <see cref="F:Microsoft.AspNetCore.Http.Features.HttpsCompressionMode.Compress" />.
</summary>
<value>To be added.</value>
<remarks>
Enabling compression on HTTPS requests for remotely manipulable content may expose security problems.
</remarks>
</Docs>
</Member>
<Member MemberName="OnPrepareResponse">
<MemberSignature Language="C++ CLI" Value="public:
 property Action<Microsoft::AspNetCore::StaticFiles::StaticFileResponseContext ^> ^ OnPrepareResponse { Action<Microsoft::AspNetCore::StaticFiles::StaticFileResponseContext ^> ^ get(); void set(Action<Microsoft::AspNetCore::StaticFiles::StaticFileResponseContext ^> ^ value); };" />
<MemberSignature Language="C#" Value="public Action<Microsoft.AspNetCore.StaticFiles.StaticFileResponseContext> OnPrepareResponse { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Action`1<class Microsoft.AspNetCore.StaticFiles.StaticFileResponseContext> OnPrepareResponse" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Builder.StaticFileOptions.OnPrepareResponse" />
<MemberSignature Language="VB.NET" Value="Public Property OnPrepareResponse As Action(Of StaticFileResponseContext)" />
<MemberSignature Language="F#" Value="member this.OnPrepareResponse : Action<Microsoft.AspNetCore.StaticFiles.StaticFileResponseContext> with get, set" Usage="Microsoft.AspNetCore.Builder.StaticFileOptions.OnPrepareResponse" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.StaticFiles</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Action<Microsoft.AspNetCore.StaticFiles.StaticFileResponseContext></ReturnType>
</ReturnValue>
<Docs>
<summary>
Called after the status code and headers have been set, but before the body has been written.
This can be used to add or change the response headers.
</summary>
<value>To be added.</value>
<remarks>
<see cref="P:Microsoft.AspNetCore.Builder.StaticFileOptions.OnPrepareResponse" /> is called before <see cref="P:Microsoft.AspNetCore.Builder.StaticFileOptions.OnPrepareResponseAsync" />.
</remarks>
</Docs>
</Member>
<Member MemberName="OnPrepareResponseAsync">
<MemberSignature Language="C#" Value="public Func<Microsoft.AspNetCore.StaticFiles.StaticFileResponseContext,System.Threading.Tasks.Task> OnPrepareResponseAsync { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Func`2<class Microsoft.AspNetCore.StaticFiles.StaticFileResponseContext, class System.Threading.Tasks.Task> OnPrepareResponseAsync" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Builder.StaticFileOptions.OnPrepareResponseAsync" />
<MemberSignature Language="VB.NET" Value="Public Property OnPrepareResponseAsync As Func(Of StaticFileResponseContext, Task)" />
<MemberSignature Language="F#" Value="member this.OnPrepareResponseAsync : Func<Microsoft.AspNetCore.StaticFiles.StaticFileResponseContext, System.Threading.Tasks.Task> with get, set" Usage="Microsoft.AspNetCore.Builder.StaticFileOptions.OnPrepareResponseAsync" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.StaticFiles</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Func<Microsoft.AspNetCore.StaticFiles.StaticFileResponseContext,System.Threading.Tasks.Task></ReturnType>
</ReturnValue>
<Docs>
<summary>
Called after the status code and headers have been set, but before the body has been written.
This can be used to add or change the response headers.
</summary>
<value>To be added.</value>
<remarks>
<see cref="P:Microsoft.AspNetCore.Builder.StaticFileOptions.OnPrepareResponse" /> is called before <see cref="P:Microsoft.AspNetCore.Builder.StaticFileOptions.OnPrepareResponseAsync" />.
</remarks>
</Docs>
</Member>
<Member MemberName="ServeUnknownFileTypes">
<MemberSignature Language="C++ CLI" Value="public:
 property bool ServeUnknownFileTypes { bool get(); void set(bool value); };" />
<MemberSignature Language="C#" Value="public bool ServeUnknownFileTypes { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool ServeUnknownFileTypes" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Builder.StaticFileOptions.ServeUnknownFileTypes" />
<MemberSignature Language="VB.NET" Value="Public Property ServeUnknownFileTypes As Boolean" />
<MemberSignature Language="F#" Value="member this.ServeUnknownFileTypes : bool with get, set" Usage="Microsoft.AspNetCore.Builder.StaticFileOptions.ServeUnknownFileTypes" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.StaticFiles</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
If the file is not a recognized content-type should it be served?
Default: false.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>