Options
Menu

Class ObjectSetEvent

Emitted when a key-value pair is set on a RealTimeObject.

Hierarchy

  • ObjectSetEvent

Implements

Index

Properties

element

A read-only representation of the RealTimeObject which was modified

key

key: string

The new key that was added.

local

local: boolean

name

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

oldValue

oldValue: ObservableElement<any>

The detached RealTimeElement that used to be key's value, or RealTimeUndefined if this is a new key-value pair.

sessionId

sessionId: string

The sessionId corresponding to the session that performed the modification

user

The user which performed the modification

value

value: ObservableElement<any>

A read-only representation of the value that was added.

StaticNAME

NAME: "set" = "set"