Options
Menu

Class ObjectSetValueEvent

Emitted when the entire RealTimeObject.value of a RealTimeObject is set, meaning its entire contents were replaced, or set initially.

Hierarchy

  • ObjectSetValueEvent

Implements

Index

Properties

element

A read-only representation of the RealTimeObject which was modified

local

local: boolean

name

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

sessionId

sessionId: string

The sessionId corresponding to the session that performed the modification

user

The user which performed the modification

NAME

NAME: "value" = "value"