-
Notifications
You must be signed in to change notification settings - Fork 40
/
IReadOnlyAnnotatable.xml
173 lines (173 loc) · 10.2 KB
/
IReadOnlyAnnotatable.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
<Type Name="IReadOnlyAnnotatable" FullName="Microsoft.EntityFrameworkCore.Infrastructure.IReadOnlyAnnotatable">
<TypeSignature Language="C#" Value="public interface IReadOnlyAnnotatable" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IReadOnlyAnnotatable" FrameworkAlternate="efcore-6.0;efcore-7.0" />
<TypeSignature Language="DocId" Value="T:Microsoft.EntityFrameworkCore.Infrastructure.IReadOnlyAnnotatable" />
<TypeSignature Language="VB.NET" Value="Public Interface IReadOnlyAnnotatable" />
<TypeSignature Language="F#" Value="type IReadOnlyAnnotatable = interface" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IReadOnlyAnnotatable" FrameworkAlternate="efcore-8.0" />
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>
<para>
A class that supports annotations. Annotations allow for arbitrary metadata to be stored on an object.
</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-providers">Implementation of database providers and extensions</see>
for more information and examples.
</remarks>
</Docs>
<Members>
<Member MemberName="AnnotationsToDebugString">
<MemberSignature Language="C#" Value="public virtual string AnnotationsToDebugString (int indent = 0);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string AnnotationsToDebugString(int32 indent) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Infrastructure.IReadOnlyAnnotatable.AnnotationsToDebugString(System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AnnotationsToDebugString (Optional indent As Integer = 0) As String" />
<MemberSignature Language="F#" Value="abstract member AnnotationsToDebugString : int -> string
override this.AnnotationsToDebugString : int -> string" Usage="iReadOnlyAnnotatable.AnnotationsToDebugString indent" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="indent" Type="System.Int32" />
</Parameters>
<Docs>
<param name="indent">The number of indent spaces to use before each new line.</param>
<summary>
Gets the debug string for all annotations declared on the object.
</summary>
<returns>Debug string representation of all annotations.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FindAnnotation">
<MemberSignature Language="C#" Value="public Microsoft.EntityFrameworkCore.Infrastructure.IAnnotation? FindAnnotation (string name);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.EntityFrameworkCore.Infrastructure.IAnnotation FindAnnotation(string name) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Infrastructure.IReadOnlyAnnotatable.FindAnnotation(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function FindAnnotation (name As String) As IAnnotation" />
<MemberSignature Language="F#" Value="abstract member FindAnnotation : string -> Microsoft.EntityFrameworkCore.Infrastructure.IAnnotation" Usage="iReadOnlyAnnotatable.FindAnnotation name" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.EntityFrameworkCore.Infrastructure.IAnnotation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<param name="name">The name of the annotation to find.</param>
<summary>
Gets the annotation with the given name, returning <see langword="null" /> if it does not exist.
</summary>
<returns>
The existing annotation if an annotation with the specified name already exists. Otherwise, <see langword="null" />.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetAnnotation">
<MemberSignature Language="C#" Value="public virtual Microsoft.EntityFrameworkCore.Infrastructure.IAnnotation GetAnnotation (string annotationName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.EntityFrameworkCore.Infrastructure.IAnnotation GetAnnotation(string annotationName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Infrastructure.IReadOnlyAnnotatable.GetAnnotation(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAnnotation (annotationName As String) As IAnnotation" />
<MemberSignature Language="F#" Value="abstract member GetAnnotation : string -> Microsoft.EntityFrameworkCore.Infrastructure.IAnnotation
override this.GetAnnotation : string -> Microsoft.EntityFrameworkCore.Infrastructure.IAnnotation" Usage="iReadOnlyAnnotatable.GetAnnotation annotationName" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.EntityFrameworkCore.Infrastructure.IAnnotation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="annotationName" Type="System.String" />
</Parameters>
<Docs>
<param name="annotationName">The key of the annotation to find.</param>
<summary>
Gets the annotation with the given name, throwing if it does not exist.
</summary>
<returns>The annotation with the specified name.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetAnnotations">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<Microsoft.EntityFrameworkCore.Infrastructure.IAnnotation> GetAnnotations ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Collections.Generic.IEnumerable`1<class Microsoft.EntityFrameworkCore.Infrastructure.IAnnotation> GetAnnotations() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Infrastructure.IReadOnlyAnnotatable.GetAnnotations" />
<MemberSignature Language="VB.NET" Value="Public Function GetAnnotations () As IEnumerable(Of IAnnotation)" />
<MemberSignature Language="F#" Value="abstract member GetAnnotations : unit -> seq<Microsoft.EntityFrameworkCore.Infrastructure.IAnnotation>" Usage="iReadOnlyAnnotatable.GetAnnotations " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable<Microsoft.EntityFrameworkCore.Infrastructure.IAnnotation></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Gets all annotations on the current object.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Item">
<MemberSignature Language="C#" Value="public object? this[string name] { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance object Item(string)" />
<MemberSignature Language="DocId" Value="P:Microsoft.EntityFrameworkCore.Infrastructure.IReadOnlyAnnotatable.Item(System.String)" />
<MemberSignature Language="VB.NET" Value="Default Public ReadOnly Property Item(name As String) As Object" />
<MemberSignature Language="F#" Value="member this.Item(string) : obj" Usage="Microsoft.EntityFrameworkCore.Infrastructure.IReadOnlyAnnotatable.Item" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<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>
<Parameters>
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<param name="name">The name of the annotation to find.</param>
<summary>
Gets the value of the annotation with the given name, returning <see langword="null" /> if it does not exist.
</summary>
<value>
The value of the existing annotation if an annotation with the specified name already exists. Otherwise, <see langword="null" />.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>