/
WindowsPushMessage.xml
181 lines (181 loc) · 10.3 KB
/
WindowsPushMessage.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
<Type Name="WindowsPushMessage" FullName="Microsoft.Azure.Mobile.Server.WindowsPushMessage">
<TypeSignature Language="C#" Value="public class WindowsPushMessage : Microsoft.Azure.Mobile.Server.Notifications.IPushMessage" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit WindowsPushMessage extends System.Object implements class Microsoft.Azure.Mobile.Server.Notifications.IPushMessage" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Mobile.Server.WindowsPushMessage" />
<TypeSignature Language="VB.NET" Value="Public Class WindowsPushMessage
Implements IPushMessage" />
<TypeSignature Language="F#" Value="type WindowsPushMessage = class
 interface IPushMessage" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Mobile.Server.Notifications</AssemblyName>
<AssemblyVersion>2.0.3.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Azure.Mobile.Server.Notifications.IPushMessage</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Xml.Serialization.XmlRoot("tile")]</AttributeName>
<AttributeName Language="F#">[<System.Xml.Serialization.XmlRoot("tile")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
The <see cref="T:Microsoft.Azure.Mobile.Server.WindowsPushMessage" /> helps generating a notification payload targeting
Windows Push Notification Services. 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 WindowsPushMessage ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Mobile.Server.WindowsPushMessage.#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.WindowsPushMessage" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WindowsPushMessage (int version, params Microsoft.Azure.Mobile.Server.TileBinding[] bindings);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 version, class Microsoft.Azure.Mobile.Server.TileBinding[] bindings) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Mobile.Server.WindowsPushMessage.#ctor(System.Int32,Microsoft.Azure.Mobile.Server.TileBinding[])" />
<MemberSignature Language="VB.NET" Value="Public Sub New (version As Integer, ParamArray bindings As TileBinding())" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Mobile.Server.WindowsPushMessage : int * Microsoft.Azure.Mobile.Server.TileBinding[] -> Microsoft.Azure.Mobile.Server.WindowsPushMessage" Usage="new Microsoft.Azure.Mobile.Server.WindowsPushMessage (version, bindings)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Mobile.Server.Notifications</AssemblyName>
<AssemblyVersion>2.0.3.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="version" Type="System.Int32" />
<Parameter Name="bindings" Type="Microsoft.Azure.Mobile.Server.TileBinding[]">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ParamArray]</AttributeName>
<AttributeName Language="F#">[<System.ParamArray>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="version">The version of the tile XML schema this particular payload was developed for (e.g. "1" or "2").</param>
<param name="bindings">An initial set of bindings for this <see cref="T:Microsoft.Azure.Mobile.Server.WindowsPushMessage" />.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Mobile.Server.WindowsPushMessage" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Headers">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IDictionary<string,string> Headers { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2<string, string> Headers" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Mobile.Server.WindowsPushMessage.Headers" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Headers As IDictionary(Of String, String)" />
<MemberSignature Language="F#" Value="member this.Headers : System.Collections.Generic.IDictionary<string, string>" Usage="Microsoft.Azure.Mobile.Server.WindowsPushMessage.Headers" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Mobile.Server.Notifications</AssemblyName>
<AssemblyVersion>2.0.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IDictionary<System.String,System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Any additional HTTP headers sent to the Windows Push Notification Services along with the notification.
</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.WindowsPushMessage.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="windowsPushMessage.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 an XML representation of the <see cref="T:Microsoft.Azure.Mobile.Server.WindowsPushMessage" /> instance.
</summary>
<returns />
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Visual">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Mobile.Server.Notifications.VisualTile Visual { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Mobile.Server.Notifications.VisualTile Visual" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Mobile.Server.WindowsPushMessage.Visual" />
<MemberSignature Language="VB.NET" Value="Public Property Visual As VisualTile" />
<MemberSignature Language="F#" Value="member this.Visual : Microsoft.Azure.Mobile.Server.Notifications.VisualTile with get, set" Usage="Microsoft.Azure.Mobile.Server.WindowsPushMessage.Visual" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Mobile.Server.Notifications</AssemblyName>
<AssemblyVersion>2.0.3.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Xml.Serialization.XmlElement("visual")]</AttributeName>
<AttributeName Language="F#">[<System.Xml.Serialization.XmlElement("visual")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Mobile.Server.Notifications.VisualTile</ReturnType>
</ReturnValue>
<Docs>
<summary>
A <see cref="T:Microsoft.Azure.Mobile.Server.Notifications.VisualTile" /> element which contains multiple binding child elements, each of which defines a tile.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="XmlPayload">
<MemberSignature Language="C#" Value="public string XmlPayload { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string XmlPayload" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Mobile.Server.WindowsPushMessage.XmlPayload" />
<MemberSignature Language="VB.NET" Value="Public Property XmlPayload As String" />
<MemberSignature Language="F#" Value="member this.XmlPayload : string with get, set" Usage="Microsoft.Azure.Mobile.Server.WindowsPushMessage.XmlPayload" />
<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 programmatically by adding <see cref="T:Microsoft.Azure.Mobile.Server.TileBinding" /> instances to the
<see cref="T:Microsoft.Azure.Mobile.Server.WindowsPushMessage" />, it is possible to provide a complete XML representation which will be sent
to the Notification Hub unaltered.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>