Options
Menu

Class StringInsertEvent

Emitted when one or more characters are added to a RealTimeString.

Hierarchy

  • StringInsertEvent

Implements

Index

Properties

element

The RealTimeString or HistoricalString which was modified

index

index: number

The index at which the insertion happened

local

local: boolean

name

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

value

value: string

The substring that was inserted

StaticNAME

NAME: "insert" = "insert"