Convergence JavaScript Client API Documentation 1.0.0-rc.12
Dev Guide
Options
Menu

Class ModelClosedEvent

The ModelClosedEvent is fired when a Model is closed either by the client or the server.

Hierarchy

  • ModelClosedEvent

Implements

Index

Properties

Properties

local

local: boolean

True if this event was triggered locally.

name

name: string = ModelClosedEvent.NAME

The name of the event that was fired. This is commonly used to filter when using the ConvergenceEventEmitter.events stream.

Note that the name is only guaranteed to be unique within the class / subsystem that is firing it. Names might be reused across classes and subsystems.

reason

reason: string

src

src: ObservableModel

The RealTimeModel or HistoricalModel that was closed.

NAME

NAME: "closed" = "closed"