GooglePushMessage Class

Article
05/25/2016

The GooglePushMessage helps generating a notification payload targeting Google Cloud Messaging for Chrome (GCM). Notifications 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.GooglePushMessage

Syntax

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

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

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

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

Constructors

	Name	Description
	GooglePushMessage()	Initializes a new instance of the 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 PushClient
	GooglePushMessage(IDictionary<String, String>, Nullable<TimeSpan>)	Initializes a new instance of the GooglePushMessage class with a given set of data parameters and an optional timeToLive.
	GooglePushMessage(SerializationInfo, StreamingContext)	Initializes a new instance of the GooglePushMessage class with the specified serialization information and streaming context.

Properties

	Name	Description
	CollapseKey	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.
	Comparer	(Inherited from Dictionary<TKey, TValue>.)
	Count	(Inherited from Dictionary<TKey, TValue>.)
	Data	A collection or name-value properties to include in the message. Properties must be simple types, i.e. they can not be nested.
	DelayWhileIdle	Indicates whether the message should be delivered while the device is idle.
	Item[TKey]	(Inherited from Dictionary<TKey, TValue>.)
	JsonPayload	As an alternative to building the notification by initializing the GooglePushMessage directly, it is possible to provide a complete JSON representation which will be sent to the Notification Hub unaltered.
	Keys	(Inherited from Dictionary<TKey, TValue>.)
	TimeToLiveInSeconds	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.
	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()	Provides a JSON encoded representation of this GooglePushMessage(Overrides Object.ToString().)
	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.

Share via