Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LocalModelReference<V, R>

Type parameters

Hierarchy

Index

Properties

Static Events

Events: ModelReferenceEvents = ModelReference.Events

Methods

addListener

clear

  • clear(): void
  • Returns void

dispose

  • dispose(): void
  • Returns void

events

  • Provides the events emitted by this object as an Observable stream.

    example
    
    eventEmitter.events()
      .filter(e => e.name === "myevent")
      .subscribe(e => console.log(e));

    Returns Observable<IConvergenceEvent>

    An Observable stream of all events emitted by this object.

isDisposed

  • isDisposed(): boolean
  • Returns boolean

isLocal

  • isLocal(): boolean
  • Returns boolean

isSet

  • isSet(): boolean
  • Returns boolean

isShared

  • isShared(): boolean
  • Returns boolean

key

  • key(): string
  • Returns string

off

on

once

  • Adds a single shot event listener for the specified event. The listener will be called the first time the specified event is fired after the event registration occurs, after which the registration will be removed and no further events will be passed to the listener.

    Parameters

    Returns ConvergenceEventEmitter<IConvergenceEvent>

    This object, in support of a fluent API.

reference

  • reference(): R
  • Returns R

removeAllListeners

removeListener

removeListeners

sessionId

  • sessionId(): string
  • Returns string

set

  • set(value: V): void
  • set(value: V[]): void
  • Parameters

    • value: V

    Returns void

  • Parameters

    • value: V[]

    Returns void

share

  • share(): void
  • Returns void

source

type

  • type(): string
  • Returns string

unshare

  • unshare(): void
  • Returns void

user

value

  • value(): V
  • Returns V

values

  • values(): V[]
  • Returns V[]