ChangeMessage | @jupyterlab (original) (raw)

Hierarchy

• Message
  • ChangeMessage

Index

Constructors

constructor

• new ChangeMessage(
  type: string,
  args: IObservableJSON.IChangedArgs,
  ): ChangeMessage

• Returns ChangeMessage

Properties

Readonlyargs

Readonlytype

type: string

Accessors

isConflatable

• get isConflatable(): boolean

• Returns boolean

Methods

conflate

• conflate(other: Message): boolean

• Returns boolean

true if the message was successfully conflated, orfalse otherwise.

Notes

Message conflation is an advanced topic. Most message types will not make use of this feature.
This method is called automatically by the message loop when the given message is posted to the handler paired with this message. This message will already be enqueued and conflatable, and the given message will have the same type and also be conflatable.
This method should merge the state of the other message into this message as needed so that when this message is finally delivered to the handler, it receives the most up-to-date information.
If this method returns true, it signals that the other message was successfully conflated and that message will not be enqueued.
If this method returns false, the other message will be enqueued for normal delivery.
Custom message types may reimplement this method.
The default implementation always returns false.