IOnlineGroups::GetCachedGroupRoster

Get the cached Roster (membership) information for a group.

Windows
MacOS
Linux

References

Module

OnlineSubsystem

Header

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

Include

#include "Interfaces/OnlineGroupsInterface.h"

Syntax

TSharedPtr< const IGroupRoster > GetCachedGroupRoster
(
    const FUniqueNetId & ContextUserId,
    const FUniqueNetId & GroupId
)

Remarks

Get the cached Roster (membership) information for a group. If the information is not cached locally, call QueryGroupRoster to request it from the server. If the context user is a member of this group, the cached roster information will include petitioners and invitees, otherwise it will not.

Returns

Shared pointer to the cached roster structure if one exists

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

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