-
Notifications
You must be signed in to change notification settings - Fork 42
/
NSUbiquitousKeyValueStore+Notifications.xml
144 lines (135 loc) · 7.92 KB
/
NSUbiquitousKeyValueStore+Notifications.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
<Type Name="NSUbiquitousKeyValueStore+Notifications" FullName="Foundation.NSUbiquitousKeyValueStore+Notifications">
<TypeSignature Language="C#" Value="public static class NSUbiquitousKeyValueStore.Notifications" />
<TypeSignature Language="ILAsm" Value=".class nested public auto ansi abstract sealed beforefieldinit NSUbiquitousKeyValueStore/Notifications extends System.Object" />
<TypeSignature Language="DocId" Value="T:Foundation.NSUbiquitousKeyValueStore.Notifications" />
<TypeSignature Language="F#" Value="type NSUbiquitousKeyValueStore.Notifications = class" />
<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 />
<Docs>
<summary>Notification posted by the <see cref="T:Foundation.NSUbiquitousKeyValueStore" /> class.</summary>
<remarks>
<para>This is a static class which contains various helper methods that allow developers to observe events posted in the iOS notification hub (<see cref="T:Foundation.NSNotificationCenter" />).</para>
<para>The methods defined in this class post events invoke the provided method or lambda with a <see cref="T:Foundation.NSNotificationEventArgs" /> parameter which contains strongly typed properties for the notification arguments.</para>
</remarks>
</Docs>
<Members>
<Member MemberName="ObserveDidChangeExternally">
<MemberSignature Language="C#" Value="public static Foundation.NSObject ObserveDidChangeExternally (EventHandler<Foundation.NSUbiquitousKeyValueStoreChangeEventArgs> handler);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Foundation.NSObject ObserveDidChangeExternally(class System.EventHandler`1<class Foundation.NSUbiquitousKeyValueStoreChangeEventArgs> handler) cil managed" />
<MemberSignature Language="DocId" Value="M:Foundation.NSUbiquitousKeyValueStore.Notifications.ObserveDidChangeExternally(System.EventHandler{Foundation.NSUbiquitousKeyValueStoreChangeEventArgs})" />
<MemberSignature Language="F#" Value="static member ObserveDidChangeExternally : EventHandler<Foundation.NSUbiquitousKeyValueStoreChangeEventArgs> -> Foundation.NSObject" Usage="Foundation.NSUbiquitousKeyValueStore.Notifications.ObserveDidChangeExternally handler" />
<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>Foundation.NSObject</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="handler" Type="System.EventHandler<Foundation.NSUbiquitousKeyValueStoreChangeEventArgs>" />
</Parameters>
<Docs>
<param name="handler">Method to invoke when the notification is posted.</param>
<summary>Strongly typed notification for the <see cref="P:Foundation.NSUbiquitousKeyValueStore.DidChangeExternallyNotification" /> constant.</summary>
<returns>Token object that can be used to stop receiving notifications by either disposing it or passing it to <see cref="M:Foundation.NSNotificationCenter.RemoveObservers(System.Collections.Generic.IEnumerable{Foundation.NSObject})" /></returns>
<remarks>
<para>The following example shows how developers can use this method in their code:</para>
<example>
<code lang="csharp lang-csharp"><![CDATA[
//
// Lambda style
//
// listening
notification = NSUbiquitousKeyValueStore.Notifications.ObserveDidChangeExternally ((sender, args) => {
/* Access strongly typed args */
Console.WriteLine ("Notification: {0}", args.Notification);
Console.WriteLine ("ChangedKeys", args.ChangedKeys);
Console.WriteLine ("ChangeReason", args.ChangeReason);
});
// To stop listening:
notification.Dispose ();
//
//Method style
//
NSObject notification;
void Callback (object sender, Foundation.NSUbiquitousKeyValueStoreChangeEventArgs args)
{
// Access strongly typed args
Console.WriteLine ("Notification: {0}", args.Notification);
Console.WriteLine ("ChangedKeys", args.ChangedKeys);
Console.WriteLine ("ChangeReason", args.ChangeReason);
}
void Setup ()
{
notification = NSUbiquitousKeyValueStore.Notifications.ObserveDidChangeExternally (Callback);
}
void Teardown ()
{
notification.Dispose ();
}]]></code>
</example>
</remarks>
</Docs>
</Member>
<Member MemberName="ObserveDidChangeExternally">
<MemberSignature Language="C#" Value="public static Foundation.NSObject ObserveDidChangeExternally (Foundation.NSObject objectToObserve, EventHandler<Foundation.NSUbiquitousKeyValueStoreChangeEventArgs> handler);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Foundation.NSObject ObserveDidChangeExternally(class Foundation.NSObject objectToObserve, class System.EventHandler`1<class Foundation.NSUbiquitousKeyValueStoreChangeEventArgs> handler) cil managed" />
<MemberSignature Language="DocId" Value="M:Foundation.NSUbiquitousKeyValueStore.Notifications.ObserveDidChangeExternally(Foundation.NSObject,System.EventHandler{Foundation.NSUbiquitousKeyValueStoreChangeEventArgs})" />
<MemberSignature Language="F#" Value="static member ObserveDidChangeExternally : Foundation.NSObject * EventHandler<Foundation.NSUbiquitousKeyValueStoreChangeEventArgs> -> Foundation.NSObject" Usage="Foundation.NSUbiquitousKeyValueStore.Notifications.ObserveDidChangeExternally (objectToObserve, handler)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Xamarin.iOS</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Foundation.NSObject</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="objectToObserve" Type="Foundation.NSObject" />
<Parameter Name="handler" Type="System.EventHandler<Foundation.NSUbiquitousKeyValueStoreChangeEventArgs>" />
</Parameters>
<Docs>
<param name="objectToObserve">The object to observe.</param>
<param name="handler">Method to invoke when the notification is posted.</param>
<summary>Strongly typed notification for the <see cref="P:Foundation.NSUbiquitousKeyValueStore.DidChangeExternallyNotification" /> constant.</summary>
<returns>Token object that can be used to stop receiving notifications by either disposing it or passing it to <see cref="M:Foundation.NSNotificationCenter.RemoveObservers(System.Collections.Generic.IEnumerable{Foundation.NSObject})" /></returns>
<remarks>
<para id="tool-remark">This method can be used to subscribe for <see cref="P:Foundation.NSUbiquitousKeyValueStore.DidChangeExternallyNotification" /> notifications.</para>
<example>
<code lang="csharp lang-csharp"><![CDATA[
// Listen to all notifications posted for any object
var token = NSUbiquitousKeyValueStore.Notifications.ObserveDidChangeExternally ((notification) => {
Console.WriteLine ("Observed DidChangeExternallyNotification!");
};
// Listen to all notifications posted for a single object
var token = NSUbiquitousKeyValueStore.Notifications.ObserveDidChangeExternally (objectToObserve, (notification) => {
Console.WriteLine ($"Observed DidChangeExternallyNotification for {nameof (objectToObserve)}!");
};
// Stop listening for notifications
token.Dispose ();
]]></code>
</example>
</remarks>
</Docs>
</Member>
</Members>
</Type>