Members
-
<static, readonly> CloseReason :CloseReason
-
Enum representing the reason that the session has been closed.
Type:
Properties:
Name Type Default Description CLOSED_BY_CLIENT
CloseReason The session has been closed by the client. CLOSED_BY_SERVER
CloseReason The session has been closed by the server, or another session using the session.clients feature. RECONNECT_ABORTED
CloseReason Whilst disconnected, the client explicitly aborted a reconnect attempt/ CONNECTION_TIMEOUT
CloseReason The connection attempt timed out. HANDSHAKE_REJECTED
CloseReason The connection handshake was rejected by the server. HANDSHAKE_ERROR
CloseReason There was an error parsing the handshake response - usually indicative of incompatible protocol versions. TRANSPORT_ERROR
CloseReason There was an unexpected error with the network connection. CONNECTION_ERROR
CloseReason A connection to the server was unable to be established. IDLE_CONNECTION
CloseReason The client detected that the connection was idle. LOST_MESSAGES
CloseReason Message loss after reconnection has been detected. ACCESS_DENIED
CloseReason The connection attempt failed due to a security restraint. -
<static, readonly> PropertyKeys
-
Enum containing standard session property keys
Properties:
Name Type Default Description ALL_FIXED_PROPERTIES
["*F"] This constant can be used instead of a property key in requests for session property values to indicate that all fixed session properties are required. ALL_USER_PROPERTIES
["*U"] This constant can be used instead of a property key in requests for session property values to indicate that all user defined session properties are required. ALL_PROPERTIES
["*F","*U"] This constant can be used instead of a property key in requests for session property values to indicate that all session properties are required. Examples
// Get the ALL_FIXED_PROPERTIES key var props = diffusion.clients.PropertyKeys.ALL_FIXED_PROPERTIES;
// Get all user and fixed properties var props = diffusion.clients.PropertyKeys.ALL_FIXED_PROPERTIES .concat(diffusion.clients.PropertyKeys.ALL_USER_PROPERTIES);