Class ForeignHandler

A handler for capturing API messages from other sessions that should be rendered in a given parent.

Implements

IDisposable

Index

Constructors

Properties

Accessors

enabled isDisposed parent

Methods

dispose onIOPubMessage

Constructors

constructor

new ForeignHandler(options: ForeignHandler.IOptions): ForeignHandler
Construct a new foreign message handler.
Parameters
- options: ForeignHandler.IOptions
Returns ForeignHandler
- Defined in packages/console/src/foreign.ts:21

Properties

`Readonly`sessionContext

sessionContext: ISessionContext

The client session used by the foreign handler.

Accessors

enabled

get enabled(): boolean
Set whether the handler is able to inject foreign cells into a console.

Returns boolean
- Defined in packages/console/src/foreign.ts:30
set enabled(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/console/src/foreign.ts:33

isDisposed

get isDisposed(): boolean
Test whether the handler is disposed.

Returns boolean
Implementation of IDisposable.isDisposed
- Defined in packages/console/src/foreign.ts:52

parent

get parent(): IReceiver
The foreign handler's parent receiver.

Returns IReceiver
- Defined in packages/console/src/foreign.ts:45

Methods

dispose

dispose(): void
Dispose the resources held by the handler.

Returns void
Implementation of IDisposable.dispose
- Defined in packages/console/src/foreign.ts:59

`Protected`onIOPubMessage

onIOPubMessage(
sender: ISessionContext,
msg: IIOPubMessage<IOPubMessageType>,
): boolean
Handler IOPub messages.
Parameters
- sender: ISessionContext
- msg: IIOPubMessage<IOPubMessageType>
Returns boolean
true if the message resulted in a new cell injection or a previously injected cell being updated and false for all other messages.
- Defined in packages/console/src/foreign.ts:73