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

Class StringSetValueEvent

Emitted when the RealTimeString.value of a RealTimeString is set.

Hierarchy

  • StringSetValueEvent

Implements

Index

Properties

Properties

element

element: ObservableString

The RealTimeString or HistoricalString which was modified

local

local: boolean

name

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

user: DomainUser

The user which performed the modification

NAME

NAME: "value" = "value"