EnsLib.PushNotifications.GCM.Operation
class EnsLib.PushNotifications.GCM.Operation extends Ens.BusinessOperation, %Net.PushNotifications.GCM
Interfaces with the Google Cloud Messaging ServiceProperty Inventory
Method Inventory
- ConstructGCMHTTPPayloadArray()
- OnInit()
- OnTearDown()
- PushNotification()
- doHTTPPushNotification()
- doXMPPPushNotification()
Parameters
parameter INVOCATION = Queue;
Inherited description: 2 modes: Queue, InProc
parameter SETTINGS = NotificationProtocol,PushServer,SSLConfig,Timeout;
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(), AdapterNewObject(), AdapterSet()
property NotificationProtocol as %String (DISPLAYLIST = ",HTTP,XMPP", VALUELIST = ",http,xmpp") [ Required ];
Specifies the GCM notification protocol. Has one of the following values:
- HTTP - HTTP REST protocol
- XMPP - Reserved for future use. The GCM operation does not support the XMPP always connected, bi-directional protocol.
Property methods: NotificationProtocolDisplayToLogical(), NotificationProtocolGet(), NotificationProtocolIsValid(), NotificationProtocolLogicalToDisplay(), NotificationProtocolLogicalToOdbc(), NotificationProtocolNormalize(), NotificationProtocolSet()
Methods
classmethod ConstructGCMHTTPPayloadArray(pRequest As EnsLib.PushNotifications.NotificationRequest, ByRef pPayloadArray As %String) as %Status
Construct a payload request for GCM (over HTTP)
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 doHTTPPushNotification(pRequest As EnsLib.PushNotifications.NotificationRequest, ByRef pResponse As EnsLib.PushNotifications.NotificationResponse) as %Status
method doXMPPPushNotification(pRequest As EnsLib.PushNotifications.NotificationRequest, ByRef pResponse As EnsLib.PushNotifications.NotificationResponse) as %Status
Inherited Members
Inherited Properties
- %AlertStartTime
- %ConfigName
- %ConfigQueueName
- %LastActionTime
- %LastHandledTime
- %LastReportedError
- %QuitTask
- %RequestHeader
- %SessionId
- %SuperSession
- %WarnedLatest
- %isShadow
- AlertGroups
- AlertOnError
- AlertRetryGracePeriod
- ArchiveIO
- BusinessPartner
- DeferResponse
- FailureTimeout
- IOLogEntry
- InactivityTimeout
- NoFailWhileDisconnected
- PushServer
- QueueCountAlert
- QueueWaitAlert
- ReplyCodeActions
- Retry
- RetryCount
- RetryInterval
- SSLConfig
- SendSuperSession
- SuspendMessage
- ThrottleDelay
- Timeout
Inherited 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()
- DeferResponse()
- Disconnect()
- EnumerateSettingsClose()
- EnumerateSettingsExecute()
- EnumerateSettingsFetch()
- GenerateSuperSession()
- GetDeferredResponseToken()
- GetMessageList()
- GetMsgHdrRequestKey()
- GetProductionSettingValue()
- GetProductionSettings()
- GetPropertyConnections()
- GetSettings()
- GetShadowInstance()
- HTTPPushNotification()
- IncludeSuperSession()
- NewIOLogEntry()
- OnError()
- OnFailureTimeout()
- OnGenerateSuperSession()
- OnGetConnections()
- OnGetReplyAction()
- OnKeepalive()
- OnMessage()
- OnMonitor()
- OnProductionStart()
- OnProductionStop()
- QueueName()
- SaveIOLogEntry()
- SendAlert()
- SendDeferredResponse()
- SendRequestAsync()
- SendRequestSync()