Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IAwareness

The awareness interface.

Hierarchy

  • Awareness
    • IAwareness

Implemented by

Index

Properties

Methods

Properties

_checkInterval

_checkInterval: any

_observers

_observers: Map<string, any>

Some desc.

clientID

clientID: number

doc

doc: Doc

meta

meta: Map<number, MetaClientState>

states

states: Map<number, {}>

Maps from client id to client state

Methods

destroy

  • destroy(): void

  • Returns void

emit

  • emit(name: string, args: any[]): void

  • Emit a named event. All registered event listeners that listen to the specified name will receive the event.

    todo

    This should catch exceptions

    Parameters

    • name: string

      The event name.

    • args: any[]

      The arguments that are applied to the event listener.

    Returns void

getLocalState

  • getLocalState(): {}

  • Returns {}

    • [x: string]: any

getStates

  • getStates(): Map<number, {}>

  • Returns Map<number, {}>

off

  • off(name: string, f: Function): void

  • Parameters

    • name: string
    • f: Function

    Returns void

on

  • on(name: string, f: Function): void

  • Parameters

    • name: string
    • f: Function

    Returns void

once

  • once(name: string, f: Function): void

  • Parameters

    • name: string
    • f: Function

    Returns void

setLocalState

  • setLocalState(state: {}): void

  • Parameters

    • state: {}
      • [x: string]: any

    Returns void

setLocalStateField

  • setLocalStateField(field: string, value: any): void

  • Parameters

    • field: string
    • value: any

    Returns void

Generated using TypeDoc