Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RealTimeModel

Hierarchy

Implements

Index

Properties

Static Events

Events: RealTimeModelEvents = RealTimeModelEventConstants

Methods

addListener

batchSize

  • batchSize(): number
  • Returns number

cancelBatch

  • cancelBatch(): void
  • Returns void

close

  • close(): Promise<void>
  • Returns Promise<void>

collaborators

collaboratorsAsObservable

collectionId

  • collectionId(): string

completeBatch

  • completeBatch(): void
  • Returns void

createdTime

  • createdTime(): Date

elementAt

elementReference

emitLocalEvents

  • emitLocalEvents(): boolean
  • emitLocalEvents(emit: boolean): void
  • Returns boolean

  • Parameters

    • emit: boolean

    Returns void

endBatch

  • endBatch(): void
  • deprecated

    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.

isBatchStarted

  • isBatchStarted(): boolean
  • Returns boolean

isOpen

  • isOpen(): boolean
  • Returns boolean

maxTime

  • maxTime(): Date

maxVersion

  • maxVersion(): number

minTime

  • minTime(): Date

minVersion

  • minVersion(): number

modelId

  • modelId(): 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.

permissions

permissionsManager

reference

  • Parameters

    • sessionId: string
    • key: string

    Returns ModelReference<any>

references

removeAllListeners

removeListener

removeListeners

root

session

startBatch

  • startBatch(): void
  • Returns void

time

  • time(): Date

version

  • version(): number