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

Light Theme

Dark Theme

IOnlineGroups::InviteUser

Invite a user to join 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 InviteUser
(
    const FUniqueNetId & ContextUserId,
    const FUniqueNetId & GroupId,
    const FUniqueNetId & UserId,
    bool bAllowBlocked,
    const FOnGroupsRequestCompleted & OnCompleted
)

Remarks

Invite a user to join the specified group.

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 add to the group.
bAllowBlocked	If true, if the user is on the group's blacklist, the user will be unblocked before creating the invite. Otherwise adding a blocked user will fail.
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