SDKsHarmonyOSEnterprise

Set group join verification

Configure the approval policy required when users apply or are invited to join a group.

The GroupNeedVerification enum controls group join and invitation verification policies:

Code example

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

const request: SetGroupInfoReq = {
  groupID: groupID,
  needVerification: GroupNeedVerification.AllNeedVerification,
};
await sdk.setGroupInfo(request);

Parameters

Parameter	Type	Required	Description
`groupID`	`string`	Yes	Target group identifier.
`needVerification`	`GroupNeedVerification`	Yes	Group join verification policy enum value.

Option	Value	Description
`GroupNeedVerification.ApplyNeedVerificationInviteDirectly`	`0`	Applications require approval; member invitations join directly.
`GroupNeedVerification.AllNeedVerification`	`1`	Applications and regular member invitations require approval; owner and admin invites join directly.
`GroupNeedVerification.DirectAccess`	`2`	Anyone can join directly without review.

Return value

Returns a Promise that resolves to void when the policy is saved.

Client applications should adapt join buttons and prompts according to this policy, but the server always performs authoritative enforcement. Once the Promise resolves, the SDK fires EventOnGroupInfoChanged. Update the group's needVerification property matched by groupID, as detailed in Group overview.

Was this page helpful?

Code example

Parameters

Return value

State changes after the call