Class EnsLib.PushNotifications.IdentityManager.DeviceTracking

persistent class EnsLib.PushNotifications.IdentityManager.DeviceTracking extends %Persistent, %XML.Adaptor

Zen Mobile Cloud Messaging Device Tracking

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
	5	4	1	4

Summary

Properties
AppIdentifier	AssociatedAppTokens	Identifier	LastUpdatedUTC
Service

Methods
%%CLASSNAMELogicalToStorage	%%CLASSNAMEStorageToLogical	%AddToSaveSet	%AddToSyncSet
%BMEBuilt	%BuildIndicesAsync	%BuildIndicesAsyncResponse	%CheckConstraints
%CheckConstraintsForExtent	%ClassIsLatestVersion	%ClassName	%ComposeOid
%ConstructClone	%Delete	%DeleteExtent	%DeleteId
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%Exists
%ExistsId	%Extends	%GUID	%GUIDSet
%GetLock	%GetParameter	%GetSwizzleObject	%Id
%InsertBatch	%IsA	%IsModified	%IsNull
%KillExtent	%KillExtentData	%LoadFromMemory	%LockExtent
%LockId	%New	%NormalizeObject	%ObjectIsNull
%ObjectModified	%Oid	%OnBeforeAddToSync	%OnDeleteFinally
%OnDetermineClass	%OnOpenFinally	%OnSaveFinally	%Open
%OpenId	%OriginalNamespace	%PackageName	%PhysicalAddress
%PurgeIndices	%Reload	%RemoveFromSaveSet	%ResolveConcurrencyConflict
%RollBack	%Save	%SaveDirect	%SaveIndices
%SerializeObject	%SetModified	%SortBegin	%SortEnd
%SyncObjectIn	%SyncTransport	%UnlockExtent	%UnlockId
%ValidateIndices	%ValidateObject	%ValidateTable	AssociateDeviceWithAppToken
DisassociateDeviceWithAppToken	FindDeviceByAppToken	FindDeviceByDeviceAndAppIds	XMLDTD
XMLExport	XMLExportToStream	XMLExportToString	XMLNew
XMLSchema	XMLSchemaNamespace	XMLSchemaType

Properties

• property AppIdentifier as %String(MAXLEN=512) [ Required ];

App Identifier

• property AssociatedAppTokens as list of %String(MAXLEN=512) [ Required ];

Associated Application Token

• property Identifier as %String(MAXLEN=512) [ Required ];

Device Identifier (i.e. DeviceToken, or Registration Id)

• property LastUpdatedUTC as %TimeStamp [ InitialExpression = $ZDT($system.Util.LocalWithZTIMEZONEtoUTC($H),3),Required ];

Last updated-at timestamp

• property Service as %String(DISPLAYLIST=",Apple Push Notification Service,Google Cloud Messaging",VALUELIST=",APNS,GCM") [ Required ];

Service type descriptor

Methods

• classmethod AssociateDeviceWithAppToken(pIdentifier As %String, pAppId As %String, pService As %String, pAppToken As %String) as %Status

Associate an application token with a deviceid/appid.
pIdentifier is the device token given to the remote device by the notification service.
pAppId is the application identifier (if applicable, not needed for APNS) associated with your application.
pService is the service identifier, one of:
APNS: Apple Push Notification Service

GCM: Google Cloud Messaging
pAppToken is the unique application token/identifier that you wish associated with this device.

• classmethod DisassociateDeviceWithAppToken(pIdentifier As %String, pAppId As %String, pService As %String, pAppToken As %String) as %Status

Disassociate an application token from an identifier/appid.
pIdentifier is the device token given to the remote device by the notification service.
pAppId is the application identifier (if applicable, not needed for APNS) associated with your application.
pService is the service identifier, one of:
APNS: Apple Push Notification Service

GCM: Google Cloud Messaging
pAppToken is the unique application token/identifier that you associated with this device.

• classmethod FindDeviceByAppToken(pAppToken As %String, ByRef pDevice As EnsLib.PushNotifications.IdentityManager.DeviceTracking) as %Status

Locate a device tracking object by an app token

• classmethod FindDeviceByDeviceAndAppIds(pIdentifier As %String, pAppId As %String, pService As %String, ByRef pDevice As EnsLib.PushNotifications.IdentityManager.DeviceTracking, pCreate As %Boolean = 0) as %Status

Helper to locate and/or create a device tracking object from a deviceid/appid pair

Queries

• query DeviceSearchByAppToken(pAppToken As %String)

SQL Query :
SELECT %ID, Service, Identifier, LastUpdatedUTC FROM DeviceTracking
WHERE FOR SOME %ELEMENT(AssociatedAppTokens) (%Value = :pAppToken)

Search for devices matching the associated app token

Indices

•index (AppIdentifierIndex on AppIdentifier);

Index the app identifier

•index (AssociatedAppTokensIndex on AssociatedAppTokens(ELEMENTS));

Index the associated app tokens (all of them) with this object

•index (IdentifierIndex on Identifier);

Index the device identifier

•index (ServiceIndex on Service);

Index the service

Class Reference IRIS for UNIX 2024.1.2
Documentation Search