ApsProperties Class

Article
05/25/2016

The "aps" property contains the definition of a notification targeting Apple Push Notification Service (APNS). It is intended to be used from the ApplePushMessage 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.ApsProperties

Syntax

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

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

[<SerializableAttribute>]
type ApsProperties = 
    class
        inherit Dictionary<string, Object>
    end

<SerializableAttribute>
Public Class ApsProperties
    Inherits Dictionary(Of String, Object)

Constructors

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

Properties

	Name	Description
	Alert	The alert message as a single string. For more complex alert message options, please use M:AlertProperties.
	AlertProperties	The alert message as a dictionary with additional properties describing the alert such as localization information, which image to display, etc. If the alert is simply a string then please use M:Alert.
	Badge	The number to display as the badge of the application icon. If this property is absent, the badge is not changed. To remove the badge, set the value of this property to 0.
	Comparer	(Inherited from Dictionary<TKey, TValue>.)
	ContentAvailable	Provide this key with a value of 1 to indicate that new content is available. This is used to support Newsstand apps and background content downloads.
	Count	(Inherited from Dictionary<TKey, TValue>.)
	Item[TKey]	(Inherited from Dictionary<TKey, TValue>.)
	Keys	(Inherited from Dictionary<TKey, TValue>.)
	Sound	The name of a sound file in the application bundle. The sound in this file is played as an alert. If the sound file doesn’t exist or default is specified as the value, the default alert sound is played. The audio must be in one of the audio data formats that are compatible with system sounds;
	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.

Share via