ApplePushMessage Class
The ApplePushMessage helps generating a notification payload targeting Apple Push Notification Service. 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.ApplePushMessage
Syntax
[SerializableAttribute]
public class ApplePushMessage : Dictionary<string, object>, IPushMessage
[SerializableAttribute]
public ref class ApplePushMessage : Dictionary<String^, Object^>,
IPushMessage
[<SerializableAttribute>]
type ApplePushMessage =
class
inherit Dictionary<string, Object>
interface IPushMessage
end
<SerializableAttribute>
Public Class ApplePushMessage
Inherits Dictionary(Of String, Object)
Implements IPushMessage
Constructors
Name | Description | |
---|---|---|
ApplePushMessage() | Initializes a new instance of the ApplePushMessage class enabling creation a notification message targeting Apple Push Notification Service. Set the appropriate properties on the message and submit through the PushClient. |
|
ApplePushMessage(SerializationInfo, StreamingContext) | Initializes a new instance of the ApplePushMessage class with the specified serialization information and streaming context. |
|
ApplePushMessage(String, Nullable<TimeSpan>) | Initializes a new instance of the ApplePushMessage class with a given alert message and an optional expiration of the notification. |
Properties
Name | Description | |
---|---|---|
Aps | Gets the ApsProperties for this ApplePushMessage. |
|
Comparer | (Inherited from Dictionary<TKey, TValue>.) |
|
Count | (Inherited from Dictionary<TKey, TValue>.) |
|
Expiration | Sets or gets the lifetime of the notification. At the end of the lifetime, the notification is no longer valid and can be discarded. If this value is non-null, APNs stores the notification and tries to deliver the notification at least once. Specify null to indicate that the notification expires immediately and that APNs should not store the notification at all. |
|
Item[TKey] | (Inherited from Dictionary<TKey, TValue>.) |
|
JsonPayload | As an alternative to building the notification by initializing the ApplePushMessage 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>.) |
|
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 ApplePushMessage(Overrides Object.ToString().) |
|
TryGetValue(TKey, TValue) | (Inherited from Dictionary<TKey, TValue>.) |
Explicit Interface Implementations
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.
See Also
Microsoft.WindowsAzure.Mobile.Service Namespace
Return to top