Maria GDK 4.5.0.137
Documentation of managed code in release branch
Loading...
Searching...
No Matches
TPG.GeoFramework.GeoFencingClient.NotificationHandlingServiceClient Class Reference
Inheritance diagram for TPG.GeoFramework.GeoFencingClient.NotificationHandlingServiceClient:
TPG.ServiceModel.BaseServiceProxy< INotificationHandlingService > TPG.GeoFramework.GeoFencingServiceInterfaces.INotificationHandlingServiceClient TPG.GeoFramework.GeoFencingServiceInterfaces.INotificationHandlingServiceBase TPG.ServiceModel.IBaseServiceProxy

Public Member Functions

 NotificationHandlingServiceClient (Binding binding, EndpointAddress endpoint)
 
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.
 
- Public Member Functions inherited from TPG.ServiceModel.BaseServiceProxy< INotificationHandlingService >
virtual void Connect ()
 
virtual bool Connect (int timeoutMs)
 
virtual void ConnectAndWait ()
 
void ChangeServiceAddress (Binding binding, EndpointAddress endpoint)
 
void Dispose ()
 Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
 
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.
 
- Public Member Functions inherited from TPG.ServiceModel.IBaseServiceProxy
void Connect ()
 Connects to a specific service by using the provided binding and endpoint. Returns immediately and tries to connect in the background.
 
bool Connect (int msTimeout)
 Connects to a specific service by using the provided binding and endpoint. Tries to connect for up to "msTimeout" milliseconds, returns true if successful.
 
void ConnectAndWait ()
 Connects to a specific service by using the provided binding and endpoint.
Tries to connect to the service without returning before a connection is esatablished.
 
void ChangeServiceAddress (Binding binding, EndpointAddress endpoint)
 Change service address during runtime. Proxy users affected by this must subscribe to ServiceAddressChanged event.
 

Additional Inherited Members

- Protected Member Functions inherited from TPG.ServiceModel.BaseServiceProxy< INotificationHandlingService >
 BaseServiceProxy (Binding binding, EndpointAddress endpoint)
 Constructor.
 
void Abort ()
 Causes the service channel to transition immediately from its current state into the closing state.
 
virtual void OnChannelFaulted (object sender, System.EventArgs e)
 Method invoked when the service channel is faulted.
 
virtual void OnChannelClosing (object sender, System.EventArgs e)
 Method invoked when the service channel is closing.
 
virtual void OnChannelClosed (object sender, System.EventArgs e)
 Method invoked when the service channel is closed.
 
RetT DoServiceCall< RetT > (Func< RetT > f, RetT defaultRet, bool externalExceptionHandler=false)
 Function wrapper for performing service calls.
 
void DoServiceCall (Action a, bool externalExceptionHandler=false)
 Function wrapper for performing service calls.
 
virtual void Dispose (bool disposing)
 Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. If overridden, call base.Dispose(disposing) to make sure all base resources are freed.
 
- Protected Attributes inherited from TPG.ServiceModel.BaseServiceProxy< INotificationHandlingService >
ChannelFactory< TServiceClient > _channelFactory
 
TServiceClient ServiceClient
 
- Properties inherited from TPG.ServiceModel.BaseServiceProxy< INotificationHandlingService >
CommunicationState State [get]
 
bool Connected [get, protected set]
 
ServiceState ServiceState [get, protected set]
 
IServiceClientExceptionHandler ExceptionHandler [get, set]
 
bool ValidateServiceSession [get, set]
 
EndpointAddress Endpoint [get]
 
- Properties inherited from TPG.ServiceModel.IBaseServiceProxy
bool Connected [get]
 Get if the client is connected.
 
ServiceState ServiceState [get]
 Get service state.
 
IServiceClientExceptionHandler ExceptionHandler [get, set]
 Exception handler for service client/proxy.
 
bool ValidateServiceSession [get, set]
 Get or set if service session validation is performed before each service call.
 
EndpointAddress Endpoint [get]
 Endpoint address of service.
 
- Events inherited from TPG.ServiceModel.BaseServiceProxy< INotificationHandlingService >
ErrorOccuredEventHandler ErrorOccured
 
ServiceConnectedEventHandler ServiceConnected
 
ServiceRestartedEventHandler ServiceRestarted
 
ServiceAddressChangedEventHandler ServiceAddressChanged
 
- Events inherited from TPG.ServiceModel.IBaseServiceProxy
ErrorOccuredEventHandler ErrorOccured
 Event raised when an error occures.
 
ServiceConnectedEventHandler ServiceConnected
 Event raised when the connection to the service is established.
 
ServiceRestartedEventHandler ServiceRestarted
 Event raised when the service has restarted.
 
ServiceAddressChangedEventHandler ServiceAddressChanged
 Event raised when the service has restarted.
 

Member Function Documentation

◆ GetNotifications()

NotificationQueryResult TPG.GeoFramework.GeoFencingClient.NotificationHandlingServiceClient.GetNotifications ( string  notificationConditionXml,
int  lastKnownGeneration 
)
inline

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

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

Implements TPG.GeoFramework.GeoFencingServiceInterfaces.INotificationHandlingServiceBase.

◆ RestoreNotificationLog()

bool TPG.GeoFramework.GeoFencingClient.NotificationHandlingServiceClient.RestoreNotificationLog ( )
inline

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

Parameters
sourceLogsLogs to restore, the logs are read in sequence
Returns
"true" on success

Implements TPG.GeoFramework.GeoFencingServiceInterfaces.INotificationHandlingServiceBase.

◆ SetNotificationLogInformation()

void TPG.GeoFramework.GeoFencingClient.NotificationHandlingServiceClient.SetNotificationLogInformation ( NotificationLogInfo  logInfo)
inline

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

Parameters
logInfoLog info

Implements TPG.GeoFramework.GeoFencingServiceInterfaces.INotificationHandlingServiceBase.

◆ SetNotificationUserData()

bool TPG.GeoFramework.GeoFencingClient.NotificationHandlingServiceClient.SetNotificationUserData ( Guid  notificationId,
UserDataDefinition  userData 
)
inline

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
notificationIdId of the notification to work on
userDataUserdata to set. If the existing user/key is used, the value is replaced
Returns
"true" on success

Implements TPG.GeoFramework.GeoFencingServiceInterfaces.INotificationHandlingServiceBase.


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