Class AwarenessAdapter

Adapter that wraps Loro's EphemeralStore to provide awareness functionality.

Implements

AwarenessProvider

Index

Constructors

Methods

decodeRemoteState dispose encodeLocalState getLocalState getStates off on setLocalState setLocalStateField

Constructors

constructor

new AwarenessAdapter(
    doc: LoroDoc,
    userName: string,
    userColor: string,
    ephemeralStore?: EphemeralStore,
): AwarenessAdapter
Parameters
- doc: LoroDoc
- userName: string
- userColor: string
- OptionalephemeralStore: EphemeralStore
Returns AwarenessAdapter
- Defined in webview/services/loro/awarenessAdapter.ts:29

Methods

decodeRemoteState

decodeRemoteState(bytes: Uint8Array): void
Decode and apply remote ephemeral state from bytes (uses Loro's native decoding).
Parameters
- bytes: Uint8Array
  Encoded ephemeral state from remote peer.
Returns void
- Defined in webview/services/loro/awarenessAdapter.ts:171

dispose

dispose(): void
Clean up resources.

Returns void
- Defined in webview/services/loro/awarenessAdapter.ts:187

encodeLocalState

encodeLocalState(): Uint8Array
Encode all ephemeral state to bytes for transmission (uses Loro's native encoding).

Returns Uint8Array
Encoded ephemeral state as byte array.
- Defined in webview/services/loro/awarenessAdapter.ts:154

getLocalState

getLocalState(): UserState
Get the local user's awareness state.

Returns UserState
Current local awareness state or null.
Implementation of AwarenessProvider.getLocalState
- Defined in webview/services/loro/awarenessAdapter.ts:65

getStates

getStates(): Map<number, UserState>
Get all awareness states from all users.

Returns Map<number, UserState>
Map of client IDs to their awareness states.
Implementation of AwarenessProvider.getStates
- Defined in webview/services/loro/awarenessAdapter.ts:73

off

off(type: "update", cb: () => void): void
Unregister update listener.
Parameters
- type: "update"
  Event type, must be 'update'.
- cb: () => void
  Callback to remove from listeners.
Returns void
Implementation of AwarenessProvider.off
- Defined in webview/services/loro/awarenessAdapter.ts:144

on

on(type: "update", cb: () => void): void
Register update listener.
Parameters
- type: "update"
  Event type, must be 'update'.
- cb: () => void
  Callback invoked when awareness state updates.
Returns void
Implementation of AwarenessProvider.on
- Defined in webview/services/loro/awarenessAdapter.ts:133

setLocalState

setLocalState(state: UserState): void
Set the entire local state.
Parameters
- state: UserState
  New awareness state for the local user.
Returns void
Implementation of AwarenessProvider.setLocalState
- Defined in webview/services/loro/awarenessAdapter.ts:103

setLocalStateField

setLocalStateField(field: string, value: unknown): void
Update a specific field in the local state.
Parameters
- field: string
  Name of the state field to update.
- value: unknown
  New value for the field.
Returns void
Implementation of AwarenessProvider.setLocalStateField
- Defined in webview/services/loro/awarenessAdapter.ts:114