/
PollingWildCardChangeToken.xml
217 lines (217 loc) · 13.9 KB
/
PollingWildCardChangeToken.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
<Type Name="PollingWildCardChangeToken" FullName="Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken">
<TypeSignature Language="C#" Value="public class PollingWildCardChangeToken : Microsoft.Extensions.Primitives.IChangeToken" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PollingWildCardChangeToken extends System.Object implements class Microsoft.Extensions.Primitives.IChangeToken" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken" />
<TypeSignature Language="VB.NET" Value="Public Class PollingWildCardChangeToken
Implements IChangeToken" />
<TypeSignature Language="F#" Value="type PollingWildCardChangeToken = class
 interface IChangeToken" />
<TypeSignature Language="C++ CLI" Value="public ref class PollingWildCardChangeToken : Microsoft::Extensions::Primitives::IChangeToken" />
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.FileProviders.Physical</AssemblyName>
<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>
<Interface>
<InterfaceName>Microsoft.Extensions.Primitives.IChangeToken</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>A polling based <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> for wildcard patterns.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PollingWildCardChangeToken (string root, string pattern);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string root, string pattern) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken.#ctor(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (root As String, pattern As String)" />
<MemberSignature Language="F#" Value="new Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken : string * string -> Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken" Usage="new Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken (root, pattern)" />
<MemberSignature Language="C++ CLI" Value="public:
 PollingWildCardChangeToken(System::String ^ root, System::String ^ pattern);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.FileProviders.Physical</AssemblyName>
<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>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="root" Type="System.String" />
<Parameter Name="pattern" Type="System.String" />
</Parameters>
<Docs>
<param name="root">The root of the file system.</param>
<param name="pattern">The pattern to watch.</param>
<summary>Initializes a new instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ActiveChangeCallbacks">
<MemberSignature Language="C#" Value="public bool ActiveChangeCallbacks { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool ActiveChangeCallbacks" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken.ActiveChangeCallbacks" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ActiveChangeCallbacks As Boolean" />
<MemberSignature Language="F#" Value="member this.ActiveChangeCallbacks : bool" Usage="Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken.ActiveChangeCallbacks" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool ActiveChangeCallbacks { bool get(); };" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember FrameworkAlternate="dotnet-plat-ext-1.1;dotnet-plat-ext-2.0;dotnet-plat-ext-2.1;dotnet-plat-ext-3.1">P:Microsoft.Extensions.Primitives.IChangeToken.ActiveChangeCallbacks</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.FileProviders.Physical</AssemblyName>
<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>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Indicates if this token will pro-actively raise callbacks. If <see langword="false" />, the token consumer must poll <see cref="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged" /> to detect changes.</summary>
<value>
<see langword="true" /> if the token will proactively raise callbacks; <see langword="false" /> otherwise.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="GetLastWriteUtc">
<MemberSignature Language="C#" Value="protected virtual DateTime GetLastWriteUtc (string path);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance valuetype System.DateTime GetLastWriteUtc(string path) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken.GetLastWriteUtc(System.String)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Function GetLastWriteUtc (path As String) As DateTime" />
<MemberSignature Language="F#" Value="abstract member GetLastWriteUtc : string -> DateTime
override this.GetLastWriteUtc : string -> DateTime" Usage="pollingWildCardChangeToken.GetLastWriteUtc path" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual DateTime GetLastWriteUtc(System::String ^ path);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.FileProviders.Physical</AssemblyName>
<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>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="path" Type="System.String" />
</Parameters>
<Docs>
<param name="path">The root relative path.</param>
<summary>Gets the last write time of the file at the specified <paramref name="path" />.</summary>
<returns>The <see cref="T:System.DateTime" /> that the file was last modified.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HasChanged">
<MemberSignature Language="C#" Value="public bool HasChanged { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool HasChanged" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken.HasChanged" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property HasChanged As Boolean" />
<MemberSignature Language="F#" Value="member this.HasChanged : bool" Usage="Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken.HasChanged" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool HasChanged { bool get(); };" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.FileProviders.Physical</AssemblyName>
<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>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that indicates if a change has occurred.</summary>
<value>
<see langword="true" /> if a change has occurred; <see langword="false" /> otherwise.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="Microsoft.Extensions.Primitives.IChangeToken.RegisterChangeCallback">
<MemberSignature Language="C#" Value="IDisposable IChangeToken.RegisterChangeCallback (Action<object> callback, object state);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.IDisposable Microsoft.Extensions.Primitives.IChangeToken.RegisterChangeCallback(class System.Action`1<object> callback, object state) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken.Microsoft#Extensions#Primitives#IChangeToken#RegisterChangeCallback(System.Action{System.Object},System.Object)" />
<MemberSignature Language="VB.NET" Value="Function RegisterChangeCallback (callback As Action(Of Object), state As Object) As IDisposable Implements IChangeToken.RegisterChangeCallback" />
<MemberSignature Language="F#" Value="abstract member Microsoft.Extensions.Primitives.IChangeToken.RegisterChangeCallback : Action<obj> * obj -> IDisposable
override this.Microsoft.Extensions.Primitives.IChangeToken.RegisterChangeCallback : Action<obj> * obj -> IDisposable" Usage="pollingWildCardChangeToken.Microsoft.Extensions.Primitives.IChangeToken.RegisterChangeCallback (callback, state)" />
<MemberSignature Language="C++ CLI" Value=" virtual IDisposable ^ Microsoft.Extensions.Primitives.IChangeToken.RegisterChangeCallback(Action<System::Object ^> ^ callback, System::Object ^ state) = Microsoft::Extensions::Primitives::IChangeToken::RegisterChangeCallback;" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Extensions.Primitives.IChangeToken.RegisterChangeCallback(System.Action{System.Object},System.Object)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.FileProviders.Physical</AssemblyName>
<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>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IDisposable</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="callback" Type="System.Action<System.Object>" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<param name="callback">The <see cref="T:System.Action`1" /> to invoke.</param>
<param name="state">State to be passed into the callback.</param>
<summary>Registers for a callback that will be invoked when the entry has changed.
<see cref="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged" /> MUST be set before the callback is invoked.</summary>
<returns>An <see cref="T:System.IDisposable" /> that is used to unregister the callback.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>