IRISLIB database
APNS Class Reference

// Implements Apple Push Notification Service connectivity More...

Inheritance diagram for APNS:
Collaboration diagram for APNS:

Public Member Functions

_.Library.Status Connect ()
 Connect to the Apple Push Notification Service.
 
_.Library.Status EnhancedPushNotification (_.Library.String pDeviceToken, _.Library.Integer pRequestId, _.Library.TimeStamp pExpiresUTC, pNotificationData)
 Send a notification using the "enhanced" mechanism. More...
 
_.Library.Status SimplePushNotification (_.Library.String pDeviceToken, pNotificationData)
 Send a "simple" push notification. More...
 
- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 

Public Attributes

 ConnectTimeout
 SSL Connection timeout period in seconds. More...
 
 PushServerAddress
 Hostname of the Apple Push Notification Server. More...
 
 PushServerPort
 Port for the Apple Push Notification Server interface. More...
 
 ResponseTimeout
 Time period in seconds to wait for a response to a connection request. More...
 
 SSLConfig
 Configuration name in the table of SSL configurations. More...
 

Static Public Attributes

 BUFFERSIZE = None
 // Implements Apple Push Notification Service connectivity
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Detailed Description

// Implements Apple Push Notification Service connectivity

Member Function Documentation

◆ EnhancedPushNotification()

_.Library.Status EnhancedPushNotification ( _.Library.String  pDeviceToken,
_.Library.Integer  pRequestId,
_.Library.TimeStamp  pExpiresUTC,
  pNotificationData 
)

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.

◆ SimplePushNotification()

_.Library.Status SimplePushNotification ( _.Library.String  pDeviceToken,
  pNotificationData 
)

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.

Member Data Documentation

◆ ConnectTimeout

ConnectTimeout

SSL Connection timeout period in seconds.

The connection is terminated after this period of inactivity.

 

◆ PushServerAddress

PushServerAddress

Hostname of the Apple Push Notification Server.

 

◆ PushServerPort

PushServerPort

Port for the Apple Push Notification Server interface.

 

◆ ResponseTimeout

ResponseTimeout

Time period in seconds to wait for a response to a connection request.

 

◆ SSLConfig

SSLConfig

Configuration name in the table of SSL configurations.

The SSL is associated with the app and must be provided by Apple for the APNS service.