IOnlineGroups::RemoveUser

Kick a user from the group OR decline a petition OR rescind an invitation (success always results in the user's role becoming Unaffiliated).

Windows
MacOS
Linux

References

Module

OnlineSubsystem

Header

/Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineGroupsInterface.h

Include

#include "Interfaces/OnlineGroupsInterface.h"

Syntax

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

Remarks

Kick a user from the group OR decline a petition OR rescind an invitation (success always results in the user's role becoming Unaffiliated).

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 remove from the group.

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