public static interface ClientControl.SessionEventStream.Event
Modifier and Type | Interface and Description |
---|---|
static class |
ClientControl.SessionEventStream.Event.State
The session state.
|
static class |
ClientControl.SessionEventStream.Event.Type
The event type.
|
Modifier and Type | Method and Description |
---|---|
Map<String,String> |
changedProperties()
Provides a map of the previous values of session properties that
have changed.
|
ClientControl.CloseReason |
closeReason()
Provides the reason a session was closed.
|
boolean |
isOpenEvent()
Convenience method to determine whether the event notifies the
opening of a new session.
|
Map<String,String> |
properties()
Provides the session's properties.
|
SessionId |
sessionId()
Provides the session identifier of the client session that the
event relates to.
|
ClientControl.SessionEventStream.Event.State |
state()
Provides the current state of the session.
|
ClientControl.SessionEventStream.Event.Type |
type()
Provides the event type.
|
SessionId sessionId()
ClientControl.SessionEventStream.Event.Type type()
ClientControl.SessionEventStream.Event.State state()
boolean isOpenEvent()
This is equivalent to:
event.type() == Type.STATE && event.state() == State.ACTIVE
STATE
and the state is ACTIVE
, otherwise falseMap<String,String> properties()
Only those properties requested when registering the listener will be present in the map.
If no properties were requested or state()
is
CLOSED
the map will be empty.
Map<String,String> changedProperties()
This map will be empty if no session properties were requested or the event did not result in a change of any properties.
This map will only be populated if type()
is
PROPERTIES
or state()
is
RECONNECTED
, FAILED_OVER
, or DISCONNECTED
.
This will only contain keys that have changed and not the whole required property set.
When a new property is added the value in this map will be
null
.
When a property is removed there will be a value in this map but
not in properties()
.
ClientControl.CloseReason closeReason()
Copyright © 2024 DiffusionData Ltd. All Rights Reserved.