Class ForeignHandler

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

Hierarchy

ForeignHandler

Implements

IDisposable

Index

Interfaces

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ForeignHandler(options: IOptions): ForeignHandler

- Defined in foreign.ts:22
Construct a new foreign message handler.

Parameters
- options: IOptions
Returns ForeignHandler

Properties

Private _enabled

_enabled: boolean = false

Private _isDisposed

_isDisposed: boolean = false

Private _parent

_parent: IReceiver

session

session: IClientSession

The client session used by the foreign handler.

Accessors

enabled

get enabled(): boolean
set enabled(value: boolean): void

- Defined in foreign.ts:35
Set whether the handler is able to inject foreign cells into a console.

Returns boolean
- Defined in foreign.ts:38
Set whether the handler is able to inject foreign cells into a console.

Parameters
- value: boolean
Returns void

isDisposed

get isDisposed(): boolean

- Defined in foreign.ts:57
Test whether the handler is disposed.

Returns boolean

parent

get parent(): IReceiver

- Defined in foreign.ts:50
The foreign handler's parent receiver.

Returns IReceiver

Methods

Private _newCell

_newCell(parentMsgId: string): CodeCell

- Defined in foreign.ts:139
Create a new code cell for an input originated from a foreign session.

Parameters
- parentMsgId: string
Returns CodeCell

dispose

dispose(): void

- Defined in foreign.ts:64
Dispose the resources held by the handler.

Returns void

Protected onIOPubMessage

onIOPubMessage(sender: IClientSession, msg: IIOPubMessage): boolean

- Defined in foreign.ts:78
Handler IOPub messages.

Parameters
- sender: IClientSession
- msg: IIOPubMessage
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.

Generated using TypeDoc