TPG.GeoFramework.GeoFencingServiceInterfaces.INotificationHandlingServiceBase Interface Reference

Use for geofencing notification processing. Clients can fetch filtered lists of notifications and modify certain aspects of these, allowing setup of complex and diverse multi user notification handling systems. More...

Inheritance diagram for TPG.GeoFramework.GeoFencingServiceInterfaces.INotificationHandlingServiceBase:

Public Member Functions
NotificationQueryResult	GetNotifications (string notificationConditionXml, int lastKnownGeneration)
	Retrieve all notifications that satisfies condition, that are newer than "lastKnownGeneration".
bool	SetNotificationUserData (Guid notificationId, UserDataDefinition userData)
	Most of the fields in a notifications are locked and cannot be changed. The clients can only modify certain user data by using this method.
void	SetNotificationLogInformation (NotificationLogInfo logInfo)
	Setup notification log. All new events will be logged based on this setting, possibly changing log.
bool	RestoreNotificationLog ()
	Restores notifications from one or more logs. Note that any ongoing logging will be flushed and closed.

Detailed Description

Use for geofencing notification processing. Clients can fetch filtered lists of notifications and modify certain aspects of these, allowing setup of complex and diverse multi user notification handling systems.

Member Function Documentation

GetNotifications()

NotificationQueryResult TPG.GeoFramework.GeoFencingServiceInterfaces.INotificationHandlingServiceBase.GetNotifications	(	string	notificationConditionXml,
		int	lastKnownGeneration
	)

Retrieve all notifications that satisfies condition, that are newer than "lastKnownGeneration".

Parameters

notificationConditionXml	Notification filter. Uses same format as track/object style conditions, allowing field compares and complex, nested conditions. Set to null/empty to bypass filtering
lastKnownGeneration	Last known generation by the client. Only newer notifications than this value will be returned. Set to -1 to bypass generation checking

Returns

Implemented in TPG.GeoFramework.GeoFencingClient.NotificationHandlingServiceClient, and TPG.GeoFramework.GeoFencingService.GeoFencingService.

RestoreNotificationLog()

bool TPG.GeoFramework.GeoFencingServiceInterfaces.INotificationHandlingServiceBase.RestoreNotificationLog

(

)

Restores notifications from one or more logs. Note that any ongoing logging will be flushed and closed.

Parameters

sourceLogs

Logs to restore, the logs are read in sequence

Returns

"true" on success

Implemented in TPG.GeoFramework.GeoFencingClient.NotificationHandlingServiceClient, and TPG.GeoFramework.GeoFencingService.GeoFencingService.

SetNotificationLogInformation()

void TPG.GeoFramework.GeoFencingServiceInterfaces.INotificationHandlingServiceBase.SetNotificationLogInformation

(

NotificationLogInfo

logInfo

)

Setup notification log. All new events will be logged based on this setting, possibly changing log.

Parameters

logInfo

Log info

Implemented in TPG.GeoFramework.GeoFencingClient.NotificationHandlingServiceClient, and TPG.GeoFramework.GeoFencingService.GeoFencingService.

SetNotificationUserData()

bool TPG.GeoFramework.GeoFencingServiceInterfaces.INotificationHandlingServiceBase.SetNotificationUserData	(	Guid	notificationId,
		UserDataDefinition	userData
	)

Most of the fields in a notifications are locked and cannot be changed. The clients can only modify certain user data by using this method.

Parameters

notificationId	Id of the notification to work on
userData	Userdata to set. If the existing user/key is used, the value is replaced

Returns

"true" on success

Implemented in TPG.GeoFramework.GeoFencingService.GeoFencingService, and TPG.GeoFramework.GeoFencingClient.NotificationHandlingServiceClient.

---

The documentation for this interface was generated from the following file:

• Src/Layers/GeoFencing/TPG.GeoFramework.GeoFencingServiceInterfaces/INotificationHandlingService.cs