/
ApiParameterRouteInfo.xml
214 lines (213 loc) · 13.4 KB
/
ApiParameterRouteInfo.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
<Type Name="ApiParameterRouteInfo" FullName="Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterRouteInfo">
<TypeSignature Language="C++ CLI" Value="public ref class ApiParameterRouteInfo" />
<TypeSignature Language="C#" Value="public class ApiParameterRouteInfo" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ApiParameterRouteInfo extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterRouteInfo" />
<TypeSignature Language="VB.NET" Value="Public Class ApiParameterRouteInfo" />
<TypeSignature Language="F#" Value="type ApiParameterRouteInfo = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.ApiExplorer</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.Abstractions</AssemblyName>
<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>
</AssemblyInfo>
<TypeForwardingChain>
<TypeForwarding From="Microsoft.AspNetCore.Mvc.ApiExplorer" FromVersion="2.0.0.0" To="Microsoft.AspNetCore.Mvc.Abstractions" ToVersion="2.0.0.0" FrameworkAlternate="aspnetcore-2.0" />
<TypeForwarding From="Microsoft.AspNetCore.Mvc.ApiExplorer" FromVersion="2.1.0.0" To="Microsoft.AspNetCore.Mvc.Abstractions" ToVersion="2.1.0.0" FrameworkAlternate="aspnetcore-2.1" />
<TypeForwarding From="Microsoft.AspNetCore.Mvc.ApiExplorer" FromVersion="2.2.0.0" To="Microsoft.AspNetCore.Mvc.Abstractions" ToVersion="2.2.0.0" FrameworkAlternate="aspnetcore-2.2" />
<TypeForwarding From="Microsoft.AspNetCore.Mvc.ApiExplorer" FromVersion="3.0.0.0" To="Microsoft.AspNetCore.Mvc.Abstractions" ToVersion="3.0.0.0" FrameworkAlternate="aspnetcore-3.0" />
<TypeForwarding From="Microsoft.AspNetCore.Mvc.ApiExplorer" FromVersion="3.1.0.0" To="Microsoft.AspNetCore.Mvc.Abstractions" ToVersion="3.1.0.0" FrameworkAlternate="aspnetcore-3.1" />
<TypeForwarding From="Microsoft.AspNetCore.Mvc.ApiExplorer" FromVersion="5.0.0.0" To="Microsoft.AspNetCore.Mvc.Abstractions" ToVersion="5.0.0.0" FrameworkAlternate="aspnetcore-5.0" />
<TypeForwarding From="Microsoft.AspNetCore.Mvc.ApiExplorer" FromVersion="6.0.0.0" To="Microsoft.AspNetCore.Mvc.Abstractions" ToVersion="6.0.0.0" FrameworkAlternate="aspnetcore-6.0" />
<TypeForwarding From="Microsoft.AspNetCore.Mvc.ApiExplorer" FromVersion="7.0.0.0" To="Microsoft.AspNetCore.Mvc.Abstractions" ToVersion="7.0.0.0" FrameworkAlternate="aspnetcore-7.0" />
<TypeForwarding From="Microsoft.AspNetCore.Mvc.ApiExplorer" FromVersion="8.0.0.0" To="Microsoft.AspNetCore.Mvc.Abstractions" ToVersion="8.0.0.0" FrameworkAlternate="aspnetcore-8.0" />
</TypeForwardingChain>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-8.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">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(2)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
A metadata description of routing information for an <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterDescription" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C++ CLI" Value="public:
 ApiParameterRouteInfo();" />
<MemberSignature Language="C#" Value="public ApiParameterRouteInfo ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterRouteInfo.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.ApiExplorer</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.Abstractions</AssemblyName>
<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>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Constraints">
<MemberSignature Language="C++ CLI" Value="public:
 property System::Collections::Generic::IEnumerable<Microsoft::AspNetCore::Routing::IRouteConstraint ^> ^ Constraints { System::Collections::Generic::IEnumerable<Microsoft::AspNetCore::Routing::IRouteConstraint ^> ^ get(); void set(System::Collections::Generic::IEnumerable<Microsoft::AspNetCore::Routing::IRouteConstraint ^> ^ value); };" />
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<Microsoft.AspNetCore.Routing.IRouteConstraint> Constraints { get; set; }" FrameworkAlternate="aspnetcore-1.0;aspnetcore-1.1;aspnetcore-2.0;aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1<class Microsoft.AspNetCore.Routing.IRouteConstraint> Constraints" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterRouteInfo.Constraints" />
<MemberSignature Language="VB.NET" Value="Public Property Constraints As IEnumerable(Of IRouteConstraint)" />
<MemberSignature Language="F#" Value="member this.Constraints : seq<Microsoft.AspNetCore.Routing.IRouteConstraint> with get, set" Usage="Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterRouteInfo.Constraints" />
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<Microsoft.AspNetCore.Routing.IRouteConstraint>? Constraints { get; set; }" FrameworkAlternate="aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.ApiExplorer</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.Abstractions</AssemblyName>
<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>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-8.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable<Microsoft.AspNetCore.Routing.IRouteConstraint></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the set of <see cref="T:Microsoft.AspNetCore.Routing.IRouteConstraint" /> objects for the parameter.
</summary>
<value>To be added.</value>
<remarks>
Route constraints are only applied when a value is bound from a URL's path. See
<see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterDescription.Source" /> for the data source considered.
</remarks>
</Docs>
</Member>
<Member MemberName="DefaultValue">
<MemberSignature Language="C++ CLI" Value="public:
 property System::Object ^ DefaultValue { System::Object ^ get(); void set(System::Object ^ value); };" />
<MemberSignature Language="C#" Value="public object DefaultValue { get; set; }" FrameworkAlternate="aspnetcore-1.0;aspnetcore-1.1;aspnetcore-2.0;aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1" />
<MemberSignature Language="ILAsm" Value=".property instance object DefaultValue" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterRouteInfo.DefaultValue" />
<MemberSignature Language="VB.NET" Value="Public Property DefaultValue As Object" />
<MemberSignature Language="F#" Value="member this.DefaultValue : obj with get, set" Usage="Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterRouteInfo.DefaultValue" />
<MemberSignature Language="C#" Value="public object? DefaultValue { get; set; }" FrameworkAlternate="aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.ApiExplorer</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.Abstractions</AssemblyName>
<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>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the default value for the parameter.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsOptional">
<MemberSignature Language="C++ CLI" Value="public:
 property bool IsOptional { bool get(); void set(bool value); };" />
<MemberSignature Language="C#" Value="public bool IsOptional { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsOptional" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterRouteInfo.IsOptional" />
<MemberSignature Language="VB.NET" Value="Public Property IsOptional As Boolean" />
<MemberSignature Language="F#" Value="member this.IsOptional : bool with get, set" Usage="Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterRouteInfo.IsOptional" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.ApiExplorer</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.Abstractions</AssemblyName>
<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>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets a value indicating whether not a parameter is considered optional by routing.
</summary>
<value>To be added.</value>
<remarks>
An optional parameter is considered optional by the routing system. This does not imply
that the parameter is considered optional by the action.
If the parameter uses <see cref="F:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.ModelBinding" /> for the value of
<see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterDescription.Source" /> then the value may also come from the
URL query string or form data.
</remarks>
</Docs>
</Member>
</Members>
</Type>