1. Epic GamesDeveloper
  3. IOnlineGroups

IOnlineGroups

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

API > API/Plugins > API/Plugins/OnlineSubsystem

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

   
Name IOnlineGroups
Type class
Header File /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineGroupsInterface.h
Include Path #include "Interfaces/OnlineGroupsInterface.h"

Syntax

class IOnlineGroups

Constructors

Name Remarks Include Path Unreal Specifiers

IOnlineGroups()

   Interfaces/OnlineGroupsInterface.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IOnlineGroups()

   Interfaces/OnlineGroupsInterface.h  

Typedefs

Name Type Remarks Include Path
FOnGroupUpdated TMulticastDelegate_OneParam< void, const FUniqueNetId & > Delegate fired when a group is updated. Interfaces/OnlineGroupsInterface.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnGroupUpdated FOnGroupUpdated   Interfaces/OnlineGroupsInterface.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

 Accept a pending invite to join a group. Interfaces/OnlineGroupsInterface.h  

void AcceptUser ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& GroupId,
const FUniqueNetId& UserId,
const FOnGroupsRequestCompleted& OnCompleted
)

 Accept a user request to join the group. Interfaces/OnlineGroupsInterface.h  

void BlockUser ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& GroupId,
const FUniqueNetId& UserId,
const FOnGroupsRequestCompleted& OnCompleted
)

 Ban a user from joining the specified group. Interfaces/OnlineGroupsInterface.h  

void CancelInvite ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& GroupId,
const FUniqueNetId& UserId,
const FOnGroupsRequestCompleted& OnCompleted
)

 Cancels an invitation to join the group. Interfaces/OnlineGroupsInterface.h  

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

 Cancel pending request to join the given group. Interfaces/OnlineGroupsInterface.h  

void CreateGroup ( const FUniqueNetId& ContextUserId,
const FGroupDisplayInfo& GroupInfo,
const FOnGroupsRequestCompleted& OnCompleted
)

 Create a new group using the specified GroupInfo. Interfaces/OnlineGroupsInterface.h  

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

 Decline a pending invite to join a group. Interfaces/OnlineGroupsInterface.h  

void DeclineUser ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& GroupId,
const FUniqueNetId& UserId,
const FOnGroupsRequestCompleted& OnCompleted
)

 Decline a user request to join the group. Interfaces/OnlineGroupsInterface.h  

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

 Delete a group entirely. Interfaces/OnlineGroupsInterface.h  

void DemoteUser ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& GroupId,
const FUniqueNetId& UserId,
const FOnGroupsRequestCompleted& OnCompleted
)

 Demote an Admin to a Member within the specified group. Interfaces/OnlineGroupsInterface.h  

void FindGroups ( const FUniqueNetId& ContextUserId,
const FGroupSearchOptions& SearchOptions,
const FOnFindGroupsCompleted& OnCompleted
)

 Find all groups matching the specified search string Interfaces/OnlineGroupsInterface.h  

TSharedPtr< const IApplications > GetCachedApplications ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& UserId
)

 Get cached pending application information (if it exists). Interfaces/OnlineGroupsInterface.h  

TSharedPtr< const FGroupConfigEntryBool > GetCachedConfigBool ( const FString& Key
)

 Get the result of a previous configuration query. Only the member queried for will be valid. Interfaces/OnlineGroupsInterface.h  

TSharedPtr< const FGroupConfigEntryInt > GetCachedConfigInt ( const FString& Key
)

 Get the result of a previous configuration query. Only the member queried for will be valid. Interfaces/OnlineGroupsInterface.h  

TSharedPtr< const IGroupDenylist > GetCachedGroupDenylist ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& GroupId
)

 Get the cached list of users banned from this group. Interfaces/OnlineGroupsInterface.h  

TSharedPtr< const IGroupInfo > GetCachedGroupInfo ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& GroupId
)

 Get the group info for a group that has been previously queried. Interfaces/OnlineGroupsInterface.h  

TSharedPtr< const IGroupInvites > GetCachedGroupInvites ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& GroupId
)

 Get the cached list of outstanding invites to a group. Interfaces/OnlineGroupsInterface.h  

TSharedPtr< const IGroupRequests > GetCachedGroupRequests ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& GroupId
)

 Get the cached list of users requesting to becoming members of a group. Interfaces/OnlineGroupsInterface.h  

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

 Get the cached Roster (membership) information for a group. Interfaces/OnlineGroupsInterface.h  

TSharedPtr< const IInvitations > GetCachedInvitations ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& UserId
)

 Get cached pending invitation information (if it exists). Interfaces/OnlineGroupsInterface.h  

TSharedPtr< const IUserMembership > GetCachedUserMembership ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& UserId
)

 Get cached user membership information (if it exists). Interfaces/OnlineGroupsInterface.h  

const FString & GetNamespace()

   Interfaces/OnlineGroupsInterface.h  

void InviteUser ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& GroupId,
const FUniqueNetId& UserId,
bool bAllowBlocked,
const FOnGroupsRequestCompleted& OnCompleted
)

 Invite a user to join the specified group. Interfaces/OnlineGroupsInterface.h  

virtual void InviteUser ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& GroupId,
const FUniqueNetId& UserId,
const FOnGroupsRequestCompleted& OnCompleted
)

 Invite a user to join the specified group. Interfaces/OnlineGroupsInterface.h  

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

 Submit a request to join the specified group. Interfaces/OnlineGroupsInterface.h  

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

 Tells the server to remove the context user from the specified group. Interfaces/OnlineGroupsInterface.h  

void PromoteUser ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& GroupId,
const FUniqueNetId& UserId,
const FOnGroupsRequestCompleted& OnCompleted
)

 Promote a Member to an Admin within the specified group. Fails if the user's role is not Member. Interfaces/OnlineGroupsInterface.h  

void QueryConfigHeadcount ( const FUniqueNetId& ContextUserId,
const FOnGroupsRequestCompleted& OnCompleted
)

 Queries the system configuration for system-wide group max membership headcount. Interfaces/OnlineGroupsInterface.h  

void QueryConfigMembership ( const FUniqueNetId& ContextUserId,
const FOnGroupsRequestCompleted& OnCompleted
)

 Queries the system configuration for system-wide user max membership count. Interfaces/OnlineGroupsInterface.h  

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

 Get the list of users banned from this group. Interfaces/OnlineGroupsInterface.h  

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

 Ask the server for GroupInfo corresponding to the provided group ID. Interfaces/OnlineGroupsInterface.h  

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

 Get the list of outstanding invites to a group. Interfaces/OnlineGroupsInterface.h  

void QueryGroupNameExist ( const FUniqueNetId& ContextUserId,
const FString& GroupName,
const FOnGroupsRequestCompleted& OnCompleted
)

 Ask the server if the given group name currently exists. Interfaces/OnlineGroupsInterface.h  

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

 Get the list of users requesting to becoming members of a group. Interfaces/OnlineGroupsInterface.h  

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

 Get the list of members for a group and their role info. Interfaces/OnlineGroupsInterface.h  

void QueryIncomingApplications ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& UserId,
const FOnGroupsRequestCompleted& OnCompleted
)

 Queries the server for a list of membership applications that UserId can process (accept, reject, or block) as group admin. Interfaces/OnlineGroupsInterface.h  

void QueryIncomingInvitations ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& UserId,
const FOnGroupsRequestCompleted& OnCompleted
)

 Queries the server for a list of groups to which the user has been invited. Interfaces/OnlineGroupsInterface.h  

void QueryOutgoingApplications ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& UserId,
const FOnGroupsRequestCompleted& OnCompleted
)

 Queries the server for a list of groups to which the user has applied for membership. Interfaces/OnlineGroupsInterface.h  

void QueryOutgoingInvitations ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& UserId,
const FOnGroupsRequestCompleted& OnCompleted
)

 Queries the server for a list of group invitations the user has sent. Interfaces/OnlineGroupsInterface.h  

void QueryUserMembership ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& UserId,
const FOnGroupsRequestCompleted& OnCompleted
)

 Queries the server for updated membership information for a particular user. Interfaces/OnlineGroupsInterface.h  

void RemoveUser ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& GroupId,
const FUniqueNetId& UserId,
const FOnGroupsRequestCompleted& OnCompleted
)

 Kick a user from the group OR decline a petition OR rescind an invitation (success always results in the user's role becoming Unaffiliated). Interfaces/OnlineGroupsInterface.h  

void SetNamespace ( const FString& Ns
)

   Interfaces/OnlineGroupsInterface.h  

void TransferGroup ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& GroupId,
const FUniqueNetId& NewOwnerId,
const FOnGroupsRequestCompleted& OnCompleted
)

 Promote an existing Admin to be the new Owner and simultaneously demotes the context user to Admin. Interfaces/OnlineGroupsInterface.h  

void UnblockUser ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& GroupId,
const FUniqueNetId& UserId,
const FOnGroupsRequestCompleted& OnCompleted
)

 Remove a user from the group's denylist list. Interfaces/OnlineGroupsInterface.h  

void UpdateGroupInfo ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& GroupId,
const FGroupDisplayInfo& GroupInfo,
const FOnGroupsRequestCompleted& OnCompleted
)

 Update the user specified fields of the group such as name, description, etc. Interfaces/OnlineGroupsInterface.h  

Protected

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page