Interface ISessionPropertiesListener

The handler for session properties listener notifications.

This is used along with SetSessionPropertiesListener(ISessionPropertiesListener, String[]) to obtain notifications for client sessions.

Callbacks with a properties parameter will provide a map of the property values requested when registering the listener.

Inherited Members

IServerHandler.OnRegistered(IRegistration)

IServerHandler.OnClose()

IServerHandler.OnError(ErrorReason)

Namespace: PushTechnology.ClientInterface.Client.Features.Control.Clients

Assembly: Diffusion.Client.dll

Syntax

public interface ISessionPropertiesListener : IServerHandler

Methods

OnSessionClose(ISessionId, IDictionary<String, String>, CloseReason)

Notification that a client session has closed.

This will be called for every client that closes whilst the listener is registered regardless of requested session properties.

Declaration

void OnSessionClose(ISessionId sessionId, IDictionary<string, string> properties, CloseReason closeReason)

Parameters

Type	Name	Description
ISessionId	sessionId	The session identifier of the client that has closed.
IDictionary<System.String, System.String>	properties	The map of requested property values at the point when the session was closed. This can be empty if no properties were requested. If a requested property did not exist then it will not be present in the map.
CloseReason	closeReason	Why the session was closed.

OnSessionEvent(ISessionId, Nullable<SessionPropertiesListenerEventType>, IDictionary<String, String>, IDictionary<String, String>)

Notification of a session event that can result in a change of properties.

Declaration

void OnSessionEvent(ISessionId sessionId, SessionPropertiesListenerEventType? eventType, IDictionary<string, string> properties, IDictionary<string, string> previousValues)

Parameters

Type	Name	Description
ISessionId	sessionId	The client session id.
System.Nullable<SessionPropertiesListenerEventType>	eventType	Indicates the type of event.
IDictionary<System.String, System.String>	properties	The map of current requested property values. This may be empty if no properties were requested.
IDictionary<System.String, System.String>	previousValues	A map of the previous values of keys that have changed. This will only contain keys that have changed and not the whole required property set. This can be empty if an event is being reported that did not result in the change of any of the required properties. When a new property is added then the value in this map will be null. When a property is removed then it will have a value in this map but not in properties.

OnSessionOpen(ISessionId, IDictionary<String, String>)

Notification that a new client session has been opened.

When the listener is registered, this will be called for all existing sessions. It will then be called for every new session that opens whilst the listener is registered.

This will be called for every client session regardless of requested session properties.

Declaration

void OnSessionOpen(ISessionId sessionId, IDictionary<string, string> properties)

Parameters

Type	Name	Description
ISessionId	sessionId	The session identifier.
IDictionary<System.String, System.String>	properties	The map of requested session property values. This can be empty if no properties were requested. If a requested property did not exist then it will not be present in the map.