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

Class CollaboratorOpenedEvent

Emitted when a remote user opens a model. This is only emitted if the current user has that particular model already open.

Hierarchy

  • CollaboratorOpenedEvent

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

collaborator

collaborator: ModelCollaborator

The DomainUser / session ID of the remote collaborator.

name

name: string = CollaboratorOpenedEvent.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.

src

src: RealTimeModel

The model that was opened.

NAME

NAME: "collaborator_opened" = "collaborator_opened"