This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

%Net.PushNotifications.APNS

class %Net.PushNotifications.APNS extends %Library.RegisteredObject

// Implements Apple Push Notification Service connectivity

Property Inventory

Method Inventory

Parameters

parameter BUFFERSIZE = 16384;
parameter DEVICETOKENLENGTH = 32;

Properties

property ConnectTimeout as %Integer [ InitialExpression = 30 , Required ];
Connection timeout
Property methods: ConnectTimeoutDisplayToLogical(), ConnectTimeoutGet(), ConnectTimeoutIsValid(), ConnectTimeoutLogicalToDisplay(), ConnectTimeoutNormalize(), ConnectTimeoutSet()
property PushServerAddress as %String (MAXLEN = 1024) [ Required ];
APNS Push Server name/address
Property methods: PushServerAddressDisplayToLogical(), PushServerAddressGet(), PushServerAddressIsValid(), PushServerAddressLogicalToDisplay(), PushServerAddressLogicalToOdbc(), PushServerAddressNormalize(), PushServerAddressSet()
property PushServerPort as %String [ Required ];
APNS Push Server port
Property methods: PushServerPortDisplayToLogical(), PushServerPortGet(), PushServerPortIsValid(), PushServerPortLogicalToDisplay(), PushServerPortLogicalToOdbc(), PushServerPortNormalize(), PushServerPortSet()
property ResponseTimeout as %Integer [ InitialExpression = 5 , Required ];
APNS Message Response timeout
Property methods: ResponseTimeoutDisplayToLogical(), ResponseTimeoutGet(), ResponseTimeoutIsValid(), ResponseTimeoutLogicalToDisplay(), ResponseTimeoutNormalize(), ResponseTimeoutSet()
property SSLConfig as %String [ Required ];
APNS SSL Configuration
Property methods: SSLConfigDisplayToLogical(), SSLConfigGet(), SSLConfigIsValid(), SSLConfigLogicalToDisplay(), SSLConfigLogicalToOdbc(), SSLConfigNormalize(), SSLConfigSet()

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.

Inherited Members

Inherited Methods

Feedback