Options
Menu

Class ObjectRemoveEvent

Emitted when a key-value pair is removed from a RealTimeObject.

Hierarchy

  • ObjectRemoveEvent

Implements

Index

Properties

element

A read-only representation of the RealTimeObject which was modified

key

key: string

The key of the key-value pair that was removed

local

local: boolean

name

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

A read-only representation of the value of the key-value-pair that was removed

sessionId

sessionId: string

The sessionId corresponding to the session that performed the modification

user

The user which performed the modification

StaticNAME

NAME: "remove" = "remove"