OpenIMDocs

Type at least two characters to search titles and routes.

EN

Language

ENEnglishEnglish docs简中简体中文中文文档
Browse SDKs · WASM
SDKsWASM

Subscribe to online status

Subscribe to the online status of selected users.

Copy

Online status indicates only whether a user is connected to OpenIMServer. Subscribe only to users visible in the current interface. Each account can subscribe to at most 3,000 users.

const { data: states } = await openimsdk.subscribeUsersStatus(
  [...new Set(visibleUserIDs.filter(Boolean))],
);

After the Promise succeeds, data contains the current UserOnlineState[] for those users. Subsequent changes arrive through OnUserStatusChanged. Do not subscribe to the entire user directory at once.

Online status fields

FieldTypeDescription
userIDstringThe user whose status this is, and the merge key for the status cache.
statusOnlineStateAggregate online status. OnlineState.Online means online and OnlineState.Offline means offline.
platformIDsPlatform[]Platforms on which the user is currently online. Do not infer a particular device when the field is missing or empty.

Online status reflects only the connection to OpenIMServer. It does not mean that the user is currently viewing the application, a conversation, or a message.

Listen for online status changes

This page owns the complete OnUserStatusChanged listener. Merge both the initial snapshot and subsequent events by userID.

import { CbEvents } from '@openim/wasm-client-sdk';

const handleStatusChanged = ({ data }) => {
  presenceByUserID.set(data.userID, data);
};

openimsdk.on(CbEvents.OnUserStatusChanged, handleStatusChanged);

function removeStatusListener() {
  openimsdk.off(CbEvents.OnUserStatusChanged, handleStatusChanged);
}

Call removeStatusListener() when signing out, switching accounts, or destroying the online-status state layer.