-
Notifications
You must be signed in to change notification settings - Fork 111
/
RouteOptions.xml
335 lines (335 loc) · 19.8 KB
/
RouteOptions.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
325
326
327
328
329
330
331
332
333
334
335
<Type Name="RouteOptions" FullName="Microsoft.AspNetCore.Routing.RouteOptions">
<TypeSignature Language="C++ CLI" Value="public ref class RouteOptions" />
<TypeSignature Language="C#" Value="public class RouteOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit RouteOptions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.AspNetCore.Routing.RouteOptions" />
<TypeSignature Language="VB.NET" Value="Public Class RouteOptions" />
<TypeSignature Language="F#" Value="type RouteOptions = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Routing</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>System.Object</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>
Represents the configurable options on a route.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C++ CLI" Value="public:
 RouteOptions();" />
<MemberSignature Language="C#" Value="public RouteOptions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Routing.RouteOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Routing</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>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AppendTrailingSlash">
<MemberSignature Language="C++ CLI" Value="public:
 property bool AppendTrailingSlash { bool get(); void set(bool value); };" />
<MemberSignature Language="C#" Value="public bool AppendTrailingSlash { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool AppendTrailingSlash" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Routing.RouteOptions.AppendTrailingSlash" />
<MemberSignature Language="VB.NET" Value="Public Property AppendTrailingSlash As Boolean" />
<MemberSignature Language="F#" Value="member this.AppendTrailingSlash : bool with get, set" Usage="Microsoft.AspNetCore.Routing.RouteOptions.AppendTrailingSlash" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Routing</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>
Gets or sets a value indicating whether a trailing slash should be appended to the generated URLs.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ConstraintMap">
<MemberSignature Language="C++ CLI" Value="public:
 property System::Collections::Generic::IDictionary<System::String ^, Type ^> ^ ConstraintMap { System::Collections::Generic::IDictionary<System::String ^, Type ^> ^ get(); void set(System::Collections::Generic::IDictionary<System::String ^, Type ^> ^ value); };" />
<MemberSignature Language="C#" Value="public System.Collections.Generic.IDictionary<string,Type> ConstraintMap { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2<string, class System.Type> ConstraintMap" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Routing.RouteOptions.ConstraintMap" />
<MemberSignature Language="VB.NET" Value="Public Property ConstraintMap As IDictionary(Of String, Type)" />
<MemberSignature Language="F#" Value="member this.ConstraintMap : System.Collections.Generic.IDictionary<string, Type> with get, set" Usage="Microsoft.AspNetCore.Routing.RouteOptions.ConstraintMap" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Routing</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-7.0;aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[get: System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("The linker cannot determine what constraints are being added via the ConstraintMap property. Prefer RouteOptions.SetParameterPolicy instead for setting constraints. This warning can be suppressed if this property is being used to read or delete constraints.")]</AttributeName>
<AttributeName Language="F#">[<get: System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("The linker cannot determine what constraints are being added via the ConstraintMap property. Prefer RouteOptions.SetParameterPolicy instead for setting constraints. This warning can be suppressed if this property is being used to read or delete constraints.")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IDictionary<System.String,System.Type></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a collection of constraints on the current route.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LowercaseQueryStrings">
<MemberSignature Language="C++ CLI" Value="public:
 property bool LowercaseQueryStrings { bool get(); void set(bool value); };" />
<MemberSignature Language="C#" Value="public bool LowercaseQueryStrings { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool LowercaseQueryStrings" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Routing.RouteOptions.LowercaseQueryStrings" />
<MemberSignature Language="VB.NET" Value="Public Property LowercaseQueryStrings As Boolean" />
<MemberSignature Language="F#" Value="member this.LowercaseQueryStrings : bool with get, set" Usage="Microsoft.AspNetCore.Routing.RouteOptions.LowercaseQueryStrings" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Routing</AssemblyName>
<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>
Gets or sets a value indicating whether a generated query strings are lowercase.
This property will not be used unless <see cref="P:Microsoft.AspNetCore.Routing.RouteOptions.LowercaseUrls" /> is also <c>true</c>.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LowercaseUrls">
<MemberSignature Language="C++ CLI" Value="public:
 property bool LowercaseUrls { bool get(); void set(bool value); };" />
<MemberSignature Language="C#" Value="public bool LowercaseUrls { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool LowercaseUrls" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Routing.RouteOptions.LowercaseUrls" />
<MemberSignature Language="VB.NET" Value="Public Property LowercaseUrls As Boolean" />
<MemberSignature Language="F#" Value="member this.LowercaseUrls : bool with get, set" Usage="Microsoft.AspNetCore.Routing.RouteOptions.LowercaseUrls" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Routing</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>
Gets or sets a value indicating whether all generated paths URLs are lowercase.
Use <see cref="P:Microsoft.AspNetCore.Routing.RouteOptions.LowercaseQueryStrings" /> to configure the behavior for query strings.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetParameterPolicy">
<MemberSignature Language="C#" Value="public void SetParameterPolicy (string token, Type type);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetParameterPolicy(string token, class System.Type type) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Routing.RouteOptions.SetParameterPolicy(System.String,System.Type)" />
<MemberSignature Language="VB.NET" Value="Public Sub SetParameterPolicy (token As String, type As Type)" />
<MemberSignature Language="F#" Value="member this.SetParameterPolicy : string * Type -> unit" Usage="routeOptions.SetParameterPolicy (token, type)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Routing</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="token" Type="System.String" Index="0" FrameworkAlternate="aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0" />
<Parameter Name="type" Type="System.Type" Index="1" FrameworkAlternate="aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="token">The route token used to apply the parameter policy.</param>
<param name="type">The parameter policy type.</param>
<summary>
Adds or overwrites the parameter policy with the associated route pattern token.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">Throws an exception if the type is not an <see cref="T:Microsoft.AspNetCore.Routing.IParameterPolicy" />.</exception>
</Docs>
</Member>
<Member MemberName="SetParameterPolicy<T>">
<MemberSignature Language="C#" Value="public void SetParameterPolicy<T> (string token) where T : Microsoft.AspNetCore.Routing.IParameterPolicy;" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetParameterPolicy<(class Microsoft.AspNetCore.Routing.IParameterPolicy) T>(string token) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Routing.RouteOptions.SetParameterPolicy``1(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub SetParameterPolicy(Of T As IParameterPolicy) (token As String)" />
<MemberSignature Language="F#" Value="member this.SetParameterPolicy : string -> unit (requires 'T :> Microsoft.AspNetCore.Routing.IParameterPolicy)" Usage="routeOptions.SetParameterPolicy token" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Routing</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)>]</AttributeName>
</Attribute>
<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>
</Attributes>
<Constraints>
<InterfaceName>Microsoft.AspNetCore.Routing.IParameterPolicy</InterfaceName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="token" Type="System.String" Index="0" FrameworkAlternate="aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0" />
</Parameters>
<Docs>
<typeparam name="T">The parameter policy type.</typeparam>
<param name="token">The route token used to apply the parameter policy.</param>
<summary>
Adds or overwrites the parameter policy with the associated route pattern token.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SuppressCheckForUnhandledSecurityMetadata">
<MemberSignature Language="C++ CLI" Value="public:
 property bool SuppressCheckForUnhandledSecurityMetadata { bool get(); void set(bool value); };" />
<MemberSignature Language="C#" Value="public bool SuppressCheckForUnhandledSecurityMetadata { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool SuppressCheckForUnhandledSecurityMetadata" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Routing.RouteOptions.SuppressCheckForUnhandledSecurityMetadata" />
<MemberSignature Language="VB.NET" Value="Public Property SuppressCheckForUnhandledSecurityMetadata As Boolean" />
<MemberSignature Language="F#" Value="member this.SuppressCheckForUnhandledSecurityMetadata : bool with get, set" Usage="Microsoft.AspNetCore.Routing.RouteOptions.SuppressCheckForUnhandledSecurityMetadata" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Routing</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>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a value that indicates if the check for unhandled security endpoint metadata is suppressed.
<para>
Endpoints can be associated with metadata such as authorization, or CORS, that needs to be
handled by a specific middleware to be actionable. If the middleware is not configured, such
metadata will go unhandled.
</para><para>
When <see langword="false" />, prior to the execution of the endpoint, routing will verify that
all known security-specific metadata has been handled.
Setting this property to <see langword="true" /> suppresses this check.
</para></summary>
<value>Defaults to <see langword="false" />.</value>
<remarks>
This check exists as a safeguard against accidental insecure configuration. You may suppress
this check if it does not match your application's requirements.
</remarks>
</Docs>
</Member>
</Members>
</Type>