-
Notifications
You must be signed in to change notification settings - Fork 260
/
GooglePushMessage.xml
257 lines (257 loc) · 16.9 KB
/
GooglePushMessage.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
<Type Name="GooglePushMessage" FullName="Microsoft.WindowsAzure.Mobile.Service.GooglePushMessage">
<TypeSignature Language="C#" Value="public class GooglePushMessage : System.Collections.Generic.Dictionary<string,object>, Microsoft.WindowsAzure.Mobile.Service.Notifications.IPushMessage" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi serializable beforefieldinit GooglePushMessage extends System.Collections.Generic.Dictionary`2<string, object> implements class Microsoft.WindowsAzure.Mobile.Service.Notifications.IPushMessage" />
<TypeSignature Language="DocId" Value="T:Microsoft.WindowsAzure.Mobile.Service.GooglePushMessage" />
<TypeSignature Language="VB.NET" Value="Public Class GooglePushMessage
Inherits Dictionary(Of String, Object)
Implements IPushMessage" />
<TypeSignature Language="F#" Value="type GooglePushMessage = class
 inherit Dictionary<string, obj>
 interface IPushMessage" />
<AssemblyInfo>
<AssemblyName>Microsoft.WindowsAzure.Mobile.Service</AssemblyName>
<AssemblyVersion>1.0.0.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.WindowsAzure.Mobile.Service.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.WindowsAzure.Mobile.Service.GooglePushMessage" /> helps generating a notification payload targeting
Google Cloud Messaging for Chrome (GCM). Notifications can be sent using the <see cref="T:Microsoft.WindowsAzure.Mobile.Service.Notifications.PushClient" />
class which is available from the <see cref="T:Microsoft.WindowsAzure.Mobile.Service.ApiServices" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public GooglePushMessage ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.WindowsAzure.Mobile.Service.GooglePushMessage.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.WindowsAzure.Mobile.Service</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.WindowsAzure.Mobile.Service.GooglePushMessage" /> class enabling creation
of a notification message targeting Google Cloud Messaging for Chrome (GCM).Set the
appropriate properties on the message and submit through the <see cref="T:Microsoft.WindowsAzure.Mobile.Service.Notifications.PushClient" /></summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public GooglePushMessage (System.Collections.Generic.IDictionary<string,string> data, TimeSpan? timeToLive);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Generic.IDictionary`2<string, string> data, valuetype System.Nullable`1<valuetype System.TimeSpan> timeToLive) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.WindowsAzure.Mobile.Service.GooglePushMessage.#ctor(System.Collections.Generic.IDictionary{System.String,System.String},System.Nullable{System.TimeSpan})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (data As IDictionary(Of String, String), timeToLive As Nullable(Of TimeSpan))" />
<MemberSignature Language="F#" Value="new Microsoft.WindowsAzure.Mobile.Service.GooglePushMessage : System.Collections.Generic.IDictionary<string, string> * Nullable<TimeSpan> -> Microsoft.WindowsAzure.Mobile.Service.GooglePushMessage" Usage="new Microsoft.WindowsAzure.Mobile.Service.GooglePushMessage (data, timeToLive)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.WindowsAzure.Mobile.Service</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="data" Type="System.Collections.Generic.IDictionary<System.String,System.String>" />
<Parameter Name="timeToLive" Type="System.Nullable<System.TimeSpan>" />
</Parameters>
<Docs>
<param name="data" />
<param name="timeToLive">A <see cref="T:System.TimeSpan" /> relative to the current time. The value of this
parameter must be a duration from 0 to 2,419,200 seconds (28 days), and it corresponds to the maximum period of time
for which GCM will store and try to deliver the message. Requests that don't contain this field default
to the maximum period of 4 weeks.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.WindowsAzure.Mobile.Service.GooglePushMessage" /> class with a given
set of <paramref name="data" /> parameters and an optional <paramref name="timeToLive" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected GooglePushMessage (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.WindowsAzure.Mobile.Service.GooglePushMessage.#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.WindowsAzure.Mobile.Service.GooglePushMessage : System.Runtime.Serialization.SerializationInfo * System.Runtime.Serialization.StreamingContext -> Microsoft.WindowsAzure.Mobile.Service.GooglePushMessage" Usage="new Microsoft.WindowsAzure.Mobile.Service.GooglePushMessage (info, context)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.WindowsAzure.Mobile.Service</AssemblyName>
<AssemblyVersion>1.0.0.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.WindowsAzure.Mobile.Service.GooglePushMessage" /> 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.WindowsAzure.Mobile.Service.GooglePushMessage" /> class with the specified serialization information and streaming context.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CollapseKey">
<MemberSignature Language="C#" Value="public string CollapseKey { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string CollapseKey" />
<MemberSignature Language="DocId" Value="P:Microsoft.WindowsAzure.Mobile.Service.GooglePushMessage.CollapseKey" />
<MemberSignature Language="VB.NET" Value="Public Property CollapseKey As String" />
<MemberSignature Language="F#" Value="member this.CollapseKey : string with get, set" Usage="Microsoft.WindowsAzure.Mobile.Service.GooglePushMessage.CollapseKey" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.WindowsAzure.Mobile.Service</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
A collapse key is an arbitrary string that is used to collapse a group of like messages when the device
is offline, so that only the most recent message gets sent to the client. For example, "New mail", "Updates available",
and so on.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Data">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IDictionary<string,string> Data { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2<string, string> Data" />
<MemberSignature Language="DocId" Value="P:Microsoft.WindowsAzure.Mobile.Service.GooglePushMessage.Data" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Data As IDictionary(Of String, String)" />
<MemberSignature Language="F#" Value="member this.Data : System.Collections.Generic.IDictionary<string, string>" Usage="Microsoft.WindowsAzure.Mobile.Service.GooglePushMessage.Data" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.WindowsAzure.Mobile.Service</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IDictionary<System.String,System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
A collection or name-value properties to include in the message. Properties must be simple types, i.e. they
can not be nested.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DelayWhileIdle">
<MemberSignature Language="C#" Value="public bool DelayWhileIdle { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool DelayWhileIdle" />
<MemberSignature Language="DocId" Value="P:Microsoft.WindowsAzure.Mobile.Service.GooglePushMessage.DelayWhileIdle" />
<MemberSignature Language="VB.NET" Value="Public Property DelayWhileIdle As Boolean" />
<MemberSignature Language="F#" Value="member this.DelayWhileIdle : bool with get, set" Usage="Microsoft.WindowsAzure.Mobile.Service.GooglePushMessage.DelayWhileIdle" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.WindowsAzure.Mobile.Service</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Indicates whether the message should be delivered while the device is idle.
</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.WindowsAzure.Mobile.Service.GooglePushMessage.JsonPayload" />
<MemberSignature Language="VB.NET" Value="Public Property JsonPayload As String" />
<MemberSignature Language="F#" Value="member this.JsonPayload : string with get, set" Usage="Microsoft.WindowsAzure.Mobile.Service.GooglePushMessage.JsonPayload" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.WindowsAzure.Mobile.Service</AssemblyName>
<AssemblyVersion>1.0.0.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.WindowsAzure.Mobile.Service.GooglePushMessage" /> 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="TimeToLiveInSeconds">
<MemberSignature Language="C#" Value="public int? TimeToLiveInSeconds { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> TimeToLiveInSeconds" />
<MemberSignature Language="DocId" Value="P:Microsoft.WindowsAzure.Mobile.Service.GooglePushMessage.TimeToLiveInSeconds" />
<MemberSignature Language="VB.NET" Value="Public Property TimeToLiveInSeconds As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.TimeToLiveInSeconds : Nullable<int> with get, set" Usage="Microsoft.WindowsAzure.Mobile.Service.GooglePushMessage.TimeToLiveInSeconds" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.WindowsAzure.Mobile.Service</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
The Time to Live (TTL) property lets the sender specify the maximum lifespan of a message. The value of this
parameter must be a duration from 0 to 2,419,200 seconds, and it corresponds to the maximum period of time
for which GCM will store and try to deliver the message. Requests that don't contain this field default
to the maximum period of 4 weeks.
</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.WindowsAzure.Mobile.Service.GooglePushMessage.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="googlePushMessage.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.WindowsAzure.Mobile.Service</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Provides a JSON encoded representation of this <see cref="T:Microsoft.WindowsAzure.Mobile.Service.GooglePushMessage" /></summary>
<returns>A JSON encoded string.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>