Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SessionPropertiesListener

The Session Properties Listener interface for receiving session property events. This interface must be implemented by the user, to be registered via ClientControl.setSessionPropertiesListener.

A session properties listener has a lifecycle that reflects the registration state on the server. This is expressed through the callback methods. Once onClose has been called, no further interactions will occur.

Hierarchy

  • SessionPropertiesListener

Index

Methods

onActive

  • onActive(deregister: function): void
  • Called when the listener has been registered at the server and is now active.

    Parameters

    • deregister: function

      a function to call that will deregister and close this handler.

        • (): void
        • Returns void

    Returns void

onClose

  • onClose(): void
  • Called when the listener is deregistered, or the session is closed.

    Returns void

onError

  • onError(error: any): void
  • Notification of a contextual error related to this handler. This is analogous to an unchecked exception being raised. Situations in which onError is called include the session being closed before the handler is registered, a communication timeout, or a problem with the provided parameters. No further calls will be made to this handler.

    since

    5.9

    Parameters

    • error: any

      the error

    Returns void

onSessionClose

  • 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.

    Parameters

    • session: SessionId

      the session identifier

    • properties: SessionProperties

      the map of requested property values

    • reason: __type

      the reason why the session was closed

    Returns void

onSessionEvent

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

    Parameters

    • session: SessionId

      the session identifier

    • type: SessionEventType

      the type of event

    • properties: SessionProperties

      the map of requested property values

    • previous: SessionProperties

      a map of previous values for keys that have changed. This will only contain changed values and not the whole required property set.

    Returns void

onSessionOpen

  • 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 client session that opens whilst the listener is registered.

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

    Parameters

    Returns void