Class Reference
EnsLib.PushNotifications.APNS.Operation
Server:appadmin-00044-deployment-6bf4cbc86d-9f4xc
Instance:IRIS
User:SuperUser
 
-
  [USER] >  [EnsLib] >  [PushNotifications] >  [APNS] >  [Operation]
Private  Storage

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.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 2 7


Summary

This is a Business Operation class.

RequestResponse
EnsLib.PushNotifications.NotificationRequest EnsLib.PushNotifications.NotificationResponse

Properties
%AlertStartTime %ConfigName %ConfigQueueName %LastActionTime
%LastHandledTime %LastReportedError %QuitTask %RequestHeader
%SessionId %SuperSession %WarnedLatest %isShadow
Adapter AlertGroups AlertOnError AlertRetryGracePeriod
ArchiveIO BusinessPartner ConnectTimeout DeferResponse
FailureTimeout IOLogEntry InactivityTimeout NoFailWhileDisconnected
NotificationProtocol PushServerAddress PushServerPort QueueCountAlert
QueueWaitAlert ReplyCodeActions ResponseTimeout Retry
RetryCount RetryInterval SSLConfig SendSuperSession
SuspendMessage ThrottleDelay

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OnClose %OnNew
%OriginalNamespace %PackageName %RemoveFromSaveSet %SerializeObject
%SetModified %SuperSessionSet %ValidateObject AdapterName
AssignOneSetting CloseIOLogEntry Connect ConstructAPNSPayloadArray
DeferResponse Disconnect EnhancedPushNotification EnumerateSettingsClose
EnumerateSettingsExecute EnumerateSettingsFetch GenerateSuperSession GetDeferredResponseToken
GetMessageList GetMsgHdrRequestKey GetProductionSettingValue GetProductionSettings
GetPropertyConnections GetSettings GetShadowInstance IncludeSuperSession
NewIOLogEntry OnError OnFailureTimeout OnGenerateSuperSession
OnGetConnections OnGetReplyAction OnInit OnKeepalive
OnMessage OnMonitor OnProductionStart OnProductionStop
OnTearDown PushNotification QueueName SaveIOLogEntry
SendAlert SendDeferredResponse SendRequestAsync SendRequestSync
SimplePushNotification doEnhancedPushNotification doModernPushNotification doSimplePushNotification


Parameters

• parameter BUFFERSIZE = 16384;
• parameter DEVICETOKENLENGTH = 32;
• parameter INVOCATION = "Queue";
2 modes: Queue, InProc
• parameter SERVICETYPE = "APNS";
• parameter SETTINGS = "PushServerAddress,PushServerPort,ConnectTimeout,ResponseTimeout,SSLConfig,NotificationProtocol";
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;
The adapter instance
• 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.

Methods

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


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.