Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FilteredResponseHandler

Interface which specifies a response handler for requests dispatched through a filter.

Hierarchy

  • FilteredResponseHandler

Index

Methods

Optional onClose

  • onClose(): void
  • deprecated

    since 6.6 this method is not called and will be removed in a future release

    Returns void

Optional onError

  • onError(error: Error): void
  • Notification of a contextual error related to this handler. This is analogous to an Error being thrown. 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.

    deprecated

    since 6.6 this method is no longer called and will be removed in a future release

    Parameters

    • error: Error

      the error

    Returns void

onResponse

  • onResponse(sessionId: SessionId, response: any): void
  • Called to indicate a response has been received.

    function

    Session.messages.FilteredResponseHandler.onResponse

    Parameters

    • sessionId: SessionId

      session ID of the session that sent the response

    • response: any

      response object

    Returns void

onResponseError

  • onResponseError(sessionId: SessionId, error: Error): void
  • Called when a response from a session results in an error.

    Parameters

    • sessionId: SessionId

      sessionID of the session in error

    • error: Error

    Returns void