TemplatePushMessage Class

Article
05/25/2016

The ApplePushMessage helps generating a notification payload targeting devices that have registered with a template registration. A template lets the device specify the shape of notifications that it wants to receive including a set of keywords which it wants the sender to fill in. Instead of the sender building the entire notification, it simply sets the keyword values. The Notification Hub will then build a notification using the particular template registered by device and the keywords provided by the sender. This makes it much easier to send notifications regardless of the platform of the receiver. The keywords defined by the TemplatePushMessage class can be sent using the PushClient class which is available from the ApiServices class.

Namespace: Microsoft.WindowsAzure.Mobile.Service
Assembly: Microsoft.WindowsAzure.Mobile.Service (in Microsoft.WindowsAzure.Mobile.Service.dll)

Inheritance Hierarchy

System.Object
System.Collections.Generic.Dictionary<TKey, TValue>
Microsoft.WindowsAzure.Mobile.Service.TemplatePushMessage

Syntax

[SerializableAttribute]
public class TemplatePushMessage : Dictionary<string, string>, 
    IPushMessage

[SerializableAttribute]
public ref class TemplatePushMessage : Dictionary<String^, String^>, 
    IPushMessage

[<SerializableAttribute>]
type TemplatePushMessage = 
    class
        inherit Dictionary<string, string>
        interface IPushMessage
    end

<SerializableAttribute>
Public Class TemplatePushMessage
    Inherits Dictionary(Of String, String)
    Implements IPushMessage

Constructors

	Name	Description
	TemplatePushMessage()	Initializes a new instance of the TemplatePushMessage class.
	TemplatePushMessage(SerializationInfo, StreamingContext)	Initializes a new instance of the TemplatePushMessage class with the specified serialization information and streaming context.

Properties

	Name	Description
	Comparer	(Inherited from Dictionary<TKey, TValue>.)
	Count	(Inherited from Dictionary<TKey, TValue>.)
	Item[TKey]	(Inherited from Dictionary<TKey, TValue>.)
	Keys	(Inherited from Dictionary<TKey, TValue>.)
	Values	(Inherited from Dictionary<TKey, TValue>.)

Methods

	Name	Description
	Add(TKey, TValue)	(Inherited from Dictionary<TKey, TValue>.)
	Clear()	(Inherited from Dictionary<TKey, TValue>.)
	ContainsKey(TKey)	(Inherited from Dictionary<TKey, TValue>.)
	ContainsValue(TValue)	(Inherited from Dictionary<TKey, TValue>.)
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetEnumerator()	(Inherited from Dictionary<TKey, TValue>.)
	GetHashCode()	(Inherited from Object.)
	GetObjectData(SerializationInfo, StreamingContext)	(Inherited from Dictionary<TKey, TValue>.)
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	OnDeserialization(Object)	(Inherited from Dictionary<TKey, TValue>.)
	Remove(TKey)	(Inherited from Dictionary<TKey, TValue>.)
	ToString()	(Inherited from Object.)
	TryGetValue(TKey, TValue)	(Inherited from Dictionary<TKey, TValue>.)

Explicit Interface Implementations

	Name	Description
	ICollection<KeyValuePair<TKey, TValue>>.Add(KeyValuePair<TKey, TValue>)	(Inherited from Dictionary<TKey, TValue>.)
	ICollection<KeyValuePair<TKey, TValue>>.Contains(KeyValuePair<TKey, TValue>)	(Inherited from Dictionary<TKey, TValue>.)
	ICollection<KeyValuePair<TKey, TValue>>.CopyTo(KeyValuePair<TKey, TValue>[], Int32)	(Inherited from Dictionary<TKey, TValue>.)
	ICollection<KeyValuePair<TKey, TValue>>.Remove(KeyValuePair<TKey, TValue>)	(Inherited from Dictionary<TKey, TValue>.)
	IEnumerable<KeyValuePair<TKey, TValue>>.GetEnumerator()	(Inherited from Dictionary<TKey, TValue>.)
	ICollection.CopyTo(Array, Int32)	(Inherited from Dictionary<TKey, TValue>.)
	IDictionary.Add(Object, Object)	(Inherited from Dictionary<TKey, TValue>.)
	IDictionary.Contains(Object)	(Inherited from Dictionary<TKey, TValue>.)
	IDictionary.GetEnumerator()	(Inherited from Dictionary<TKey, TValue>.)
	IDictionary.Remove(Object)	(Inherited from Dictionary<TKey, TValue>.)
	IEnumerable.GetEnumerator()	(Inherited from Dictionary<TKey, TValue>.)

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.