-
Notifications
You must be signed in to change notification settings - Fork 40
/
IConventionKeyBuilder.xml
163 lines (163 loc) · 11.6 KB
/
IConventionKeyBuilder.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
<Type Name="IConventionKeyBuilder" FullName="Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder">
<TypeSignature Language="C#" Value="public interface IConventionKeyBuilder : Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionAnnotatableBuilder" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IConventionKeyBuilder implements class Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionAnnotatableBuilder" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0;efcore-6.0;efcore-7.0" />
<TypeSignature Language="DocId" Value="T:Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder" />
<TypeSignature Language="VB.NET" Value="Public Interface IConventionKeyBuilder
Implements IConventionAnnotatableBuilder" />
<TypeSignature Language="F#" Value="type IConventionKeyBuilder = interface
 interface IConventionAnnotatableBuilder" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IConventionKeyBuilder implements class Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionAnnotatableBuilder" FrameworkAlternate="efcore-8.0" />
<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>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionAnnotatableBuilder</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
<para>
Provides a simple API surface for configuring an <see cref="T:Microsoft.EntityFrameworkCore.Metadata.IConventionKey" /> from conventions.
</para>
<para>
This interface is typically used by database providers (and other extensions). It is generally
not used in application code.
</para>
</summary>
<remarks>
See <see href="https://aka.ms/efcore-docs-conventions">Model building conventions</see> for more information and examples.
</remarks>
</Docs>
<Members>
<Member MemberName="HasAnnotation">
<MemberSignature Language="C#" Value="public Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder? HasAnnotation (string name, object? value, bool fromDataAnnotation = false);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder HasAnnotation(string name, object value, bool fromDataAnnotation) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder.HasAnnotation(System.String,System.Object,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Function HasAnnotation (name As String, value As Object, Optional fromDataAnnotation As Boolean = false) As IConventionKeyBuilder" />
<MemberSignature Language="F#" Value="abstract member HasAnnotation : string * obj * bool -> Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder" Usage="iConventionKeyBuilder.HasAnnotation (name, value, fromDataAnnotation)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" Index="0" FrameworkAlternate="efcore-8.0" />
<Parameter Name="value" Type="System.Object" Index="1" FrameworkAlternate="efcore-8.0" />
<Parameter Name="fromDataAnnotation" Type="System.Boolean" Index="2" FrameworkAlternate="efcore-8.0" />
</Parameters>
<Docs>
<param name="name">The name of the annotation to be set.</param>
<param name="value">The value to be stored in the annotation.</param>
<param name="fromDataAnnotation">Indicates whether the configuration was specified using a data annotation.</param>
<summary>
Sets the annotation stored under the given name. Overwrites the existing annotation if an
annotation with the specified name already exists with same or lower <see cref="T:Microsoft.EntityFrameworkCore.Metadata.ConfigurationSource" />.
</summary>
<returns>
An <see cref="T:Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder" /> to continue configuration if the annotation was set, <see langword="null" /> otherwise.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HasNoAnnotation">
<MemberSignature Language="C#" Value="public Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder? HasNoAnnotation (string name, bool fromDataAnnotation = false);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder HasNoAnnotation(string name, bool fromDataAnnotation) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder.HasNoAnnotation(System.String,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Function HasNoAnnotation (name As String, Optional fromDataAnnotation As Boolean = false) As IConventionKeyBuilder" />
<MemberSignature Language="F#" Value="abstract member HasNoAnnotation : string * bool -> Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder" Usage="iConventionKeyBuilder.HasNoAnnotation (name, fromDataAnnotation)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" Index="0" FrameworkAlternate="efcore-8.0" />
<Parameter Name="fromDataAnnotation" Type="System.Boolean" Index="1" FrameworkAlternate="efcore-8.0" />
</Parameters>
<Docs>
<param name="name">The name of the annotation to remove.</param>
<param name="fromDataAnnotation">Indicates whether the configuration was specified using a data annotation.</param>
<summary>
Removes the annotation with the given name from this object.
</summary>
<returns>
An <see cref="T:Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder" /> to continue configuration if the annotation was set, <see langword="null" /> otherwise.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HasNonNullAnnotation">
<MemberSignature Language="C#" Value="public Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder? HasNonNullAnnotation (string name, object? value, bool fromDataAnnotation = false);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder HasNonNullAnnotation(string name, object value, bool fromDataAnnotation) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder.HasNonNullAnnotation(System.String,System.Object,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Function HasNonNullAnnotation (name As String, value As Object, Optional fromDataAnnotation As Boolean = false) As IConventionKeyBuilder" />
<MemberSignature Language="F#" Value="abstract member HasNonNullAnnotation : string * obj * bool -> Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder" Usage="iConventionKeyBuilder.HasNonNullAnnotation (name, value, fromDataAnnotation)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" Index="0" FrameworkAlternate="efcore-8.0" />
<Parameter Name="value" Type="System.Object" Index="1" FrameworkAlternate="efcore-8.0" />
<Parameter Name="fromDataAnnotation" Type="System.Boolean" Index="2" FrameworkAlternate="efcore-8.0" />
</Parameters>
<Docs>
<param name="name">The name of the annotation to be set.</param>
<param name="value">The value to be stored in the annotation. <see langword="null" /> to remove the annotations.</param>
<param name="fromDataAnnotation">Indicates whether the configuration was specified using a data annotation.</param>
<summary>
Sets the annotation stored under the given name. Overwrites the existing annotation if an
annotation with the specified name already exists with same or lower <see cref="T:Microsoft.EntityFrameworkCore.Metadata.ConfigurationSource" />.
Removes the annotation if <see langword="null" /> value is specified.
</summary>
<returns>
An <see cref="T:Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder" /> to continue configuration if the annotation was set or removed,
<see langword="null" /> otherwise.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Metadata">
<MemberSignature Language="C#" Value="public Microsoft.EntityFrameworkCore.Metadata.IConventionKey Metadata { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.EntityFrameworkCore.Metadata.IConventionKey Metadata" />
<MemberSignature Language="DocId" Value="P:Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder.Metadata" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Metadata As IConventionKey" />
<MemberSignature Language="F#" Value="member this.Metadata : Microsoft.EntityFrameworkCore.Metadata.IConventionKey" Usage="Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder.Metadata" />
<MemberType>Property</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.IConventionKey</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the key being configured.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>