Diffusion JavaScript API 6.2.8

Class: FilteredResponseHandler

Session.messages. FilteredResponseHandler

new FilteredResponseHandler()

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

Methods

onClose()

Called when the filtered response handler is unregistered, or the session is closed.

onError(error)

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.

Parameters:
Name Type Description
error Error

The error

onResponse(sessionId, response)

Called to indicate a response has been received.

Parameters:
Name Type Description
sessionId Object

SessionID of the session that sent the response
response Object

Response object

onResponseError(sessionId, errorReason)

Called when a response from a session results in an error.

Parameters:
Name Type Description
sessionId Object

SessionID of the session in error
errorReason Error

The error reason