-
Notifications
You must be signed in to change notification settings - Fork 255
/
ApplePushMessage.xml
217 lines (217 loc) · 14.1 KB
/
ApplePushMessage.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="ApplePushMessage" FullName="Microsoft.Azure.Mobile.Server.ApplePushMessage">
<TypeSignature Language="C#" Value="public class ApplePushMessage : System.Collections.Generic.Dictionary<string,object>, Microsoft.Azure.Mobile.Server.Notifications.IPushMessage" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi serializable beforefieldinit ApplePushMessage extends System.Collections.Generic.Dictionary`2<string, object> implements class Microsoft.Azure.Mobile.Server.Notifications.IPushMessage" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Mobile.Server.ApplePushMessage" />
<TypeSignature Language="VB.NET" Value="Public Class ApplePushMessage
Inherits Dictionary(Of String, Object)
Implements IPushMessage" />
<TypeSignature Language="F#" Value="type ApplePushMessage = class
 inherit Dictionary<string, obj>
 interface IPushMessage" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Mobile.Server.Notifications</AssemblyName>
<AssemblyVersion>2.0.3.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Collections.Generic.Dictionary<System.String,System.Object></BaseTypeName>
<BaseTypeArguments>
<BaseTypeArgument TypeParamName="!0">System.String</BaseTypeArgument>
<BaseTypeArgument TypeParamName="!1">System.Object</BaseTypeArgument>
</BaseTypeArguments>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Azure.Mobile.Server.Notifications.IPushMessage</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2240:ImplementISerializableCorrectly", Justification="Expiration is not intended for serialization")]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2240:ImplementISerializableCorrectly", Justification="Expiration is not intended for serialization")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1710:IdentifiersShouldHaveCorrectSuffix", Justification="This describes a message.")]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1710:IdentifiersShouldHaveCorrectSuffix", Justification="This describes a message.")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Serializable]</AttributeName>
<AttributeName Language="F#">[<System.Serializable>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
The <see cref="T:Microsoft.Azure.Mobile.Server.ApplePushMessage" /> helps generating a notification payload targeting
Apple Push Notification Service. Notifications can be sent using the <see cref="T:Microsoft.Azure.Mobile.Server.Notifications.PushClient" />
class.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ApplePushMessage ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Mobile.Server.ApplePushMessage.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Mobile.Server.Notifications</AssemblyName>
<AssemblyVersion>2.0.3.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Mobile.Server.ApplePushMessage" /> class enabling creation a notification
message targeting Apple Push Notification Service. Set the appropriate properties on the message
and submit through the <see cref="T:Microsoft.Azure.Mobile.Server.Notifications.PushClient" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ApplePushMessage (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class System.Runtime.Serialization.SerializationInfo info, valuetype System.Runtime.Serialization.StreamingContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Mobile.Server.ApplePushMessage.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
<MemberSignature Language="VB.NET" Value="Protected Sub New (info As SerializationInfo, context As StreamingContext)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Mobile.Server.ApplePushMessage : System.Runtime.Serialization.SerializationInfo * System.Runtime.Serialization.StreamingContext -> Microsoft.Azure.Mobile.Server.ApplePushMessage" Usage="new Microsoft.Azure.Mobile.Server.ApplePushMessage (info, context)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Mobile.Server.Notifications</AssemblyName>
<AssemblyVersion>2.0.3.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="info" Type="System.Runtime.Serialization.SerializationInfo" />
<Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" />
</Parameters>
<Docs>
<param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo" /> containing information about the <see cref="T:Microsoft.Azure.Mobile.Server.AlertProperties" /> to be initialized.</param>
<param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext" /> that indicates the source destination and context information of a serialized stream.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Mobile.Server.ApplePushMessage" /> class with the specified serialization information and streaming context.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ApplePushMessage (string alert, TimeSpan? expiration);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string alert, valuetype System.Nullable`1<valuetype System.TimeSpan> expiration) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Mobile.Server.ApplePushMessage.#ctor(System.String,System.Nullable{System.TimeSpan})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (alert As String, expiration As Nullable(Of TimeSpan))" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Mobile.Server.ApplePushMessage : string * Nullable<TimeSpan> -> Microsoft.Azure.Mobile.Server.ApplePushMessage" Usage="new Microsoft.Azure.Mobile.Server.ApplePushMessage (alert, expiration)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Mobile.Server.Notifications</AssemblyName>
<AssemblyVersion>2.0.3.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="alert" Type="System.String" />
<Parameter Name="expiration" Type="System.Nullable<System.TimeSpan>" />
</Parameters>
<Docs>
<param name="alert">The notification alert message.</param>
<param name="expiration">A <see cref="T:System.TimeSpan" /> relative to the current time. At the end of the lifetime,
the notification is no longer valid and can be discarded. If this value is non-null, APNs stores the
notification and tries to deliver the notification at least once. Specify null to indicate that the
notification expires immediately and that APNs should not store the notification at all.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Mobile.Server.ApplePushMessage" /> class with a given <paramref name="alert" />
message and an optional <paramref name="expiration" /> of the notification.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Aps">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Mobile.Server.ApsProperties Aps { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Mobile.Server.ApsProperties Aps" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Mobile.Server.ApplePushMessage.Aps" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Aps As ApsProperties" />
<MemberSignature Language="F#" Value="member this.Aps : Microsoft.Azure.Mobile.Server.ApsProperties" Usage="Microsoft.Azure.Mobile.Server.ApplePushMessage.Aps" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Mobile.Server.Notifications</AssemblyName>
<AssemblyVersion>2.0.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Mobile.Server.ApsProperties</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the <see cref="T:Microsoft.Azure.Mobile.Server.ApsProperties" /> for this <see cref="T:Microsoft.Azure.Mobile.Server.ApplePushMessage" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Expiration">
<MemberSignature Language="C#" Value="public DateTimeOffset? Expiration { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTimeOffset> Expiration" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Mobile.Server.ApplePushMessage.Expiration" />
<MemberSignature Language="VB.NET" Value="Public Property Expiration As Nullable(Of DateTimeOffset)" />
<MemberSignature Language="F#" Value="member this.Expiration : Nullable<DateTimeOffset> with get, set" Usage="Microsoft.Azure.Mobile.Server.ApplePushMessage.Expiration" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Mobile.Server.Notifications</AssemblyName>
<AssemblyVersion>2.0.3.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonIgnore>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTimeOffset></ReturnType>
</ReturnValue>
<Docs>
<summary>
Sets or gets the lifetime of the notification. At the end of the lifetime, the notification is no
longer valid and can be discarded. If this value is non-null, APNs stores the notification and tries
to deliver the notification at least once. Specify null to indicate that the notification expires
immediately and that APNs should not store the notification at all.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="JsonPayload">
<MemberSignature Language="C#" Value="public string JsonPayload { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string JsonPayload" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Mobile.Server.ApplePushMessage.JsonPayload" />
<MemberSignature Language="VB.NET" Value="Public Property JsonPayload As String" />
<MemberSignature Language="F#" Value="member this.JsonPayload : string with get, set" Usage="Microsoft.Azure.Mobile.Server.ApplePushMessage.JsonPayload" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Mobile.Server.Notifications</AssemblyName>
<AssemblyVersion>2.0.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
As an alternative to building the notification by initializing the <see cref="T:Microsoft.Azure.Mobile.Server.ApplePushMessage" /> directly,
it is possible to provide a complete JSON representation which will be sent to the Notification Hub unaltered.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Mobile.Server.ApplePushMessage.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="applePushMessage.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Mobile.Server.Notifications</AssemblyName>
<AssemblyVersion>2.0.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Provides a JSON encoded representation of this <see cref="T:Microsoft.Azure.Mobile.Server.ApplePushMessage" /></summary>
<returns>A JSON encoded string.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>