Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %Net.PushNotifications.APNS
Private  Storage   

%Net.PushNotifications.APNS


class %Net.PushNotifications.APNS extends
%RegisteredObject

// Implements Apple Push Notification Service connectivity

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 6 6


Summary


Properties
ConnectTimeout PushServerAddress PushServerPort ResponseTimeout
SSLConfig

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
Connect Disconnect EnhancedPushNotification SimplePushNotification

Subclasses
EnsLib.PushNotifications.APNS.Operation

Parameters


• parameter BUFFERSIZE = 16384;
• parameter DEVICETOKENLENGTH = 32;

Properties


• property ConnectTimeout as %Integer [ InitialExpression = 30,Required ];
Connection timeout
• property PushServerAddress as %String(MAXLEN=1024) [ Required ];
APNS Push Server name/address
• property PushServerPort as %String [ Required ];
APNS Push Server port
• property ResponseTimeout as %Integer [ InitialExpression = 5,Required ];
APNS Message Response timeout
• property SSLConfig as %String [ Required ];
APNS SSL Configuration

Methods


• method Connect() as %Status
Connect to the Apple Push Notification Service
• method Disconnect() as %Status
• method EnhancedPushNotification(pDeviceToken As %String, pRequestId As %Integer, pExpiresUTC As %TimeStamp, ByRef pNotificationData) as %Status
Send a notification using the "enhanced" mechanism. The pDeviceToken represents a device identifier, the pNotificationData is an array of the aps values (see the APNS docs) and pCustomData contains any additional data items to be included.
• method SimplePushNotification(pDeviceToken As %String, ByRef pNotificationData) as %Status
Send a "simple" push notification. The pDeviceToken represents a device identifier, the pNotificationData is an array of the aps values (see the APNS docs) and pCustomData contains any additional data items to be included.