Class EnsLib.PushNotifications.GCM.Operation

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

Interfaces with the Google Cloud Messaging Service

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
2	2	6

Summary

This is a Business Operation class.

Request	Response
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	DeferResponse	FailureTimeout
IOLogEntry	InactivityTimeout	NoFailWhileDisconnected	NotificationProtocol
PushServer	QueueCountAlert	QueueWaitAlert	ReplyCodeActions
Retry	RetryCount	RetryInterval	SSLConfig
SendSuperSession	SuspendMessage	ThrottleDelay	Timeout

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	ConstructGCMHTTPPayloadArray
DeferResponse	Disconnect	EnumerateSettingsClose	EnumerateSettingsExecute
EnumerateSettingsFetch	GenerateSuperSession	GetDeferredResponseToken	GetMessageList
GetMsgHdrRequestKey	GetProductionSettingValue	GetProductionSettings	GetPropertyConnections
GetSettings	GetShadowInstance	HTTPPushNotification	IncludeSuperSession
NewIOLogEntry	OnError	OnFailureTimeout	OnGenerateSuperSession
OnGetConnections	OnGetReplyAction	OnInit	OnKeepalive
OnMessage	OnMonitor	OnProductionStart	OnProductionStop
OnTearDown	PushNotification	QueueName	SaveIOLogEntry
SendAlert	SendDeferredResponse	SendRequestAsync	SendRequestSync
doHTTPPushNotification	doXMPPPushNotification

Parameters

• parameter INVOCATION = "Queue";

2 modes: Queue, InProc

• parameter SETTINGS = "NotificationProtocol,PushServer,SSLConfig,Timeout";

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=",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.

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

Class Reference IRIS for UNIX 2024.1.2
Documentation Search