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 > API/Plugins/OnlineSubsystem/Interfaces

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

  Type Name Description
Public variable FOnGroupUpdated OnGroupUpdated  

Constructors

  Type Name Description
Protected function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

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

 Accept a pending invite to join a group.
Public function void

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

 Accept a user request to join the group.
Public function void

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

 Ban a user from joining the specified group.
Public function void

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

 Cancels an invitation to join the group.
Public function void

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

 Cancel pending request to join the given group.
Public function void

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

 Create a new group using the specified GroupInfo.
Public function void

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

 Decline a pending invite to join a group.
Public function void

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

 Decline a user request to join the group.
Public function void

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

 Delete a group entirely.
Public function void

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

 Demote an Admin to a Member within the specified group.
Public function void

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

 Find all groups matching the specified search string
Public function TSharedPtr< const IApplications >

GetCachedApplications ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& UserId
)

 Get cached pending application information (if it exists).
Public function TSharedPtr< const FGroupConfigEntryBool >

GetCachedConfigBool ( const FString& Key
)

 Get the result of a previous configuration query. Only the member queried for will be valid.
Public function TSharedPtr< const FGroupConfigEntryInt >

GetCachedConfigInt ( const FString& Key
)

 Get the result of a previous configuration query. Only the member queried for will be valid.
Public function TSharedPtr< const IGroupDenylist >

GetCachedGroupDenylist ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& GroupId
)

 Get the cached list of users banned from this group.
Public function TSharedPtr< const IGroupInfo >

GetCachedGroupInfo ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& GroupId
)

 Get the group info for a group that has been previously queried.
Public function TSharedPtr< const IGroupInvites >

GetCachedGroupInvites ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& GroupId
)

 Get the cached list of outstanding invites to a group.
Public function TSharedPtr< const IGroupRequests >

GetCachedGroupRequests ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& GroupId
)

 Get the cached list of users requesting to becoming members of a group.
Public function TSharedPtr< const IGroupRoster >

GetCachedGroupRoster ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& GroupId
)

 Get the cached Roster (membership) information for a group.
Public function TSharedPtr< const IInvitations >

GetCachedInvitations ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& UserId
)

 Get cached pending invitation information (if it exists).
Public function TSharedPtr< const IUserMembership >

GetCachedUserMembership ( const FUniqueNetId& ContextUserId,
const FUniqueNetId& UserId
)

 Get cached user membership information (if it exists).
Public function Const const FString &  
Public function void

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

 Invite a user to join the specified group.
Public function Virtual void

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

 Invite a user to join the specified group.
Public function void

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

 Submit a request to join the specified group.
Public function void

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

 Tells the server to remove the context user from the specified group.
Public function 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.
Public function void

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

 Queries the system configuration for system-wide group max membership headcount.
Public function void

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

 Queries the system configuration for system-wide user max membership count.
Public function void

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

 Get the list of users banned from this group.
Public function void

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

 Ask the server for GroupInfo corresponding to the provided group ID.
Public function void

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

 Get the list of outstanding invites to a group.
Public function void

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

 Ask the server if the given group name currently exists.
Public function void

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

 Get the list of users requesting to becoming members of a group.
Public function void

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

 Get the list of members for a group and their role info.
Public function 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.
Public function 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.
Public function 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.
Public function void

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

 Queries the server for a list of group invitations the user has sent.
Public function void

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

 Queries the server for updated membership information for a particular user.
Public function 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).
Public function void

SetNamespace ( const FString& Ns
)

  
Public function 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.
Public function void

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

 Remove a user from the group's denylist list.
Public function 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.

Typedefs

Name Description
FOnGroupUpdated Delegate fired when a group is updated.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page