Home > Class Reference > ENSLIB namespace > EnsLib.PushNotifications.APNS.Operation

EnsLib.PushNotifications.APNS.Operation

class EnsLib.PushNotifications.APNS.Operation extends Ens.BusinessOperation, %Net.PushNotifications.APNS

Sends the notification request to the APNS server to forward to the specified device. The APNS server pushes the notification to one device for each call. It does not return any information other than if an error occurs, an indication that the error has occurred.

Property Inventory

Method Inventory

Parameters

parameter BUFFERSIZE = 16384;
parameter DEVICETOKENLENGTH = 32;
parameter INVOCATION = Queue;
Inherited description: 2 modes: Queue, InProc
parameter SERVICETYPE = APNS;
parameter SETTINGS = PushServerAddress,PushServerPort,ConnectTimeout,ResponseTimeout,SSLConfig,NotificationProtocol;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

property Adapter as Ens.OutboundAdapter;
Inherited description: The adapter instance
Property methods: AdapterGet(), AdapterGetSwizzled(), AdapterIsValid(), AdapterName(), AdapterNewObject(), AdapterSet()
property NotificationProtocol as %String (DISPLAYLIST = ",Simple,Enhanced,Modern", VALUELIST = ",simple,enhanced,modern") [ Required ];
Specifies the APNS notification protocol. Has one of the following values:

  • Simple - Simple Notification Protocol, which does not return any value and does not notify you if the protocol message causes an error.
  • Enhanced - Enhanced Notification Protocol, which returns values if the protocol message contains an error. This protocol does not return a value for messages without errors.
  • Modern - Reserved for future use. The APNS operation does not support the Modern Notification Protocol.
Property methods: NotificationProtocolDisplayToLogical(), NotificationProtocolGet(), NotificationProtocolIsValid(), NotificationProtocolLogicalToDisplay(), NotificationProtocolLogicalToOdbc(), NotificationProtocolNormalize(), NotificationProtocolSet()

Methods

classmethod ConstructAPNSPayloadArray(pRequest As EnsLib.PushNotifications.NotificationRequest, ByRef pPayloadData As %String) as %Status [ Language = objectscript ]
Build the intermediate APNS payload array from the message
method OnInit() as %Status [ Language = objectscript ]
This user callback method is called via initConfig() from %OnNew() or in the case of SOAP Services from OnPreSOAP()
method OnTearDown() as %Status [ Language = objectscript ]
This user callback method is called from %OnClose()
method PushNotification(pRequest As EnsLib.PushNotifications.NotificationRequest, ByRef pResponse As EnsLib.PushNotifications.NotificationResponse) as %Status [ Language = objectscript ]
method doEnhancedPushNotification(pRequest As EnsLib.PushNotifications.NotificationRequest, ByRef pResponse As EnsLib.PushNotifications.NotificationResponse) as %Status [ Language = objectscript ]
method doModernPushNotification(pRequest As EnsLib.PushNotifications.NotificationRequest, ByRef pResponse As EnsLib.PushNotifications.NotificationResponse) as %Status [ Language = objectscript ]
method doSimplePushNotification(pRequest As EnsLib.PushNotifications.NotificationRequest, ByRef pResponse As EnsLib.PushNotifications.NotificationResponse) as %Status [ Language = objectscript ]

Inherited Members

Inherited Properties

Inherited Methods