api/org.jetbrains.kotlinx.jupyter.api.libraries/CommManager

CommManager

interface CommManager

Manages custom messages in the notebook, for more info see https://jupyter-client.readthedocs.io/en/latest/messaging.html#custom-messages

Functions

Link copied to clipboard
abstract fun closeComm(id: String, data: JsonObject = Json.EMPTY)

Closes a comm with a given ID. Sends comm_close request to frontend

Link copied to clipboard
abstract fun getComms(target: String? = null): Collection<Comm>

Get all comms for a given target, or all opened comms if target is null

Link copied to clipboard
abstract fun openComm(target: String, data: JsonObject = Json.EMPTY): Comm

Creates a comm with a given target, generates unique ID for it. Sends comm_open request to frontend

Link copied to clipboard
abstract fun registerCommTarget(target: String, callback: CommOpenCallback)

Register a callback for comm_open with a specified target. Overrides already registered callback.

Link copied to clipboard
abstract fun unregisterCommTarget(target: String)

Unregister target callback