SDKsHarmonyOSEnterprise

Check group member data synchronization

Verify whether local member roster data for a specific group has completed full synchronization.

Check whether member records for a specific group are fully synchronized in local storage:

Code example

import sdk, { CheckGroupMemberFullSyncReq, CheckGroupMemberFullSyncResp } from '@openimsdk/imsdk';

const request: CheckGroupMemberFullSyncReq = { groupID: groupID };
const response: CheckGroupMemberFullSyncResp = await sdk.checkGroupMemberFullSync(request);
if (!response.IsFullSync) {
  showMemberSyncingState();
}

Parameters

Parameter	Type	Required	Description
`groupID`	`string`	Yes	Target group identifier.

Return value

Returns a Promise that resolves to a CheckGroupMemberFullSyncResp object:

Property	Type	Description
`IsFullSync`	`boolean`	`true` indicates all group members are fully synchronized locally; `false` indicates sync is in progress.

State changes after the call

This method does not return member records or trigger synchronization. To load the group roster and track real-time member events, see Paginate group members.

Was this page helpful?