Interface FilteredResponseHandler

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

Hierarchy

FilteredResponseHandler

Index

Methods

Methods

Optional onClose

onClose(): void

- Defined in features/messages.ts:462
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

- Defined in features/messages.ts:456
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

- Defined in features/messages.ts:434
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

- Defined in features/messages.ts:442
Called when a response from a session results in an error.

Parameters
- sessionId: SessionId
  
  sessionID of the session in error
- error: Error
Returns void