Skip to main content

sdk.awarenessstateapi

Home > @kittl/sdk > AwarenessStateApi

AwarenessStateApi type​

Public API for updating the local user's awareness state.

This API only affects the local user; remote users are provided by the collaboration backend via AwarenessState.

Signature:

export type AwarenessStateApi = {
    updateSelfCursor: (cursor: Pick<SingleUser, 'cursor'>) => void;
    updateSelfUser: (user: Partial<Pick<SingleUser, 'userId' | 'profileImage' | 'name'>>) => void;
};

References: SingleUser