-
Notifications
You must be signed in to change notification settings - Fork 42
/
NKIssue+Notifications.xml
126 lines (119 loc) · 6.75 KB
/
NKIssue+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
<Type Name="NKIssue+Notifications" FullName="NewsstandKit.NKIssue+Notifications">
<TypeSignature Language="C#" Value="public static class NKIssue.Notifications" />
<TypeSignature Language="ILAsm" Value=".class nested public auto ansi abstract sealed beforefieldinit NKIssue/Notifications extends System.Object" />
<TypeSignature Language="DocId" Value="T:NewsstandKit.NKIssue.Notifications" />
<TypeSignature Language="F#" Value="type NKIssue.Notifications = class" />
<AssemblyInfo>
<AssemblyName>Xamarin.iOS</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Notification posted by the <see cref="T:NewsstandKit.NKIssue" /> 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="ObserveDownloadCompleted">
<MemberSignature Language="C#" Value="public static Foundation.NSObject ObserveDownloadCompleted (EventHandler<Foundation.NSNotificationEventArgs> handler);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Foundation.NSObject ObserveDownloadCompleted(class System.EventHandler`1<class Foundation.NSNotificationEventArgs> handler) cil managed" />
<MemberSignature Language="DocId" Value="M:NewsstandKit.NKIssue.Notifications.ObserveDownloadCompleted(System.EventHandler{Foundation.NSNotificationEventArgs})" />
<MemberSignature Language="F#" Value="static member ObserveDownloadCompleted : EventHandler<Foundation.NSNotificationEventArgs> -> Foundation.NSObject" Usage="NewsstandKit.NKIssue.Notifications.ObserveDownloadCompleted handler" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Foundation.NSObject</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="handler" Type="System.EventHandler<Foundation.NSNotificationEventArgs>" />
</Parameters>
<Docs>
<param name="handler">Method to invoke when the notification is posted.</param>
<summary>Strongly typed notification for the <see cref="P:NewsstandKit.NKIssue.DownloadCompletedNotification" /> 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 you can use this method in your code</para>
<example>
<code lang="csharp lang-csharp"><![CDATA[
//
// Lambda style
//
// listening
notification = NKIssue.Notifications.ObserveDownloadCompleted ((sender, args) => {
/* Access strongly typed args */
Console.WriteLine ("Notification: {0}", args.Notification);
});
// To stop listening:
notification.Dispose ();
//
//Method style
//
NSObject notification;
void Callback (object sender, Foundation.NSNotificationEventArgs args)
{
// Access strongly typed args
Console.WriteLine ("Notification: {0}", args.Notification);
}
void Setup ()
{
notification = NKIssue.Notifications.ObserveDownloadCompleted (Callback);
}
void Teardown ()
{
notification.Dispose ();
}]]></code>
</example>
</remarks>
</Docs>
</Member>
<Member MemberName="ObserveDownloadCompleted">
<MemberSignature Language="C#" Value="public static Foundation.NSObject ObserveDownloadCompleted (Foundation.NSObject objectToObserve, EventHandler<Foundation.NSNotificationEventArgs> handler);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Foundation.NSObject ObserveDownloadCompleted(class Foundation.NSObject objectToObserve, class System.EventHandler`1<class Foundation.NSNotificationEventArgs> handler) cil managed" />
<MemberSignature Language="DocId" Value="M:NewsstandKit.NKIssue.Notifications.ObserveDownloadCompleted(Foundation.NSObject,System.EventHandler{Foundation.NSNotificationEventArgs})" />
<MemberSignature Language="F#" Value="static member ObserveDownloadCompleted : Foundation.NSObject * EventHandler<Foundation.NSNotificationEventArgs> -> Foundation.NSObject" Usage="NewsstandKit.NKIssue.Notifications.ObserveDownloadCompleted (objectToObserve, handler)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Xamarin.iOS</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.NSNotificationEventArgs>" />
</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:NewsstandKit.NKIssue.DownloadCompletedNotification" /> 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:NewsstandKit.NKIssue.DownloadCompletedNotification" /> notifications.</para>
<example>
<code lang="csharp lang-csharp"><![CDATA[
// Listen to all notifications posted for any object
var token = NKIssue.Notifications.ObserveDownloadCompleted ((notification) => {
Console.WriteLine ("Observed DownloadCompletedNotification!");
};
// Listen to all notifications posted for a single object
var token = NKIssue.Notifications.ObserveDownloadCompleted (objectToObserve, (notification) => {
Console.WriteLine ($"Observed DownloadCompletedNotification for {nameof (objectToObserve)}!");
};
// Stop listening for notifications
token.Dispose ();
]]></code>
</example>
</remarks>
</Docs>
</Member>
</Members>
</Type>