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

Light Theme

Dark Theme

IOnlineGroups

Interface definition for the online teams (groups) service Groups are collections of users with an owner and a set of administrators

Windows

MacOS

Linux

References

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

Syntax

class IOnlineGroups

Remarks

Interface definition for the online teams (groups) service Groups are collections of users with an owner and a set of administrators

Variables

		Name	Description
	FOnGroupUpdated	OnGroupUpdated

Constructors

	Name	Description
	IOnlineGroups()

Destructors

	Name	Description
	~IOnlineGroups()

Functions

	Name	Description
void	AcceptInvite ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId, const FOnGroupsRequestCompleted& O... )	Accept a pending invite to join a group.
void	AcceptUser ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId, const FUniqueNetId& UserId, const FOnGroupsRequestCompleted& O... )	Accept a user request to join the group.
void	BlockUser ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId, const FUniqueNetId& UserId, const FOnGroupsRequestCompleted& O... )	Ban a user from joining the specified group.
void	CancelInvite ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId, const FUniqueNetId& UserId, const FOnGroupsRequestCompleted& O... )	Cancels an invitation to join the group.
void	CancelRequest ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId, const FOnGroupsRequestCompleted& O... )	Cancel pending request to join the given group.
void	CreateGroup ( const FUniqueNetId& ContextUserId, const FGroupDisplayInfo& GroupInfo, const FOnGroupsRequestCompleted& O... )	Create a new group using the specified GroupInfo.
void	DeclineInvite ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId, const FOnGroupsRequestCompleted& O... )	Decline a pending invite to join a group.
void	DeclineUser ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId, const FUniqueNetId& UserId, const FOnGroupsRequestCompleted& O... )	Decline a user request to join the group.
void	DeleteGroup ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId, const FOnGroupsRequestCompleted& O... )	Delete a group entirely.
void	DemoteUser ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId, const FUniqueNetId& UserId, const FOnGroupsRequestCompleted& O... )	Demote an Admin to a Member within the specified group.
void	FindGroups ( const FUniqueNetId& ContextUserId, const FGroupSearchOptions& SearchO..., const FOnFindGroupsCompleted& OnCo... )	Find all groups matching the specified search string
TSharedPtr< ...	GetCachedApplications ( const FUniqueNetId& ContextUserId, const FUniqueNetId& UserId )	Get cached pending application information (if it exists).
TSharedPtr< ...	GetCachedConfigBool ( const FString& Key )	Get the result of a previous configuration query. Only the member queried for will be valid.
TSharedPtr< ...	GetCachedConfigInt ( const FString& Key )	Get the result of a previous configuration query. Only the member queried for will be valid.
TSharedPtr< ...	GetCachedGroupBlacklist ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId )	Get the cached list of users banned from this group.
TSharedPtr< ...	GetCachedGroupInfo ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId )	Get the group info for a group that has been previously queried.
TSharedPtr< ...	GetCachedGroupInvites ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId )	Get the cached list of outstanding invites to a group.
TSharedPtr< ...	GetCachedGroupRequests ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId )	Get the cached list of users requesting to becoming members of a group.
TSharedPtr< ...	GetCachedGroupRoster ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId )	Get the cached Roster (membership) information for a group.
TSharedPtr< ...	GetCachedInvitations ( const FUniqueNetId& ContextUserId, const FUniqueNetId& UserId )	Get cached pending invitation information (if it exists).
TSharedPtr< ...	GetCachedUserMembership ( const FUniqueNetId& ContextUserId, const FUniqueNetId& UserId )	Get cached user membership information (if it exists).
const FStrin...	GetNamespace()
void	InviteUser ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId, const FUniqueNetId& UserId, bool bAllowBlocked, const FOnGroupsRequestCompleted& O... )	Invite a user to join the specified group.
void	InviteUser ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId, const FUniqueNetId& UserId, const FOnGroupsRequestCompleted& O... )	Invite a user to join the specified group.
void	JoinGroup ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId, const FOnGroupsRequestCompleted& O... )	Submit a request to join the specified group.
void	LeaveGroup ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId, const FOnGroupsRequestCompleted& O... )	Tells the server to remove the context user from the specified group.
void	PromoteUser ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId, const FUniqueNetId& UserId, const FOnGroupsRequestCompleted& O... )	Promote a Member to an Admin within the specified group. Fails if the user's role is not Member.
void	QueryConfigHeadcount ( const FUniqueNetId& ContextUserId, const FOnGroupsRequestCompleted& O... )	Queries the system configuration for system-wide group max membership headcount.
void	QueryConfigMembership ( const FUniqueNetId& ContextUserId, const FOnGroupsRequestCompleted& O... )	Queries the system configuration for system-wide user max membership count.
void	QueryGroupBlacklist ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId, const FOnGroupsRequestCompleted& O... )	Get the list of users banned from this group.
void	QueryGroupInfo ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId, const FOnGroupsRequestCompleted& O... )	Ask the server for GroupInfo corresponding to the provided group ID.
void	QueryGroupInvites ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId, const FOnGroupsRequestCompleted& O... )	Get the list of outstanding invites to a group.
void	QueryGroupNameExist ( const FUniqueNetId& ContextUserId, const FString& GroupName, const FOnGroupsRequestCompleted& O... )	Ask the server if the given group name currently exists.
void	QueryGroupRequests ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId, const FOnGroupsRequestCompleted& O... )	Get the list of users requesting to becoming members of a group.
void	QueryGroupRoster ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId, const FOnGroupsRequestCompleted& O... )	Get the list of members for a group and their role info.
void	QueryIncomingApplications ( const FUniqueNetId& ContextUserId, const FUniqueNetId& UserId, const FOnGroupsRequestCompleted& O... )	Queries the server for a list of membership applications that UserId can process (accept, reject, or block) as group admin.
void	QueryIncomingInvitations ( const FUniqueNetId& ContextUserId, const FUniqueNetId& UserId, const FOnGroupsRequestCompleted& O... )	Queries the server for a list of groups to which the user has been invited.
void	QueryOutgoingApplications ( const FUniqueNetId& ContextUserId, const FUniqueNetId& UserId, const FOnGroupsRequestCompleted& O... )	Queries the server for a list of groups to which the user has applied for membership.
void	QueryOutgoingInvitations ( const FUniqueNetId& ContextUserId, const FUniqueNetId& UserId, const FOnGroupsRequestCompleted& O... )	Queries the server for a list of group invitations the user has sent.
void	QueryUserMembership ( const FUniqueNetId& ContextUserId, const FUniqueNetId& UserId, const FOnGroupsRequestCompleted& O... )	Queries the server for updated membership information for a particular user.
void	RemoveUser ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId, const FUniqueNetId& UserId, const FOnGroupsRequestCompleted& O... )	Kick a user from the group OR decline a petition OR rescind an invitation (success always results in the user's role becoming Unaffiliated).
void	SetNamespace ( const FString& Ns )
void	TransferGroup ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId, const FUniqueNetId& NewOwnerId, const FOnGroupsRequestCompleted& O... )	Promote an existing Admin to be the new Owner and simultaneously demotes the context user to Admin.
void	UnblockUser ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId, const FUniqueNetId& UserId, const FOnGroupsRequestCompleted& O... )	Remove a user from the group's blacklist list.
void	UpdateGroupInfo ( const FUniqueNetId& ContextUserId, const FUniqueNetId& GroupId, const FGroupDisplayInfo& GroupInfo, const FOnGroupsRequestCompleted& O... )	Update the user specified fields of the group such as name, description, etc.

Typedefs

Name	Description
FOnGroupUpdated	Delegate fired when a group is updated.

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

Take our survey

Dismiss