Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ForeignHandler

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

Hierarchy

  • ForeignHandler

Implements

  • IDisposable

Index

Constructors

constructor

  • Construct a new foreign message handler.

    Parameters

    Returns ForeignHandler

Properties

Private _enabled

_enabled: any

Private _isDisposed

_isDisposed: any

Private _newCell

_newCell: any

Create a new code cell for an input originated from a foreign session.

Private _parent

_parent: any

Readonly sessionContext

sessionContext: ISessionContext

The client session used by the foreign handler.

Accessors

enabled

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

    Returns boolean

  • Set whether the handler is able to inject foreign cells into a console.

    Parameters

    • value: boolean

    Returns any

isDisposed

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

    Returns boolean

parent

  • The foreign handler's parent receiver.

    Returns IReceiver

Methods

dispose

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

    Returns void

Protected onIOPubMessage

  • Handler IOPub messages.

    Parameters

    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