Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem > API/Plugins/OnlineSubsystem/IOnlineGroups
Description
Ban a user from joining the specified group.
Any user but team owner can be denylisted including member, invitee, applicant and/or any other user unrelated to the team. Blocking follows "ignore" logic: blocked users shouldn't know for sure that they've been blocked. Blocked user will still be able to apply for membership and cancel pending application even while blocked.
| Name | BlockUser |
| Type | function |
| Header File | /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineGroupsInterface.h |
| Include Path | #include "Interfaces/OnlineGroupsInterface.h" |
void BlockUser
(
const FUniqueNetId & ContextUserId,
const FUniqueNetId & GroupId,
const FUniqueNetId & UserId,
const FOnGroupsRequestCompleted & OnCompleted
)
Parameters
| Name | Remarks |
|---|---|
| ContextUserId | The ID of the user whose credentials are being used to make this call |
| GroupId | The group's globally unique ID |
| UserId | The user to denylist. |
| OnCompleted | This callback is invoked after contacting the server. It is guaranteed to occur (regardless of success/fail) and will not be called before this function returns. |