-
Notifications
You must be signed in to change notification settings - Fork 42
/
CFNotificationCenter.xml
376 lines (374 loc) · 20.9 KB
/
CFNotificationCenter.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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
<Type Name="CFNotificationCenter" FullName="CoreFoundation.CFNotificationCenter">
<TypeSignature Language="C#" Value="public class CFNotificationCenter : IDisposable, ObjCRuntime.INativeObject" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CFNotificationCenter extends System.Object implements class ObjCRuntime.INativeObject, class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:CoreFoundation.CFNotificationCenter" />
<TypeSignature Language="F#" Value="type CFNotificationCenter = class
 interface INativeObject
 interface IDisposable" />
<AssemblyInfo>
<AssemblyName>Xamarin.iOS</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>ObjCRuntime.INativeObject</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>Notification hub for the application.</summary>
<remarks>
<para>
The CFNotificationCenter is a hub that is used to listen to
broadcast messages and post broadcast messages in an
application. The messages that are posted are synchronous.
</para>
<para>
Posting a notification is a synchronous process, which means
that invoking one of the Post messages on the notification
center will block execution until all of the notification
handlers have completed running.
</para>
<para>
While the <see cref="T:Foundation.NSNotificationCenter" /> also
provides a notification hub, they are separate from each
other. The CFNotificationCenter provides three hubs: an
application local hub, the Darwin hub (for OS-global
notifications) and a distributed hub (only available on Mac).
</para>
</remarks>
</Docs>
<Members>
<Member MemberName="AddObserver">
<MemberSignature Language="C#" Value="public CoreFoundation.CFNotificationObserverToken AddObserver (string name, ObjCRuntime.INativeObject objectToObserve, Action<string,Foundation.NSDictionary> notificationHandler, CoreFoundation.CFNotificationSuspensionBehavior suspensionBehavior = CoreFoundation.CFNotificationSuspensionBehavior.DeliverImmediately);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class CoreFoundation.CFNotificationObserverToken AddObserver(string name, class ObjCRuntime.INativeObject objectToObserve, class System.Action`2<string, class Foundation.NSDictionary> notificationHandler, valuetype CoreFoundation.CFNotificationSuspensionBehavior suspensionBehavior) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreFoundation.CFNotificationCenter.AddObserver(System.String,ObjCRuntime.INativeObject,System.Action{System.String,Foundation.NSDictionary},CoreFoundation.CFNotificationSuspensionBehavior)" />
<MemberSignature Language="F#" Value="member this.AddObserver : string * ObjCRuntime.INativeObject * Action<string, Foundation.NSDictionary> * CoreFoundation.CFNotificationSuspensionBehavior -> CoreFoundation.CFNotificationObserverToken" Usage="cFNotificationCenter.AddObserver (name, objectToObserve, notificationHandler, suspensionBehavior)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>CoreFoundation.CFNotificationObserverToken</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="objectToObserve" Type="ObjCRuntime.INativeObject" />
<Parameter Name="notificationHandler" Type="System.Action<System.String,Foundation.NSDictionary>" />
<Parameter Name="suspensionBehavior" Type="CoreFoundation.CFNotificationSuspensionBehavior" />
</Parameters>
<Docs>
<param name="name">Name of the notification to observer, or <see langword="null" /> if you want the notificationHandler to be invoked for all notifications posted. <see langword="null" /> is not allowed for the Darwin notification center.</param>
<param name="objectToObserve">For non-Darwin notification centers, the object to observe. If <see langword="null" /> is passed, then the notificationHandler is invoked for all objects that have a notification named name posted.</param>
<param name="notificationHandler">Handler to invoke when a notification is posted.</param>
<param name="suspensionBehavior">Determines how a notification is processed when the application is in the background.</param>
<summary>Adds an observer to the notification center.</summary>
<returns>Token representing the notification, use this token if you want to later remove this observer.</returns>
<remarks>
<para>
Registers a method to be invoked when a notification is posted to a specific object.
</para>
<para>
The handler is invoked on the same thread that posted the
message, or from the loop that pumped the notification.
If your code needs to run in a specific thread, you should
take care of that in your handler.
</para>
<para>
Use the returned value as a token to <see cref="M:CoreFoundation.CFNotificationCenter.RemoveObserver(CoreFoundation.CFNotificationObserverToken)" /> if you want to stop getting notifications.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Darwin">
<MemberSignature Language="C#" Value="public static CoreFoundation.CFNotificationCenter Darwin { get; }" />
<MemberSignature Language="ILAsm" Value=".property class CoreFoundation.CFNotificationCenter Darwin" />
<MemberSignature Language="DocId" Value="P:CoreFoundation.CFNotificationCenter.Darwin" />
<MemberSignature Language="F#" Value="member this.Darwin : CoreFoundation.CFNotificationCenter" Usage="CoreFoundation.CFNotificationCenter.Darwin" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>CoreFoundation.CFNotificationCenter</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns the operating system global notification center.</summary>
<value>
</value>
<remarks>
<para>
This is an operating system global notification center,
and can be used to send messages between applications
running on the same machine. There is no notion of user
session in the Darwin notification center, so all the
notifications are global.
</para>
<para>
The main thread loop must be running in one of the common
modes (RunLoopDefault for example) for these notifications
to be delivered.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
<MemberSignature Language="DocId" Value="M:CoreFoundation.CFNotificationCenter.Dispose" />
<MemberSignature Language="F#" Value="abstract member Dispose : unit -> unit
override this.Dispose : unit -> unit" Usage="cFNotificationCenter.Dispose " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Releases the resources used by the CFNotificationCenter object.</summary>
<remarks>
<para>The Dispose method releases the resources used by the CFNotificationCenter class.</para>
<para>Calling the Dispose method when the application is finished using the CFNotificationCenter ensures that all external resources used by this managed object are released as soon as possible. Once developers have invoked the Dispose method, the object is no longer useful and developers should no longer make any calls to it. For more information on releasing resources see ``Cleaning up Unmananaged Resources'' at https://msdn.microsoft.com/en-us/library/498928w2.aspx</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="protected virtual void Dispose (bool disposing);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void Dispose(bool disposing) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreFoundation.CFNotificationCenter.Dispose(System.Boolean)" />
<MemberSignature Language="F#" Value="abstract member Dispose : bool -> unit
override this.Dispose : bool -> unit" Usage="cFNotificationCenter.Dispose disposing" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="disposing" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="disposing">
<para>If set to <see langword="true" />, the method is invoked directly and will dispose manage and unmanaged resources; If set to <see langword="false" /> the method is being called by the garbage collector finalizer and should only release unmanaged resources.</para>
</param>
<summary>Releases the resources used by the CFNotificationCenter object.</summary>
<remarks>
<para>This Dispose method releases the resources used by the CFNotificationCenter class.</para>
<para>This method is called by both the Dispose() method and the object finalizer (Finalize). When invoked by the Dispose method, the parameter disposing <paramref name="disposing" /> is set to <see langword="true" /> and any managed object references that this object holds are also disposed or released; when invoked by the object finalizer, on the finalizer thread the value is set to <see langword="false" />. </para>
<para>Calling the Dispose method when the application is finished using the CFNotificationCenter ensures that all external resources used by this managed object are released as soon as possible. Once developers have invoked the Dispose method, the object is no longer useful and developers should no longer make any calls to it.</para>
<para> For more information on how to override this method and on the Dispose/IDisposable pattern, read the ``Implementing a Dispose Method'' document at https://msdn.microsoft.com/en-us/library/fs2xkftw.aspx</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Distributed">
<MemberSignature Language="C#" Value="public static CoreFoundation.CFNotificationCenter Distributed { get; }" />
<MemberSignature Language="ILAsm" Value=".property class CoreFoundation.CFNotificationCenter Distributed" />
<MemberSignature Language="DocId" Value="P:CoreFoundation.CFNotificationCenter.Distributed" />
<MemberSignature Language="F#" Value="member this.Distributed : CoreFoundation.CFNotificationCenter" Usage="CoreFoundation.CFNotificationCenter.Distributed" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>CoreFoundation.CFNotificationCenter</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="~CFNotificationCenter ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Finalize() cil managed" />
<MemberSignature Language="DocId" Value="M:CoreFoundation.CFNotificationCenter.Finalize" />
<MemberSignature Language="F#" Value="override this.Finalize : unit -> unit" Usage="cFNotificationCenter.Finalize " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Finalizer for the CFNotificationCenter object</summary>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="Handle">
<MemberSignature Language="C#" Value="public IntPtr Handle { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance native int Handle" />
<MemberSignature Language="DocId" Value="P:CoreFoundation.CFNotificationCenter.Handle" />
<MemberSignature Language="F#" Value="member this.Handle : nativeint" Usage="CoreFoundation.CFNotificationCenter.Handle" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:ObjCRuntime.INativeObject.Handle</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>Handle (pointer) to the unmanaged object representation.</summary>
<value>A pointer</value>
<remarks>This IntPtr is a handle to the underlying unmanaged representation for this object.</remarks>
</Docs>
</Member>
<Member MemberName="Local">
<MemberSignature Language="C#" Value="public static CoreFoundation.CFNotificationCenter Local { get; }" />
<MemberSignature Language="ILAsm" Value=".property class CoreFoundation.CFNotificationCenter Local" />
<MemberSignature Language="DocId" Value="P:CoreFoundation.CFNotificationCenter.Local" />
<MemberSignature Language="F#" Value="member this.Local : CoreFoundation.CFNotificationCenter" Usage="CoreFoundation.CFNotificationCenter.Local" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>CoreFoundation.CFNotificationCenter</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns the application local notification center.</summary>
<value>
</value>
<remarks>
This is an application local notification center. Can be used to post notifications inside an application.
</remarks>
</Docs>
</Member>
<Member MemberName="PostNotification">
<MemberSignature Language="C#" Value="public void PostNotification (string notification, ObjCRuntime.INativeObject objectToObserve, Foundation.NSDictionary userInfo = null, bool deliverImmediately = false, bool postOnAllSessions = false);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void PostNotification(string notification, class ObjCRuntime.INativeObject objectToObserve, class Foundation.NSDictionary userInfo, bool deliverImmediately, bool postOnAllSessions) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreFoundation.CFNotificationCenter.PostNotification(System.String,ObjCRuntime.INativeObject,Foundation.NSDictionary,System.Boolean,System.Boolean)" />
<MemberSignature Language="F#" Value="member this.PostNotification : string * ObjCRuntime.INativeObject * Foundation.NSDictionary * bool * bool -> unit" Usage="cFNotificationCenter.PostNotification (notification, objectToObserve, userInfo, deliverImmediately, postOnAllSessions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="notification" Type="System.String" />
<Parameter Name="objectToObserve" Type="ObjCRuntime.INativeObject" />
<Parameter Name="userInfo" Type="Foundation.NSDictionary" />
<Parameter Name="deliverImmediately" Type="System.Boolean" />
<Parameter Name="postOnAllSessions" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="notification">To be added.</param>
<param name="objectToObserve">To be added.</param>
<param name="userInfo">To be added.</param>
<param name="deliverImmediately">To be added.</param>
<param name="postOnAllSessions">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RemoveEveryObserver">
<MemberSignature Language="C#" Value="public void RemoveEveryObserver ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemoveEveryObserver() cil managed" />
<MemberSignature Language="DocId" Value="M:CoreFoundation.CFNotificationCenter.RemoveEveryObserver" />
<MemberSignature Language="F#" Value="member this.RemoveEveryObserver : unit -> unit" Usage="cFNotificationCenter.RemoveEveryObserver " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RemoveObserver">
<MemberSignature Language="C#" Value="public void RemoveObserver (CoreFoundation.CFNotificationObserverToken token);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemoveObserver(class CoreFoundation.CFNotificationObserverToken token) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreFoundation.CFNotificationCenter.RemoveObserver(CoreFoundation.CFNotificationObserverToken)" />
<MemberSignature Language="F#" Value="member this.RemoveObserver : CoreFoundation.CFNotificationObserverToken -> unit" Usage="cFNotificationCenter.RemoveObserver token" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="token" Type="CoreFoundation.CFNotificationObserverToken" />
</Parameters>
<Docs>
<param name="token">Token returned by <see cref="M:CoreFoundation.CFNotificationCenter.AddObserver(System.String,ObjCRuntime.INativeObject,System.Action{System.String,Foundation.NSDictionary},CoreFoundation.CFNotificationSuspensionBehavior)" />.</param>
<summary>Removes the specified observer.</summary>
<remarks>
</remarks>
</Docs>
</Member>
</Members>
</Type>