Class AwarenessAdapter

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

Implements

AwarenessProvider

Index

Constructors

Properties

clientId ephemeralStore localState updateListeners

Methods

decodeRemoteState dispose encodeLocalState getLocalState getStates notifyListeners off on setLocalState setLocalStateField updateEphemeralStore

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

Properties

`Private` `Readonly`clientId

clientId: number

`Private` `Readonly`ephemeralStore

ephemeralStore: EphemeralStore

`Private`localState

localState: UserState = null

`Private`updateListeners

updateListeners: Set<() => void> = ...

Methods

decodeRemoteState

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

dispose

dispose(): void
Clean up resources

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

encodeLocalState

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

Returns Uint8Array
- Defined in webview/services/loro/awarenessAdapter.ts:144

getLocalState

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

Returns UserState
Implementation of AwarenessProvider.getLocalState
- Defined in webview/services/loro/awarenessAdapter.ts:64

getStates

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

Returns Map<number, UserState>
Implementation of AwarenessProvider.getStates
- Defined in webview/services/loro/awarenessAdapter.ts:71

`Private`notifyListeners

notifyListeners(): void
Notify all update listeners

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

off

off(type: "update", cb: () => void): void
Unregister update listener
Parameters
- type: "update"
- cb: () => void
Returns void
Implementation of AwarenessProvider.off
- Defined in webview/services/loro/awarenessAdapter.ts:135

on

on(type: "update", cb: () => void): void
Register update listener
Parameters
- type: "update"
- cb: () => void
Returns void
Implementation of AwarenessProvider.on
- Defined in webview/services/loro/awarenessAdapter.ts:126

setLocalState

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

setLocalStateField

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

`Private`updateEphemeralStore

updateEphemeralStore(): void
Update the ephemeral store with current local state

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