Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem > API/Plugins/OnlineSubsystem/IOnlineGroups
Description
Tells the server to remove the context user from the specified group. Should always result in the user's role for that group becoming Unaffiliated. Owners cannot leave their group, use TransferGroup (followed by LeaveGroup) or DeleteGroup instead.
| Name | LeaveGroup |
| Type | function |
| Header File | /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineGroupsInterface.h |
| Include Path | #include "Interfaces/OnlineGroupsInterface.h" |
void LeaveGroup
(
const FUniqueNetId & ContextUserId,
const FUniqueNetId & GroupId,
const FOnGroupsRequestCompleted & OnCompleted
)
Parameters
| Name | Remarks |
|---|---|
| ContextUserId | The ID of the user whose credentials are being used to make this call |
| GroupId | The group's globally unique ID |
| 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. |