Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SessionEventStream

The stream to receive for session event listener notifications.

This is used along with addSessionEventListener to obtain notifications for client sessions.

since

6.11

Hierarchy

  • SessionEventStream

Index

Methods

onClose

  • onClose(): void
  • Notification that a stream context was closed normally.

    No further calls will be made for the stream context.

    Returns void

onError

  • Notification of a contextual error related to this callback. This is analogous to an exception being raised. Situations in which onError is called include the session being closed, a communication timeout, or a problem with the provided parameters. No further calls will be made to this callback for the call context.

    Parameters

    • errorReason: ErrorReasonType

      a value representing the error; this can be one of constants defined in ErrorReason, or a feature-specific reason

    Returns void

onSessionEvent

  • Notification of a session event.

    Parameters

    Returns void