Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > OnlineSubsystem > Interfaces > IOnlineGroups > IOnlineGroups::BlockUser

Light Theme

Dark Theme

IOnlineGroups::BlockUser

Ban a user from joining the specified group.

Windows

MacOS

Linux

References

Module	OnlineSubsystem
Header	/Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineGroupsInterface.h
Include	#include "Interfaces/OnlineGroupsInterface.h"

Syntax

void BlockUser
(
    const FUniqueNetId & ContextUserId,
    const FUniqueNetId & GroupId,
    const FUniqueNetId & UserId,
    const FOnGroupsRequestCompleted & OnCompleted
)

Remarks

Ban a user from joining the specified group.

Any user but team owner can be blacklisted 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.

Parameters

Parameter	Description
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 blacklist.
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.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss