Options
Menu

Interface RealTimeModelEvents

The complete list of events that could be emitted by a RealTimeModel.

Hierarchy

Index

Events

CLOSED

CLOSED: string

Emitted when a model is closed locally. The actual event emitted is a ModelClosedEvent.

COLLABORATOR_CLOSED

COLLABORATOR_CLOSED: string

Emitted when another user closes this model. The actual event is a CollaboratorClosedEvent.

COLLABORATOR_OPENED

COLLABORATOR_OPENED: string

Emitted when another user opens this model. The actual event is a CollaboratorOpenedEvent.

COMMITTED

COMMITTED: string

Emitted when the server acknowledges a local modification. Note that multiple modifications may be batched together into a single COMMITTED response from the server. See https://forum.convergence.io/t/behavior-of-model-version/16/4

DELETED

DELETED: string

Emitted when a model is deleted. The actual event emitted is a ModelDeletedEvent.

MODIFIED

MODIFIED: string

Emitted immediately when a local modification is made to a model. The emitted event is an ModelModifiedEvent.

OFFLINE

OFFLINE: string

Emitted when this model goes offline. The actual emitted event is a ModelOfflineEvent.

ONLINE

ONLINE: string

Emitted when this model comes back online after being offline. The actual emitted event is a ModelOfflineEvent.

PERMISSIONS_CHANGED

PERMISSIONS_CHANGED: string

Emitted when the permissions on this model change. The actual emitted event is a ModelPermissionsChangedEvent.

RECONNECTING

RECONNECTING: string

Emitted when the model is attempting to reconnect to the server after being offline. This only has to to with the connection; see RESYNC_STARTED and RESYNC_COMPLETED for data reconciliation events.

The actual emitted event is a ModelReconnectingEvent.

REFERENCE

REFERENCE: string

Emitted when a Remote Reference is created on this model with RealTimeModel.elementReference.

The actual emitted event is a RemoteReferenceCreatedEvent.

REMOTE_RESYNC_COMPLETED

REMOTE_RESYNC_COMPLETED: string

Emitted when a remote client has started a resync . The actual emitted event is a RemoteResyncCompletedEvent.

REMOTE_RESYNC_STARTED

REMOTE_RESYNC_STARTED: string

Emitted when a remote client has started a resync . The actual emitted event is a RemoteResyncStartedEvent.

RESYNC_COMPLETED

RESYNC_COMPLETED: string

Emitted when the resync process ends. The actual emitted event is a ResyncCompletedEvent.

RESYNC_ERROR

RESYNC_ERROR: string

Emitted when the resync process encounters an error. The actual event is a ResyncErrorEvent.

RESYNC_STARTED

RESYNC_STARTED: string

Emitted when the resync process begins. This automatically happens when a client becomes disconnected and accumulates local changes that must be reconciled with the server.

The actual event emitted is a ResyncStartedEvent.

VERSION_CHANGED

VERSION_CHANGED: string

Emitted when the version of this model changes. This could happen from a local or remote change to this model. The actual emitted event is a VersionChangedEvent.