-
Notifications
You must be signed in to change notification settings - Fork 40
/
OwnershipBuilder.xml
282 lines (282 loc) · 22.2 KB
/
OwnershipBuilder.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
<Type Name="OwnershipBuilder" FullName="Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder">
<TypeSignature Language="C#" Value="public class OwnershipBuilder : Microsoft.EntityFrameworkCore.Metadata.Builders.RelationshipBuilderBase" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit OwnershipBuilder extends Microsoft.EntityFrameworkCore.Metadata.Builders.RelationshipBuilderBase" />
<TypeSignature Language="DocId" Value="T:Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder" />
<TypeSignature Language="VB.NET" Value="Public Class OwnershipBuilder
Inherits RelationshipBuilderBase" />
<TypeSignature Language="F#" Value="type OwnershipBuilder = class
 inherit RelationshipBuilderBase" />
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</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>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.EntityFrameworkCore.Metadata.Builders.RelationshipBuilderBase</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Provides a simple API for configuring an ownership.
</summary>
<remarks>
See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information and examples.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public OwnershipBuilder (Microsoft.EntityFrameworkCore.Metadata.IMutableEntityType principalEntityType, Microsoft.EntityFrameworkCore.Metadata.IMutableEntityType dependentEntityType, Microsoft.EntityFrameworkCore.Metadata.IMutableForeignKey foreignKey);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.EntityFrameworkCore.Metadata.IMutableEntityType principalEntityType, class Microsoft.EntityFrameworkCore.Metadata.IMutableEntityType dependentEntityType, class Microsoft.EntityFrameworkCore.Metadata.IMutableForeignKey foreignKey) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder.#ctor(Microsoft.EntityFrameworkCore.Metadata.IMutableEntityType,Microsoft.EntityFrameworkCore.Metadata.IMutableEntityType,Microsoft.EntityFrameworkCore.Metadata.IMutableForeignKey)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (principalEntityType As IMutableEntityType, dependentEntityType As IMutableEntityType, foreignKey As IMutableForeignKey)" />
<MemberSignature Language="F#" Value="new Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder : Microsoft.EntityFrameworkCore.Metadata.IMutableEntityType * Microsoft.EntityFrameworkCore.Metadata.IMutableEntityType * Microsoft.EntityFrameworkCore.Metadata.IMutableForeignKey -> Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder" Usage="new Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder (principalEntityType, dependentEntityType, foreignKey)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</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>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Microsoft.EntityFrameworkCore.Infrastructure.EntityFrameworkInternal]</AttributeName>
<AttributeName Language="F#">[<Microsoft.EntityFrameworkCore.Infrastructure.EntityFrameworkInternal>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="principalEntityType" Type="Microsoft.EntityFrameworkCore.Metadata.IMutableEntityType" />
<Parameter Name="dependentEntityType" Type="Microsoft.EntityFrameworkCore.Metadata.IMutableEntityType" />
<Parameter Name="foreignKey" Type="Microsoft.EntityFrameworkCore.Metadata.IMutableForeignKey" />
</Parameters>
<Docs>
<param name="principalEntityType">To be added.</param>
<param name="dependentEntityType">To be added.</param>
<param name="foreignKey">To be added.</param>
<summary>
This is an internal API that supports the Entity Framework Core infrastructure and not subject to
the same compatibility standards as public APIs. It may be changed or removed without notice in
any release. You should only use it directly in your code with extreme caution and knowing that
doing so can result in application failures when updating to a new Entity Framework Core release.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected OwnershipBuilder (Microsoft.EntityFrameworkCore.Metadata.Internal.InternalForeignKeyBuilder builder, Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder oldBuilder, bool foreignKeySet = false, bool principalKeySet = false, bool requiredSet = false);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class Microsoft.EntityFrameworkCore.Metadata.Internal.InternalForeignKeyBuilder builder, class Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder oldBuilder, bool foreignKeySet, bool principalKeySet, bool requiredSet) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder.#ctor(Microsoft.EntityFrameworkCore.Metadata.Internal.InternalForeignKeyBuilder,Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder,System.Boolean,System.Boolean,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Protected Sub New (builder As InternalForeignKeyBuilder, oldBuilder As OwnershipBuilder, Optional foreignKeySet As Boolean = false, Optional principalKeySet As Boolean = false, Optional requiredSet As Boolean = false)" />
<MemberSignature Language="F#" Value="new Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder : Microsoft.EntityFrameworkCore.Metadata.Internal.InternalForeignKeyBuilder * Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder * bool * bool * bool -> Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder" Usage="new Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder (builder, oldBuilder, foreignKeySet, principalKeySet, requiredSet)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<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="efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0">
<AttributeName Language="C#">[Microsoft.EntityFrameworkCore.Infrastructure.EntityFrameworkInternal]</AttributeName>
<AttributeName Language="F#">[<Microsoft.EntityFrameworkCore.Infrastructure.EntityFrameworkInternal>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="builder" Type="Microsoft.EntityFrameworkCore.Metadata.Internal.InternalForeignKeyBuilder" Index="0" FrameworkAlternate="efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
<Parameter Name="oldBuilder" Type="Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder" Index="1" FrameworkAlternate="efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
<Parameter Name="foreignKeySet" Type="System.Boolean" Index="2" FrameworkAlternate="efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
<Parameter Name="principalKeySet" Type="System.Boolean" Index="3" FrameworkAlternate="efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
<Parameter Name="requiredSet" Type="System.Boolean" Index="4" FrameworkAlternate="efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
</Parameters>
<Docs>
<param name="builder">To be added.</param>
<param name="oldBuilder">To be added.</param>
<param name="foreignKeySet">To be added.</param>
<param name="principalKeySet">To be added.</param>
<param name="requiredSet">To be added.</param>
<summary>
This is an internal API that supports the Entity Framework Core infrastructure and not subject to
the same compatibility standards as public APIs. It may be changed or removed without notice in
any release. You should only use it directly in your code with extreme caution and knowing that
doing so can result in application failures when updating to a new Entity Framework Core release.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected OwnershipBuilder (Microsoft.EntityFrameworkCore.Metadata.Internal.InternalRelationshipBuilder builder, Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder oldBuilder, bool foreignKeySet = false, bool principalKeySet = false, bool requiredSet = false);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class Microsoft.EntityFrameworkCore.Metadata.Internal.InternalRelationshipBuilder builder, class Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder oldBuilder, bool foreignKeySet, bool principalKeySet, bool requiredSet) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder.#ctor(Microsoft.EntityFrameworkCore.Metadata.Internal.InternalRelationshipBuilder,Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder,System.Boolean,System.Boolean,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Protected Sub New (builder As InternalRelationshipBuilder, oldBuilder As OwnershipBuilder, Optional foreignKeySet As Boolean = false, Optional principalKeySet As Boolean = false, Optional requiredSet As Boolean = false)" />
<MemberSignature Language="F#" Value="new Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder : Microsoft.EntityFrameworkCore.Metadata.Internal.InternalRelationshipBuilder * Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder * bool * bool * bool -> Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder" Usage="new Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder (builder, oldBuilder, foreignKeySet, principalKeySet, requiredSet)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="efcore-3.0;efcore-3.1">
<AttributeName Language="C#">[Microsoft.EntityFrameworkCore.Infrastructure.EntityFrameworkInternal]</AttributeName>
<AttributeName Language="F#">[<Microsoft.EntityFrameworkCore.Infrastructure.EntityFrameworkInternal>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="builder" Type="Microsoft.EntityFrameworkCore.Metadata.Internal.InternalRelationshipBuilder" Index="0" FrameworkAlternate="efcore-3.0;efcore-3.1" />
<Parameter Name="oldBuilder" Type="Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder" Index="1" FrameworkAlternate="efcore-3.0;efcore-3.1" />
<Parameter Name="foreignKeySet" Type="System.Boolean" Index="2" FrameworkAlternate="efcore-3.0;efcore-3.1" />
<Parameter Name="principalKeySet" Type="System.Boolean" Index="3" FrameworkAlternate="efcore-3.0;efcore-3.1" />
<Parameter Name="requiredSet" Type="System.Boolean" Index="4" FrameworkAlternate="efcore-3.0;efcore-3.1" />
</Parameters>
<Docs>
<param name="builder">To be added.</param>
<param name="oldBuilder">To be added.</param>
<param name="foreignKeySet">To be added.</param>
<param name="principalKeySet">To be added.</param>
<param name="requiredSet">To be added.</param>
<summary>
This is an internal API that supports the Entity Framework Core infrastructure and not subject to
the same compatibility standards as public APIs. It may be changed or removed without notice in
any release. You should only use it directly in your code with extreme caution and knowing that
doing so can result in application failures when updating to a new Entity Framework Core release.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HasAnnotation">
<MemberSignature Language="C#" Value="public virtual Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder HasAnnotation (string annotation, object value);" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder HasAnnotation(string annotation, object value) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder.HasAnnotation(System.String,System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function HasAnnotation (annotation As String, value As Object) As OwnershipBuilder" />
<MemberSignature Language="F#" Value="abstract member HasAnnotation : string * obj -> Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder
override this.HasAnnotation : string * obj -> Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder" Usage="ownershipBuilder.HasAnnotation (annotation, value)" />
<MemberSignature Language="C#" Value="public virtual Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder HasAnnotation (string annotation, object? value);" FrameworkAlternate="efcore-6.0;efcore-7.0;efcore-8.0" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</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>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="annotation" Type="System.String" />
<Parameter Name="value" Type="System.Object" />
</Parameters>
<Docs>
<param name="annotation">The key of the annotation to be added or updated.</param>
<param name="value">The value to be stored in the annotation.</param>
<summary>
Adds or updates an annotation on the foreign key. If an annotation with the key specified in
<paramref name="annotation" /> already exists its value will be updated.
</summary>
<returns>The same builder instance so that multiple configuration calls can be chained.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HasForeignKey">
<MemberSignature Language="C#" Value="public virtual Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder HasForeignKey (params string[] foreignKeyPropertyNames);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder HasForeignKey(string[] foreignKeyPropertyNames) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder.HasForeignKey(System.String[])" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function HasForeignKey (ParamArray foreignKeyPropertyNames As String()) As OwnershipBuilder" />
<MemberSignature Language="F#" Value="abstract member HasForeignKey : string[] -> Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder
override this.HasForeignKey : string[] -> Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder" Usage="ownershipBuilder.HasForeignKey foreignKeyPropertyNames" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</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>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="foreignKeyPropertyNames" Type="System.String[]">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ParamArray]</AttributeName>
<AttributeName Language="F#">[<System.ParamArray>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="foreignKeyPropertyNames">
The name(s) of the foreign key property(s).
</param>
<summary>
Configures the property(s) to use as the foreign key for this relationship.
</summary>
<returns>The same builder instance so that multiple configuration calls can be chained.</returns>
<remarks>
<para>
If the specified property name(s) do not exist on the entity type then a new shadow state
property(s) will be added to serve as the foreign key. A shadow state property is one
that does not have a corresponding property in the entity class. The current value for the
property is stored in the <see cref="T:Microsoft.EntityFrameworkCore.ChangeTracking.ChangeTracker" /> rather than being stored in instances
of the entity class.
</para>
<para>
If <see cref="M:Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder.HasPrincipalKey(System.String[])" /> is not specified, then an attempt will be made to
match the data type and order of foreign key properties against the primary key of the principal
entity type. If they do not match, new shadow state properties that form a unique index will be
added to the principal entity type to serve as the reference key.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="HasPrincipalKey">
<MemberSignature Language="C#" Value="public virtual Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder HasPrincipalKey (params string[] keyPropertyNames);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder HasPrincipalKey(string[] keyPropertyNames) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder.HasPrincipalKey(System.String[])" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function HasPrincipalKey (ParamArray keyPropertyNames As String()) As OwnershipBuilder" />
<MemberSignature Language="F#" Value="abstract member HasPrincipalKey : string[] -> Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder
override this.HasPrincipalKey : string[] -> Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder" Usage="ownershipBuilder.HasPrincipalKey keyPropertyNames" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</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>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.EntityFrameworkCore.Metadata.Builders.OwnershipBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="keyPropertyNames" Type="System.String[]">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ParamArray]</AttributeName>
<AttributeName Language="F#">[<System.ParamArray>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="keyPropertyNames">The name(s) of the reference key property(s).</param>
<summary>
Configures the unique property(s) that this relationship targets. Typically you would only call this
method if you want to use a property(s) other than the primary key as the principal property(s). If
the specified property(s) is not already a unique constraint (or the primary key) then a new unique
constraint will be introduced.
</summary>
<returns>The same builder instance so that multiple configuration calls can be chained.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>