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::QueryGroupRoster

Light Theme

Dark Theme

IOnlineGroups::QueryGroupRoster

Get the list of members for a group and their role info.

Windows

MacOS

Linux

References

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

Syntax

void QueryGroupRoster
(
    const FUniqueNetId & ContextUserId,
    const FUniqueNetId & GroupId,
    const FOnGroupsRequestCompleted & OnCompleted
)

Remarks

Get the list of members for a group and their role info. When the OnCompleted callback fires, if it succeeded you can use GetCachedGroupRoster to retrieve the membership information.

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
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