IOnlineGroups::QueryGroupInfo

Ask the server for GroupInfo corresponding to the provided group ID.

Windows
MacOS
Linux

References

Module

OnlineSubsystem

Header

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

Include

#include "Interfaces/OnlineGroupsInterface.h"

Syntax

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

Remarks

Ask the server for GroupInfo corresponding to the provided group ID. If this completes successfully, you can call GetCachedGroupInfo to get the full group information. Even if the group info is currently cached, this function will contact the server (ostensibly to refresh the cache).

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

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