Check group data synchronization

Use checkLocalGroupFullSync() to diagnose local synchronization completeness or decide whether to display a loading indicator. This method does not return group items or initiate a network synchronization cycle:

Code example

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

const response: CheckLocalGroupFullSyncResp = await sdk.checkLocalGroupFullSync();
if (!response.IsFullSync) {
  showGroupSyncingState();
}

Return value

Returns a Promise that resolves to a CheckLocalGroupFullSyncResp object:

State changes after the call

The fixed SDK field is capitalized as IsFullSync. Synchronization states progress asynchronously; listen for synchronization lifecycle events documented in Event listener overview rather than polling this endpoint in tight loops.