Class AwarenessMock

Default user implementation.

Hierarchy

AwarenessMock

Implements

IAwareness

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AwarenessMock(doc: Doc): AwarenessMock

- Defined in packages/collaboration/src/awarenessmock.ts:10
Parameters
- doc: Doc
Returns AwarenessMock

Properties

_checkInterval

_checkInterval: any

_observers

_observers: any

Some desc.

clientID

clientID: number

doc

doc: Doc

meta

meta: Map<any, any> = ...

states

states: Map<any, any> = ...

Maps from client id to client state

Methods

destroy

destroy(): void

Implementation of IAwareness.destroy
- Defined in packages/collaboration/src/awarenessmock.ts:44
Returns void

emit

emit(name: string, args: any): void

Implementation of IAwareness.emit
- Defined in packages/collaboration/src/awarenessmock.ts:41
Emit a named event. All registered event listeners that listen to the specified name will receive the event.

Parameters
- name: string
- args: any
Returns void

getLocalState

getLocalState(): any

Implementation of IAwareness.getLocalState
- Defined in packages/collaboration/src/awarenessmock.ts:24
Returns any

getStates

getStates(): any

Implementation of IAwareness.getStates
- Defined in packages/collaboration/src/awarenessmock.ts:28
Returns any

off

off(name: string, f: any): void

Implementation of IAwareness.off
- Defined in packages/collaboration/src/awarenessmock.ts:35
Parameters
- name: string
- f: any
Returns void

on

on(name: string, f: any): void

Implementation of IAwareness.on
- Defined in packages/collaboration/src/awarenessmock.ts:32
Parameters
- name: string
- f: any
Returns void

once

once(name: string, f: any): void

Implementation of IAwareness.once
- Defined in packages/collaboration/src/awarenessmock.ts:38
Parameters
- name: string
- f: any
Returns void

setLocalState

setLocalState(state: any): void

Implementation of IAwareness.setLocalState
- Defined in packages/collaboration/src/awarenessmock.ts:16
Parameters
- state: any
Returns void

setLocalStateField

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

Implementation of IAwareness.setLocalStateField
- Defined in packages/collaboration/src/awarenessmock.ts:20
Parameters
- field: string
- value: any
Returns void

Generated using TypeDoc