description:
Kick off request for sending a chat message privately between users
if successfully started the async operation

code: bool SendPrivateChat ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & RecipientId, const [FString](API\Runtime\Core\Containers\FString) & MsgBody )


description:
Kick off request for sending a chat message to a joined chat room
if successfully started the async operation

module: OnlineSubsystem

code: bool SendRoomChat ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FChatRoomId](API\Plugins\OnlineSubsystem\Interfaces\FChatRoomId) & RoomId, const [FString](API\Runtime\Core\Containers\FString) & MsgBody )


code: virtual void TriggerOnChatPrivateMessageReceivedDelegates ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param1, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FChatMessage](API\Plugins\OnlineSubsystem\Interfaces\FChatMessage) > & Param2 )


code: virtual void TriggerOnChatRoomCreatedDelegates ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param1, const [FChatRoomId](API\Plugins\OnlineSubsystem\Interfaces\FChatRoomId) & Param2, bool Param3, const [FString](API\Runtime\Core\Containers\FString) & Param4 )


code: virtual void TriggerOnChatRoomConfiguredDelegates ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param1, const [FChatRoomId](API\Plugins\OnlineSubsystem\Interfaces\FChatRoomId) & Param2, bool Param3, const [FString](API\Runtime\Core\Containers\FString) & Param4 )


code: virtual void TriggerOnChatRoomJoinPublicDelegates ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param1, const [FChatRoomId](API\Plugins\OnlineSubsystem\Interfaces\FChatRoomId) & Param2, bool Param3, const [FString](API\Runtime\Core\Containers\FString) & Param4 )


code: virtual void TriggerOnChatRoomJoinPrivateDelegates ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param1, const [FChatRoomId](API\Plugins\OnlineSubsystem\Interfaces\FChatRoomId) & Param2, bool Param3, const [FString](API\Runtime\Core\Containers\FString) & Param4 )


code: virtual void TriggerOnChatRoomMemberJoinDelegates ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param1, const [FChatRoomId](API\Plugins\OnlineSubsystem\Interfaces\FChatRoomId) & Param2, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param3 )


code: virtual void TriggerOnChatRoomMemberExitDelegates ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param1, const [FChatRoomId](API\Plugins\OnlineSubsystem\Interfaces\FChatRoomId) & Param2, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param3 )


code: virtual void TriggerOnChatRoomMemberUpdateDelegates ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param1, const [FChatRoomId](API\Plugins\OnlineSubsystem\Interfaces\FChatRoomId) & Param2, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param3 )


code: virtual void TriggerOnChatRoomMessageReceivedDelegates ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param1, const [FChatRoomId](API\Plugins\OnlineSubsystem\Interfaces\FChatRoomId) & Param2, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FChatMessage](API\Plugins\OnlineSubsystem\Interfaces\FChatMessage) > & Param3 )


code: virtual void TriggerOnChatRoomExitDelegates ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param1, const [FChatRoomId](API\Plugins\OnlineSubsystem\Interfaces\FChatRoomId) & Param2, bool Param3, const [FString](API\Runtime\Core\Containers\FString) & Param4 )


className: IOnlineChat

description: Interface class for user-user and user-room chat

code: class IOnlineChat

OnChatPrivateMessageReceivedDelegates

type: FOnChatPrivateM...

OnChatRoomConfiguredDelegates

type: FOnChatRoomConf...

OnChatRoomCreatedDelegates

type: FOnChatRoomCrea...

description: Delegate callbacks (see declarations above)

OnChatRoomExitDelegates

type: FOnChatRoomExit

OnChatRoomJoinPrivateDelegates

type: FOnChatRoomJoin...

OnChatRoomMemberExitDelegates

type: FOnChatRoomMemb...

OnChatRoomMessageReceivedDelegates

type: FOnChatRoomMess...


description: Initiate the lock code process for reserving a product redemption

code: void LockCode ( const [FString](API\Runtime\Core\Containers\FString) & CodeId, int32 LockTimeoutSeconds, const [FOnProductCodeLockedComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnProductCodeLockedComplete) & Delegate )


code: virtual ~IOnlineCodeRedemption()


description: Initiate the Release code process to clear reservation on a product code

code: void UnlockCode ( const [FString](API\Runtime\Core\Containers\FString) & CodeId, const [FString](API\Runtime\Core\Containers\FString) & CodeUseId, const [FOnProductCodeUnlockedComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnProductCodeUnlockedComplete) & Delegate )


className: IOnlineCodeRedemption

description: IOnlineCodeRedemption- Interface for locking, unlocking, and evaluating codes. UseIOnlineFulfillmentto redeem it.

code: class IOnlineCodeRedemption


description: Initiate the create/register device process

code: void RegisterDevice ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & LocalUserId, const [FString](API\Runtime\Core\Containers\FString) & InstanceId, const [FString](API\Runtime\Core\Containers\FString) & ChannelType, const [FOnRegisterDeviceComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnRegisterDeviceComplete) & Delegate )


className: IOnlineDeviceNotification

description: IOnlineDeviceNotification- Interface for communications service

code: class IOnlineDeviceNotification


description: Initiate the Evaluation Code process for checking if a code is valid and what product information it relates too

code: void EvaluateCode ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FString](API\Runtime\Core\Containers\FString) & CodeId, const [FOnProductCodeEvaluateComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnProductCodeEvaluateComplete) & Delegate )


description: Initiate the unregister device by channel type process

code: void UnregisterDeviceByChannelType ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & LocalUserId, const [FString](API\Runtime\Core\Containers\FString) & InstanceId, const [FString](API\Runtime\Core\Containers\FString) & ChannelType, const [FOnUnregisterDeviceByChannelTypeComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnUnregisterDeviceByChannelType-) & Delegate )


code: virtual ~IOnlineDeviceNotification()


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnQueryEntitlementsCompleteDelegate_Handle ( const [FOnQueryEntitlementsCompleteDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnQueryEntitlementsCompleteDele-) & Delegate )


code: virtual void ClearOnQueryEntitlementsCompleteDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnQueryEntitlementsCompleteDelegates ( void * Object )


description:
Checks for and retrieves a single cached entitlement for a user
entitlement entry if found, null otherwise

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FOnlineEntitlement](API\Plugins\OnlineSubsystem\Interfaces\FOnlineEntitlement) > GetEntitlement ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FUniqueEntitlementId](API\Plugins\OnlineSubsystem\Interfaces\FUniqueEntitlementId) & EntitlementId )


description: Gets the cached entitlement set for the requested user

code: void GetAllEntitlements ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FString](API\Runtime\Core\Containers\FString) & Namespace, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FOnlineEntitlement](API\Plugins\OnlineSubsystem\Interfaces\FOnlineEntitlement) >> & OutUserEntitlements )


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FOnlineEntitlement](API\Plugins\OnlineSubsystem\Interfaces\FOnlineEntitlement) > GetItemEntitlement ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FString](API\Runtime\Core\Containers\FString) & ItemId )


description:
Contacts server and retrieves the list of the user's entitlements, caching them locally
true if the operation started successfully

code: bool QueryEntitlements ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FString](API\Runtime\Core\Containers\FString) & Namespace, const [FPagedQuery](API\Plugins\OnlineSubsystem\FPagedQuery) & Page )


code: virtual void TriggerOnQueryEntitlementsCompleteDelegates ( bool Param1, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param2, const [FString](API\Runtime\Core\Containers\FString) & Param3, const [FString](API\Runtime\Core\Containers\FString) & Param4 )


code: virtual ~IOnlineEntitlements()


className: IOnlineEntitlements

description: Interface for retrieving user entitlements

code: class IOnlineEntitlements

OnQueryEntitlementsCompleteDelegates

type: FOnQueryEntitle...

description: Delegate instanced called when enumerating entitlements has completed


className: IOnlineEntitlementsPtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IOnlineEntitlements](API\Plugins\OnlineSubsystem\Interfaces\IOnlineEntitlements), ESPMode::ThreadSafe > IOnlineEntitlementsPtr


description: Quick way to send a valid PlayerSessionId with every event, required for Xbox One

code: void SetPlayerSessionId ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & PlayerId, const [FGuid](API\Runtime\Core\Misc\FGuid) & PlayerSessionId )


description:
Trigger an event by name
Whether the event was successfully triggered

code: bool TriggerEvent ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & PlayerId, const TCHAR * EventName, const [FOnlineEventParms](API\Plugins\OnlineSubsystem\Interfaces\FOnlineEventParms) & Parms )


className: IOnlineEvents

description: IOnlineEvents- Interface class for events

code: class IOnlineEvents


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnCreateAccountFlowUIRequiredDelegate_Handle ( const [FOnCreateAccountFlowUIRequiredDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnCreateAccountFlowUIRequiredDe-) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnLoginFlowUIRequiredDelegate_Handle ( const [FOnLoginFlowUIRequiredDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnLoginFlowUIRequiredDelegate) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnExternalUIChangeDelegate_Handle ( const [FOnExternalUIChangeDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnExternalUIChangeDelegate) & Delegate )


code: virtual void ClearOnCreateAccountFlowUIRequiredDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnCreateAccountFlowUIRequiredDelegates ( void * Object )


code: virtual void ClearOnExternalUIChangeDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnExternalUIChangeDelegates ( void * Object )


code: virtual void ClearOnLoginFlowUIRequiredDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnLoginFlowUIRequiredDelegates ( void * Object )


description:
Closes the currently active web external UI
true if it was able to show the UI, false if it failed

code: bool CloseWebURL()


description: Tell the system that you've entered into a screen considered in-game store.

code: virtual void ReportEnterInGameStoreUI()


code: virtual void ReportExitInGameStoreUI()


description:
Displays a system dialog to purchase user account upgrades. e.g. PlaystationPlus, XboxLive GOLD, etc.
true if it was able to show the UI, false if it failed

code: bool ShowAccountUpgradeUI ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UniqueId )


description:
Displays the UI that prompts the user to create an account
true if it was able to show the UI, false if it failed

code: bool ShowAccountCreationUI ( const int ControllerIndex, const [FOnAccountCreationUIClosedDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnAccountCreationUIClosedDelega-) & Delegate )


description:
Displays the UI that shows a user's list of achievements
true if it was able to show the UI, false if it failed

code: bool ShowAchievementsUI ( int32 LocalUserNum )


description:
Displays the UI that shows a user's list of friends to invite
true if it was able to show the UI, false if it failed

code: bool ShowInviteUI ( int32 LocalUserNum, [FName](API\Runtime\Core\UObject\FName) SessionName )


description:
Displays the UI that shows a specific leaderboard
true if it was able to show the UI, false if it failed

code: bool ShowLeaderboardUI ( const [FString](API\Runtime\Core\Containers\FString) & LeaderboardName )


description:
Displays the UI that prompts the user for their login credentials. Each platform handles the authentication of the user's data.
true if it was able to show the UI, false if it failed

code: bool ShowLoginUI ( const int ControllerIndex, bool bShowOnlineOnly, bool bShowSkipButton, const [FOnLoginUIClosedDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnLoginUIClosedDelegate) & Delegate )


description: Displays an informational system dialog.

code: virtual bool ShowPlatformMessageBox ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, [EPlatformMessageType](API\Plugins\OnlineSubsystem\Interfaces\EPlatformMessageType) MessageType )


description:
Displays a user's profile card.
true if it was able to show the UI, false if it failed

code: bool ShowProfileUI ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Requestor, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Requestee, const [FOnProfileUIClosedDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnProfileUIClosedDelegate) & Delegate )


description:
Display the platform UI for sending a mailbox message to the specified user. Will attempt to automatically send the message if the platform allows for it.
true if it was able to send the message and show the UI, false if it failed

code: virtual bool ShowSendMessageToUserUI ( int32 LocalUserNum, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Recipient, const [FShowSendMessageParams](API\Plugins\OnlineSubsystem\Interfaces\FShowSendMessageParams) & ShowParams, const [FOnShowSendMessageUIClosedDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnShowSendMessageUIClosedDelega-) & Delegate )


description:
Display the platform UI for sending a mailbox message to another user
true if it was able to show the UI, false if it failed

code: bool ShowSendMessageUI ( int32 LocalUserNum, const [FShowSendMessageParams](API\Plugins\OnlineSubsystem\Interfaces\FShowSendMessageParams) & ShowParams, const [FOnShowSendMessageUIClosedDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnShowSendMessageUIClosedDelega-) & Delegate )


description:
Display the platform UI for browsing available products for purchase
true if it was able to show the UI, false if it failed

code: bool ShowStoreUI ( int32 LocalUserNum, const [FShowStoreParams](API\Plugins\OnlineSubsystem\Interfaces\FShowStoreParams) & ShowParams, const [FOnShowStoreUIClosedDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnShowStoreUIClosedDelegate) & Delegate )


description:
Displays the UI that shows a user's list of friends
true if it was able to show the UI, false if it failed

code: bool ShowFriendsUI ( int32 LocalUserNum )


description:
Displays a web page in the external UI
true if it was able to show the UI, false if it failed

code: bool ShowWebURL ( const [FString](API\Runtime\Core\Containers\FString) & Url, const [FShowWebUrlParams](API\Plugins\OnlineSubsystem\Interfaces\FShowWebUrlParams) & ShowParams, const [FOnShowWebUrlClosedDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnShowWebUrlClosedDelegate) & Delegate )


code: virtual void TriggerOnCreateAccountFlowUIRequiredDelegates ( const [FString](API\Runtime\Core\Containers\FString) & Param1, const [FOnLoginRedirectURL](API\Plugins\OnlineSubsystem\Interfaces\FOnLoginRedirectURL) & Param2, const [FOnLoginFlowComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnLoginFlowComplete) & Param3, bool & Param4 )


code: virtual void TriggerOnExternalUIChangeDelegates ( bool Param1 )


code: virtual void TriggerOnLoginFlowUIRequiredDelegates ( const [FString](API\Runtime\Core\Containers\FString) & Param1, const [FOnLoginRedirectURL](API\Plugins\OnlineSubsystem\Interfaces\FOnLoginRedirectURL) & Param2, const [FOnLoginFlowComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnLoginFlowComplete) & Param3, bool & Param4 )


code: virtual ~IOnlineExternalUI()


className: IOnlineExternalUI

description: Interface definition for the online services external UIs Any online service that provides extra UI overlays will implement the relevant functions

code: class IOnlineExternalUI

OnCreateAccountFlowUIRequiredDelegates

type: FOnCreateAccoun...

description: Delegate called when the online subsystem requires an external UI to handle account creation

OnExternalUIChangeDelegates

type: FOnExternalUICh...

description: Delegate called when the external UI is opened or closed

OnLoginFlowUIRequiredDelegates

type: FOnLoginFlowUIR...

description: Delegate called when the online subsystem requires an external UI to handle login flow


className: IOnlineExternalUIPtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IOnlineExternalUI](API\Plugins\OnlineSubsystem\Interfaces\IOnlineExternalUI), ESPMode::ThreadSafe > IOnlineExternalUIPtr


description:
Starts an async task that accepts an invite from another player.
true if the request was started successfully, false otherwise

code: bool AcceptInvite ( int32 LocalUserNum, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & FriendId, const [FString](API\Runtime\Core\Containers\FString) & ListName, const [FOnAcceptInviteComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnAcceptInviteComplete) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnBlockedPlayerCompleteDelegate_Handle ( int32 LocalUserNum, const [FOnBlockedPlayerCompleteDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnBlockedPlayerCompleteDelegate) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnBlockListChangeDelegate_Handle ( int32 LocalUserNum, const [FOnBlockListChangeDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnBlockListChangeDelegate) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnDeleteFriendCompleteDelegate_Handle ( int32 LocalUserNum, const [FOnDeleteFriendCompleteDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnDeleteFriendCompleteDelegate) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnFriendRemovedDelegate_Handle ( const [FOnFriendRemovedDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnFriendRemovedDelegate) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnFriendsChangeDelegate_Handle ( int32 LocalUserNum, const [FOnFriendsChangeDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnFriendsChangeDelegate) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnFriendSettingsUpdatedDelegate_Handle ( const [FOnFriendSettingsUpdatedDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnFriendSettingsUpdatedDelegate) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnInviteAbortedDelegate_Handle ( const [FOnInviteAbortedDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnInviteAbortedDelegate) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnInviteAcceptedDelegate_Handle ( const [FOnInviteAcceptedDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnInviteAcceptedDelegate) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnInviteReceivedDelegate_Handle ( const [FOnInviteReceivedDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnInviteReceivedDelegate) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnInviteRejectedDelegate_Handle ( const [FOnInviteRejectedDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnInviteRejectedDelegate) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnOutgoingInviteSentDelegate_Handle ( int32 LocalUserNum, const [FOnOutgoingInviteSentDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnOutgoingInviteSentDelegate) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnQueryBlockedPlayersCompleteDelegate_Handle ( const [FOnQueryBlockedPlayersCompleteDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnQueryBlockedPlayersCompleteDe-) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnQueryRecentPlayersCompleteDelegate_Handle ( const [FOnQueryRecentPlayersCompleteDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnQueryRecentPlayersCompleteDel-) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnRecentPlayersAddedDelegate_Handle ( const [FOnRecentPlayersAddedDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnRecentPlayersAddedDelegate) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnRejectInviteCompleteDelegate_Handle ( int32 LocalUserNum, const [FOnRejectInviteCompleteDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnRejectInviteCompleteDelegate) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnUnblockedPlayerCompleteDelegate_Handle ( int32 LocalUserNum, const [FOnUnblockedPlayerCompleteDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnUnblockedPlayerCompleteDelega-) & Delegate )


description: Add a list of players to a user's recent players list

code: virtual void AddRecentPlayers ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [TArray](API\Runtime\Core\Containers\TArray)< [FReportPlayedWithUser](API\Plugins\OnlineSubsystem\Interfaces\FReportPlayedWithUser) > & InRecentPlayers, const [FString](API\Runtime\Core\Containers\FString) & ListName, const [FOnAddRecentPlayersComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnAddRecentPlayersComplete) & InCompletionDelegate )


description:
Block a player
true if query was started

code: bool BlockPlayer ( int32 LocalUserNum, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & PlayerId )


code: virtual void ClearOnBlockedPlayerCompleteDelegates ( int32 LocalUserNum, void * Object )


code: virtual void ClearOnBlockedPlayerCompleteDelegate_Handle ( int32 LocalUserNum, [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnBlockListChangeDelegate_Handle ( int32 LocalUserNum, [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnBlockListChangeDelegates ( int32 LocalUserNum, void * Object )


code: virtual void ClearOnDeleteFriendCompleteDelegate_Handle ( int32 LocalUserNum, [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnDeleteFriendCompleteDelegates ( int32 LocalUserNum, void * Object )


code: virtual void ClearOnFriendRemovedDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnFriendRemovedDelegates ( void * Object )


code: virtual void ClearOnFriendsChangeDelegate_Handle ( int32 LocalUserNum, [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnFriendsChangeDelegates ( int32 LocalUserNum, void * Object )


code: virtual void ClearOnFriendSettingsUpdatedDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnFriendSettingsUpdatedDelegates ( void * Object )


code: virtual void ClearOnInviteAbortedDelegates ( void * Object )


code: virtual void ClearOnInviteAbortedDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnInviteAcceptedDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnInviteAcceptedDelegates ( void * Object )


code: virtual void ClearOnInviteReceivedDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnInviteReceivedDelegates ( void * Object )


code: virtual void ClearOnInviteRejectedDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnInviteRejectedDelegates ( void * Object )


code: virtual void ClearOnOutgoingInviteSentDelegate_Handle ( int32 LocalUserNum, [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnOutgoingInviteSentDelegates ( int32 LocalUserNum, void * Object )


code: virtual void ClearOnQueryBlockedPlayersCompleteDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnQueryBlockedPlayersCompleteDelegates ( void * Object )


code: virtual void ClearOnQueryRecentPlayersCompleteDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnQueryRecentPlayersCompleteDelegates ( void * Object )


code: virtual void ClearOnRecentPlayersAddedDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnRecentPlayersAddedDelegates ( void * Object )


code: virtual void ClearOnRejectInviteCompleteDelegates ( int32 LocalUserNum, void * Object )


code: virtual void ClearOnRejectInviteCompleteDelegate_Handle ( int32 LocalUserNum, [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnUnblockedPlayerCompleteDelegate_Handle ( int32 LocalUserNum, [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnUnblockedPlayerCompleteDelegates ( int32 LocalUserNum, void * Object )


description:
Starts an async task that deletes a friend from the named friends list
true if the request was started successfully, false otherwise

code: bool DeleteFriend ( int32 LocalUserNum, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & FriendId, const [FString](API\Runtime\Core\Containers\FString) & ListName )


description: Starts an async task that delete an alias from a friend.

code: void DeleteFriendAlias ( int32 LocalUserNum, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & FriendId, const [FString](API\Runtime\Core\Containers\FString) & ListName, const [FOnDeleteFriendAliasComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnDeleteFriendAliasComplete) & Delegate )


description: Dump state information about blocked players

code: void DumpBlockedPlayers() const


description:
Starts an async task that deletes the named friends list for the player
true if the delete request was started successfully, false otherwise

code: bool DeleteFriendsList ( int32 LocalUserNum, const [FString](API\Runtime\Core\Containers\FString) & ListName, const [FOnDeleteFriendsListComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnDeleteFriendsListComplete) & Delegate )


code: void DumpRecentPlayers() const


description:
Get the list of blocked players
true if blocked players list was found for the given user

code: bool GetBlockedPlayers ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FOnlineBlockedPlayer](API\Plugins\OnlineSubsystem\FOnlineBlockedPlayer) > > & OutBlockedPlayers )


description:
Get the cached friend entry if found
null ptr if not found

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FOnlineFriend](API\Plugins\OnlineSubsystem\FOnlineFriend) > GetFriend ( int32 LocalUserNum, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & FriendId, const [FString](API\Runtime\Core\Containers\FString) & ListName )


description:
Gets the FriendInvitePolicy info that defines who can send friend invites to the user. (Public = Anyone, Friends_of_Friends = Only mutual friends, Private = No one)
the permission setting from the UserState

code: virtual [EFriendInvitePolicy](API\Plugins\OnlineSubsystem\EFriendInvitePolicy) GetFriendInvitePolicy ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId ) const


description:
Copies the list of friends for the player previously retrieved from the online service
true if friends list was found

code: bool GetFriendsList ( int32 LocalUserNum, const [FString](API\Runtime\Core\Containers\FString) & ListName, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FOnlineFriend](API\Plugins\OnlineSubsystem\FOnlineFriend) > > & OutFriends )


description:
Copies the cached list of recent players for a given user
true if recent players list was found for the given user

code: bool GetRecentPlayers ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FString](API\Runtime\Core\Containers\FString) & Namespace, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FOnlineRecentPlayer](API\Plugins\OnlineSubsystem\FOnlineRecentPlayer) > > & OutRecentPlayers )


description:
Checks that a unique player id is part of the specified user's friends list
true if friends list was found and the friend was valid

code: bool IsFriend ( int32 LocalUserNum, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & FriendId, const [FString](API\Runtime\Core\Containers\FString) & ListName )


description:
Query for blocked players
true if query was started

code: bool QueryBlockedPlayers ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId )


description: Query the current friend settings

code: virtual void QueryFriendSettings ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & LocalUserId, [FOnSettingsOperationComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnSettingsOperationComplete) Delegate )


description:
Queries the settings we have stored for a third party source
true if query was started

code: virtual bool QueryFriendSettings ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FString](API\Runtime\Core\Containers\FString) & Source, const [FOnQueryFriendSettingsComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnQueryFriendSettingsComplete) & Delegate )


description:
Query for recent players of the current user
true if query was started

code: bool QueryRecentPlayers ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FString](API\Runtime\Core\Containers\FString) & Namespace )


description:
Starts an async task that reads the named friends list for the player
true if the read request was started successfully, false otherwise

code: bool ReadFriendsList ( int32 LocalUserNum, const [FString](API\Runtime\Core\Containers\FString) & ListName, const [FOnReadFriendsListComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnReadFriendsListComplete) & Delegate )


description:
Gets the cached information we have stored from a third party source
true if blocked players list was found for the given user

code: virtual bool GetFriendSettings ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FOnlineFriendSettingsSourceData](API\Plugins\OnlineSubsystem\FOnlineFriendSettingsSourceData) > > & OutSettings )


description:
Starts an async task that rejects an invite from another player.
true if the request was started successfully, false otherwise

code: bool RejectInvite ( int32 LocalUserNum, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & FriendId, const [FString](API\Runtime\Core\Containers\FString) & ListName )


description:
Starts an async task that sends an invite to another player.
true if the request was started successfully, false otherwise

code: bool SendInvite ( int32 LocalUserNum, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & FriendId, const [FString](API\Runtime\Core\Containers\FString) & ListName, const [FOnSendInviteComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnSendInviteComplete) & Delegate )


description: Starts an async task that sets an alias a to friend.

code: void SetFriendAlias ( int32 LocalUserNum, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & FriendId, const [FString](API\Runtime\Core\Containers\FString) & ListName, const [FString](API\Runtime\Core\Containers\FString) & Alias, const [FOnSetFriendAliasComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnSetFriendAliasComplete) & Delegate )


code: virtual void TriggerOnBlockedPlayerCompleteDelegates ( int32 LocalUserNum, bool Param1, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param2, const [FString](API\Runtime\Core\Containers\FString) & Param3, const [FString](API\Runtime\Core\Containers\FString) & Param4 )


description:
Set information we want to store for a third party source
true if query was started

code: virtual bool SetFriendSettings ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FString](API\Runtime\Core\Containers\FString) & Source, bool bNeverShowAgain, const [FOnSetFriendSettingsComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnSetFriendSettingsComplete) & Delegate )


code: virtual void TriggerOnBlockListChangeDelegates ( int32 LocalUserNum, const [FString](API\Runtime\Core\Containers\FString) & Param1 )


code: virtual void TriggerOnDeleteFriendCompleteDelegates ( int32 LocalUserNum, bool Param1, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param2, const [FString](API\Runtime\Core\Containers\FString) & Param3, const [FString](API\Runtime\Core\Containers\FString) & Param4 )


code: virtual void TriggerOnFriendsChangeDelegates ( int32 LocalUserNum )


code: virtual void TriggerOnFriendRemovedDelegates ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param1, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param2 )


code: virtual void TriggerOnFriendSettingsUpdatedDelegates ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param1, bool Param2, bool Param3, const [FFriendSettings](API\Plugins\OnlineSubsystem\Interfaces\FFriendSettings) & Param4, const [FString](API\Runtime\Core\Containers\FString) & Param5 )


code: virtual void TriggerOnInviteAbortedDelegates ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param1, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param2 )


code: virtual void TriggerOnInviteReceivedDelegates ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param1, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param2 )


code: virtual void TriggerOnInviteAcceptedDelegates ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param1, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param2 )


code: virtual void TriggerOnInviteRejectedDelegates ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param1, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param2 )


code: virtual void TriggerOnQueryRecentPlayersCompleteDelegates ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param1, const [FString](API\Runtime\Core\Containers\FString) & Param2, bool Param3, const [FString](API\Runtime\Core\Containers\FString) & Param4 )


code: virtual void TriggerOnRecentPlayersAddedDelegates ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param1, const [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FOnlineRecentPlayer](API\Plugins\OnlineSubsystem\FOnlineRecentPlayer) >> & Param2 )


code: virtual void TriggerOnQueryBlockedPlayersCompleteDelegates ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param1, bool Param2, const [FString](API\Runtime\Core\Containers\FString) & Param3 )


code: virtual void TriggerOnUnblockedPlayerCompleteDelegates ( int32 LocalUserNum, bool Param1, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param2, const [FString](API\Runtime\Core\Containers\FString) & Param3, const [FString](API\Runtime\Core\Containers\FString) & Param4 )


code: virtual void TriggerOnRejectInviteCompleteDelegates ( int32 LocalUserNum, bool Param1, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param2, const [FString](API\Runtime\Core\Containers\FString) & Param3, const [FString](API\Runtime\Core\Containers\FString) & Param4 )


description:
Unblock a player
true if query was started

code: bool UnblockPlayer ( int32 LocalUserNum, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & PlayerId )


description: Update the current friend settings

code: virtual void UpdateFriendInvitePolicySettings ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & LocalUserId, const [EFriendInvitePolicy](API\Plugins\OnlineSubsystem\EFriendInvitePolicy) FriendInvitePolicy, const bool bAffectsExistingInvites, [FOnSettingsOperationComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnSettingsOperationComplete) Delegate )


code: virtual ~IOnlineFriends()


className: IOnlineFriends

description: Interface definition for the online services friends services Friends services are anything related to the maintenance of friends and friends lists

code: class IOnlineFriends

OnBlockedPlayerCompleteDelegates

type: FOnBlockedPlaye...

description: Delegate used when a block player request has completed

OnBlockListChangeDelegates

type: FOnBlockListCha...

description: Delegate used in block list change notifications

OnDeleteFriendCompleteDelegates

type: FOnDeleteFriend...

description: Delegate used when an friend delete request has completed

OnFriendRemovedDelegates

type: FOnFriendRemove...

description: Delegate called when a remote friend removes user from friends list

OnFriendsChangeDelegates

type: FOnFriendsChang...

description: Delegate used in friends list change notifications

OnFriendSettingsUpdatedDelegates

type: FOnFriendSettin...

description: Delegate used when the friends settings are updated

OnInviteAbortedDelegates

type: FOnInviteAborte...

description: Delegate called when a remote friend cancels/aborts an sent invite

OnInviteAcceptedDelegates

type: FOnInviteAccept...

description: Delegate called when a remote friend accepts an invite

OnInviteReceivedDelegates

type: FOnInviteReceiv...

description: Delegate called when remote friend sends an invite

OnInviteRejectedDelegates

type: FOnInviteReject...

description: Delegate called when a remote friend rejects an invite

OnOutgoingInviteSentDelegates

type: FOnOutgoingInvi...

description: Delegate used in outgoing invite list change notifications

OnQueryBlockedPlayersCompleteDelegates

type: FOnQueryBlocked...

description: Delegate used when the query for blocked players has completed

OnQueryRecentPlayersCompleteDelegates

type: FOnQueryRecentP...

description: Delegate used when the query for recent players has completed

OnRecentPlayersAddedDelegates

type: FOnRecentPlayer...

description: Delegate used when recent players have been added

OnRejectInviteCompleteDelegates

type: FOnRejectInvite...

description: Delegate used when an invite reject request has completed

OnUnblockedPlayerCompleteDelegates

type: FOnUnblockedPla...

description: Delegate used when an unblock player request has completed


className: IOnlineFriendsPtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IOnlineFriends](API\Plugins\OnlineSubsystem\Interfaces\IOnlineFriends), ESPMode::ThreadSafe > IOnlineFriendsPtr


description: Initiate the checkout process for obtaining offers via code redemption

code: void RedeemCode ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FRedeemCodeRequest](API\Plugins\OnlineSubsystem\Interfaces\FRedeemCodeRequest) & RedeemCodeRequest, const [FOnPurchaseRedeemCodeComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnPurchaseRedeemCodeComplete) & Delegate )


code: virtual ~IOnlineFulfillment()


className: IOnlineFulfillment

description: IOnlineFulfillment- Interface for redeeming codes.

code: class IOnlineFulfillment


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnGameActivityActivationRequestedDelegate_Handle ( const [FOnGameActivityActivationRequestedDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnGameActivityActivationRequest-_1) & Delegate )


code: virtual void TriggerOnOutgoingInviteSentDelegates ( int32 LocalUserNum )


code: virtual void ClearOnGameActivityActivationRequestedDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnGameActivityActivationRequestedDelegates ( void * Object )


description: End an activity

code: void EndActivity ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & LocalUserId, const [FString](API\Runtime\Core\Containers\FString) & ActivityId, [EOnlineActivityOutcome](API\Plugins\OnlineSubsystem\Interfaces\EOnlineActivityOutcome) ActivityOutcome, const [FOnlineEventParms](API\Plugins\OnlineSubsystem\Interfaces\FOnlineEventParms) & Parms, [FOnEndActivityComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnEndActivityComplete) CompletionDelegate )


description: Query user's activities

code: bool QueryActivitiesForUsers ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & LocalUserId, const [TArray](API\Runtime\Core\Containers\TArray)< FUniqueNetIdRef > & UserAccounts, [TOptional](API\Runtime\Core\IO\TOptional)< int32 > MaxUserActivitiesReturned, const [FOnQueryUserActivitiesComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnQueryUserActivitiesComplete) & CompletionDelegate )


description: Resets all in-progress and completed activities.

code: void ResetAllActiveActivities ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & LocalUserId, const [FOnResetAllActiveActivitiesComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnResetAllActiveActivitiesCompl-) & CompletionDelegate )


description: Resume an activity. Different from StartActivity in that resume continues from current progress where StartActivity will set progress back to 0 before activating the activity

code: void ResumeActivity ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & LocalUserId, const [FString](API\Runtime\Core\Containers\FString) & ActivityId, const [TOptional](API\Runtime\Core\IO\TOptional)< [FOnlineActivityTasksToReset](API\Plugins\OnlineSubsystem\Interfaces\FOnlineActivityTasksToReset) > & TasksToReset, const [FOnResumeActivityComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnResumeActivityComplete) & CompletionDelegate )


description: Set an activity's availability

code: void SetActivityAvailability ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & LocalUserId, const [FString](API\Runtime\Core\Containers\FString) & ActivityId, const bool bEnabled, [FOnSetActivityAvailabilityComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnSetActivityAvailabilityComple-) CompletionDelegate )


description: Set the activity priority

code: void SetActivityPriority ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & LocalUserId, const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), int32 > & PrioritizedActivities, [FOnSetActivityPriorityComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnSetActivityPriorityComplete) CompletionDelegate )


description: Start an activity

code: void StartActivity ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & LocalUserId, const [FString](API\Runtime\Core\Containers\FString) & ActivityId, const [FOnlineEventParms](API\Plugins\OnlineSubsystem\Interfaces\FOnlineEventParms) & Parms, [FOnStartActivityComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnStartActivityComplete) CompletionDelegate )


code: virtual void TriggerOnGameActivityActivationRequestedDelegates ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param1, const [FString](API\Runtime\Core\Containers\FString) & Param2, const [FOnlineSessionSearchResult](API\Plugins\OnlineSubsystem\FOnlineSessionSearchResult) * Param3 )


code: virtual ~IOnlineGameActivity()


className: IOnlineGameActivity

description: IOnlineGameActivity- Interface class for managing a user's activity state

code: class IOnlineGameActivity

type: FOnGameActivity...

description: Called when an activity is requested


description: Updates the lists of available and unavailable items

code: void ItemAvailabilityChange ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & LocalUserId, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & AvailableItems, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & UnavailableItems, [FOnItemAvailabilityChangeComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnItemAvailabilityChangeComplet-) CompletionDelegate )


description: Items used to make impact and who the impact target is

code: void ItemImpact ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & LocalUserId, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & TargetActors, const [FString](API\Runtime\Core\Containers\FString) & ImpactInitiatedBy, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & ItemsUsed, [FOnItemImpactComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnItemImpactComplete) CompletionDelegate )


description: Updates the lists of available and unavailable items in the player's inventory

code: void ItemInventoryChange ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & LocalUserId, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & ItemsToAdd, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & ItemsToRemove, [FOnItemInventoryChangeComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnItemInventoryChangeComplete) CompletionDelegate )


description: Items the player effectively used to mitigate an item used by the game on the player

code: void ItemMitigation ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & LocalUserId, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & ItemsUsed, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & ImpactItemsMitigated, const [FString](API\Runtime\Core\Containers\FString) & ItemUsedBy, [FOnItemMitigationComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnItemMitigationComplete) CompletionDelegate )


description: Updates the loadout of the player's configuration

code: void ItemLoadoutChange ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & LocalUserId, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & EquippedItems, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & UnequippedItems, [FOnItemLoadoutChangeComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnItemLoadoutChangeComplete) CompletionDelegate )


code: virtual ~IOnlineGameItemStats()


description: Updates items used and by who

code: void ItemUsage ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & LocalUserId, const [FString](API\Runtime\Core\Containers\FString) & ItemUsedBy, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & ItemsUsed, [FOnItemUsageComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnItemUsageComplete) CompletionDelegate )


description: Note: The game is expected to call this function periodically. ZoneId/Coordinates are also used when starting and stopping an activity

code: void UpdatePlayerLocation ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & LocalUserId, [TOptional](API\Runtime\Core\IO\TOptional)< [FOnlineActivityPlayerLocation](API\Plugins\OnlineSubsystem\Interfaces\FOnlineActivityPlayerLocation) > & ActivityPlayerLocation )


className: IOnlineGameItemStats

code: class IOnlineGameItemStats


description: Joins a player to an existing match

code: void JoinGameMatch ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FString](API\Runtime\Core\Containers\FString) & MatchId, const [TArray](API\Runtime\Core\Containers\TArray)< [FJoinGameMatchPlayer](API\Plugins\OnlineSubsystem\Interfaces\FJoinGameMatchPlayer) > & GameMatchJoinPlayerData, const [FOnJoinGameMatchComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnJoinGameMatchComplete) & CompletionDelegate )


description: Create a game match

code: void CreateGameMatch ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FGameMatchesData](API\Plugins\OnlineSubsystem\Interfaces\FGameMatchesData) & MatchesData, const [FOnCreateGameMatchComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnCreateGameMatchComplete) & CompletionDelegate )


description: Removes a player from an existing match

code: void LeaveGameMatch ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FString](API\Runtime\Core\Containers\FString) & MatchId, const [TArray](API\Runtime\Core\Containers\TArray)< [FLeaveGameMatchPlayer](API\Plugins\OnlineSubsystem\Interfaces\FLeaveGameMatchPlayer) > & GameMatchLeavePlayerData, const [FOnLeaveGameMatchComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnLeaveGameMatchComplete) & CompletionDelegate )


description: Sends final data of the match and closes the match out

code: void ReportGameMatchResults ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FString](API\Runtime\Core\Containers\FString) & MatchId, const [FFinalGameMatchReport](API\Plugins\OnlineSubsystem\Interfaces\FFinalGameMatchReport) & FinalReport, const [FOnGameMatchReportComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnGameMatchReportComplete) & CompletionDelegate )


description: Updates game match information while match is still in progress

code: void UpdateGameMatchDetails ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FString](API\Runtime\Core\Containers\FString) & MatchId, const [FGameMatchRoster](API\Plugins\OnlineSubsystem\Interfaces\FGameMatchRoster) & MatchRoster, const [FOnUpdateGameMatchDetailsComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnUpdateGameMatchDetailsComplet-) & CompletionDelegate )


code: virtual ~IOnlineGameMatches()


description: Updates the status of a created match

code: void UpdateGameMatchStatus ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FString](API\Runtime\Core\Containers\FString) & MatchId, const [EUpdateGameMatchStatus](API\Plugins\OnlineSubsystem\Interfaces\EUpdateGameMatchStatus) & Status, const [FOnGameMatchStatusUpdateComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnGameMatchStatusUpdateComplete) & CompletionDelegate )


className: IOnlineGameMatches

description: IOnlineGameMatches- Interface class for managing a user's game matches

code: class IOnlineGameMatches


description: Accept a pending invite to join a group. This is done on behalf of the context user (provided when you request thisIOnlineGroupsinterface) and also updates the their cached membership info. You can call GetCachedUserMembership afterwards to see if they are a full member or petitioner.

code: void AcceptInvite ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


description: Accept a user request to join the group.

code: void AcceptUser ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


description: Any user but team owner can be denylisted including member, invitee, applicant and/or any other user unrelated to the team. Blocking follows "ignore" logic: blocked users shouldn't know for sure that they've been blocked. Blocked user will still be able to apply for membership and cancel pending application even while blocked.

code: void BlockUser ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


description: Cancels an invitation to join the group.

code: void CancelInvite ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


description: Cancel pending request to join the given group.

code: void CancelRequest ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


description: Create a new group using the specified GroupInfo. FGroupsResult::GroupId can be used to identify the newly created group once the callback executes (FGroupsResultbeing a param to the callback).

code: void CreateGroup ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FGroupDisplayInfo](API\Plugins\OnlineSubsystem\Interfaces\FGroupDisplayInfo) & GroupInfo, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


description: Decline a pending invite to join a group. This is done on behalf of the context user (provided when you request thisIOnlineGroupsinterface) and also updates the their cached membership info. You can call GetCachedUserMembership afterwards to see if they are a full member or petitioner.

code: void DeclineInvite ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


description: Delete a group entirely.

code: void DeleteGroup ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


description: Decline a user request to join the group.

code: void DeclineUser ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


description: Demote an Admin to a Member within the specified group. Fails if the user's role is not Admin (Owner != Admin).

code: void DemoteUser ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


description: Find all groups matching the specified search string

code: void FindGroups ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FGroupSearchOptions](API\Plugins\OnlineSubsystem\Interfaces\FGroupSearchOptions) & SearchOptions, const [FOnFindGroupsCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnFindGroupsCompleted) & OnCompleted )


className: FOnGroupUpdated

description: Delegate fired when a group is updated. We only receive notifications for groups for which one of the logged-in players is a member.

code: typedef TMulticastDelegate_OneParam< void, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & > FOnGroupUpdated


description: Get cached pending application information (if it exists). This retrieves a list of membership applications that the user has created (outgoing) or to which the user can respond as admin (incoming).

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [IApplications](API\Plugins\OnlineSubsystem\Interfaces\IApplications) > GetCachedApplications ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId )


description: Get the result of a previous configuration query. Only the member queried for will be valid.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FGroupConfigEntryBool](API\Plugins\OnlineSubsystem\Interfaces\FGroupConfigEntryBool) > GetCachedConfigBool ( const [FString](API\Runtime\Core\Containers\FString) & Key )


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FGroupConfigEntryInt](API\Plugins\OnlineSubsystem\Interfaces\FGroupConfigEntryInt) > GetCachedConfigInt ( const [FString](API\Runtime\Core\Containers\FString) & Key )


description:
Get the cached list of users banned from this group. If the information is not cached locally, call QueryGroupDenylist to request it from the server.
Shared pointer to the cached roster structure if one exists

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [IGroupDenylist](API\Plugins\OnlineSubsystem\Interfaces\IGroupDenylist) > GetCachedGroupDenylist ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId )


description:
Get the group info for a group that has been previously queried. The shared pointer will be empty if the group has not been successfully queried (or if it was purged from the cache). From time to time, the cache may be cleaned up. Keep a shared pointer to groups you care about or be willing to re-query.
Shared pointer to the cached group info structure if one exists.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [IGroupInfo](API\Plugins\OnlineSubsystem\Interfaces\IGroupInfo) > GetCachedGroupInfo ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId )


description:
Get the cached list of outstanding invites to a group. If the information is not cached locally, call QueryGroupInvites to request it from the server.
Shared pointer to the cached roster structure if one exists

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [IGroupInvites](API\Plugins\OnlineSubsystem\Interfaces\IGroupInvites) > GetCachedGroupInvites ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId )


description:
Get the cached list of users requesting to becoming members of a group. If the information is not cached locally, call QueryGroupRequests to request it from the server.
Shared pointer to the cached roster structure if one exists

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [IGroupRequests](API\Plugins\OnlineSubsystem\Interfaces\IGroupRequests) > GetCachedGroupRequests ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId )


description:
Get the cached Roster (membership) information for a group. If the information is not cached locally, call QueryGroupRoster to request it from the server. If the context user is a member of this group, the cached roster information will include petitioners and invitees, otherwise it will not.
Shared pointer to the cached roster structure if one exists

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [IGroupRoster](API\Plugins\OnlineSubsystem\Interfaces\IGroupRoster) > GetCachedGroupRoster ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId )


description: Get cached pending invitation information (if it exists). This retrieves a list of membership invitations that the user's admin clans have created (outgoing) or to which the user can respond (incoming).

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [IInvitations](API\Plugins\OnlineSubsystem\Interfaces\IInvitations) > GetCachedInvitations ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId )


description: Get cached user membership information (if it exists). This retrieves which groups they are members of. If UserId is the ID of the context user, then this list will include groups to which the user has been invited (use JoinGroup to accept, LeaveGroup to decline) or groups they have petitioned but haven't received a response for yet.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [IUserMembership](API\Plugins\OnlineSubsystem\Interfaces\IUserMembership) > GetCachedUserMembership ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId )


code: const [FString](API\Runtime\Core\Containers\FString) & GetNamespace() const


description: Invite a user to join the specified group.

code: void InviteUser ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, bool bAllowBlocked, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


code: virtual void InviteUser ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


description: Submit a request to join the specified group. This is done on behalf of the context user (provided when you request thisIOnlineGroupsinterface) and also updates the their cached membership info. You can call GetCachedUserMembership afterwards to see if they are a full member or petitioner.

code: void JoinGroup ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


description: Promote a Member to an Admin within the specified group. Fails if the user's role is not Member.

code: void PromoteUser ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


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.

code: void LeaveGroup ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


description: Queries the system configuration for system-wide user max membership count.

code: void QueryConfigMembership ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


description: Queries the system configuration for system-wide group max membership headcount.

code: void QueryConfigHeadcount ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


description: Get the list of users banned from this group. When the OnCompleted callback fires, if it succeeded you can use GetCachedGroupDenylist to retrieve the information.

code: void QueryGroupDenylist ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


description: 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).

code: void QueryGroupInfo ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


description: Get the list of outstanding invites to a group. When the OnCompleted callback fires, if it succeeded you can use GetCachedGroupInvites to retrieve the membership information.

code: void QueryGroupInvites ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


description: Ask the server if the given group name currently exists. If it completes successfully, you can call GetCachedGroupNameExist to get the result. Even if the result is currently cached, this function will contact the server (ostensibly to refresh the cache).

code: void QueryGroupNameExist ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FString](API\Runtime\Core\Containers\FString) & GroupName, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


description: Get the list of users requesting to becoming members of a group. When the OnCompleted callback fires, if it succeeded you can use GetCachedGroupRequests to retrieve the membership information.

code: void QueryGroupRequests ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


description: Get the list of members for a group and their role info. When the OnCompleted callback fires, if it succeeded you can use GetCachedGroupRoster to retrieve the membership information.

code: void QueryGroupRoster ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


description: Queries the server for a list of membership applications that UserId can process (accept, reject, or block) as group admin. If the callback reports success, use GetCachedApplications to retrieve details.

code: void QueryIncomingApplications ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


description: Queries the server for a list of groups to which the user has been invited. If the callback reports success, use GetCachedApplications to retrieve details.

code: void QueryIncomingInvitations ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


description: Queries the server for a list of group invitations the user has sent. If the callback reports success, use GetCachedApplications to retrieve details.

code: void QueryOutgoingInvitations ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


description: Queries the server for a list of groups to which the user has applied for membership. If the callback reports success, use GetCachedApplications to retrieve details.

code: void QueryOutgoingApplications ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


description: Queries the server for updated membership information for a particular user. This retrieves which groups they are members of. If the callback reports success, use GetCachedUserMembership to retrieve details.

code: void QueryUserMembership ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


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

code: void RemoveUser ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


code: void SetNamespace ( const [FString](API\Runtime\Core\Containers\FString) & Ns )


description: Promote an existing Admin to be the new Owner and simultaneously demotes the context user to Admin. Fails if the new owner is not currently an Admin of the group. Also fails if the new owner cannot own the group (due to owning too many other groups, as determined by the namespace config, perhaps).

code: void TransferGroup ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & NewOwnerId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


description: Remove a user from the group's denylist list.

code: void UnblockUser ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


description: Update the user specified fields of the group such as name, description, etc. This call may fail if the name changes and the new name is already in use within this namespace.

code: void UpdateGroupInfo ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & ContextUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & GroupId, const [FGroupDisplayInfo](API\Plugins\OnlineSubsystem\Interfaces\FGroupDisplayInfo) & GroupInfo, const [FOnGroupsRequestCompleted](API\Plugins\OnlineSubsystem\Interfaces\FOnGroupsRequestCompleted) & OnCompleted )


className: IOnlineGroups

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

code: class IOnlineGroups

OnGroupUpdated

type: FOnGroupUpdated


className: IOnlineGroupsPtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IOnlineGroups](API\Plugins\OnlineSubsystem\Interfaces\IOnlineGroups), ESPMode::ThreadSafe > IOnlineGroupsPtr


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnLoginChangedDelegate_Handle ( const [FOnLoginChangedDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnLoginChangedDelegate) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnControllerPairingChangedDelegate_Handle ( const [FOnControllerPairingChangedDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnControllerPairingChangedDeleg-) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnLoginFlowLogoutDelegate_Handle ( const [FOnLoginFlowLogoutDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnLoginFlowLogoutDelegate) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnLoginCompleteDelegate_Handle ( int32 LocalUserNum, const [FOnLoginCompleteDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnLoginCompleteDelegate) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnLoginStatusChangedDelegate_Handle ( int32 LocalUserNum, const [FOnLoginStatusChangedDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnLoginStatusChangedDelegate) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnLogoutCompleteDelegate_Handle ( int32 LocalUserNum, const [FOnLogoutCompleteDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnLogoutCompleteDelegate) & Delegate )


description:
Logs the player into the online service using parameters passed on the command line. Expects -AUTH_LOGIN=-AUTH_PASSWORD=. If either are missing, the function returns false and doesn't start the login process
true if the async call started ok, false otherwise

code: bool AutoLogin ( int32 LocalUserNum )


description: If an auth token is obtained for some other purpose than user account login, it would be ignored an replaced with another when an actual login attempt is made, wasting the previously obtained one. Caching avoids that potential waste, but must be manually cleared client-side when the login completes due to the remote side has consuming it.

code: virtual void ClearCachedAuthToken ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId )


code: virtual void ClearOnControllerPairingChangedDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnControllerPairingChangedDelegates ( void * Object )


code: virtual void ClearOnLoginChangedDelegates ( void * Object )


code: virtual void ClearOnLoginChangedDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnLoginCompleteDelegate_Handle ( int32 LocalUserNum, [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnLoginCompleteDelegates ( int32 LocalUserNum, void * Object )


code: virtual void ClearOnLoginFlowLogoutDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnLoginFlowLogoutDelegates ( void * Object )


code: virtual void ClearOnLoginStatusChangedDelegate_Handle ( int32 LocalUserNum, [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnLogoutCompleteDelegate_Handle ( int32 LocalUserNum, [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnLogoutCompleteDelegates ( int32 LocalUserNum, void * Object )


description:
Create a unique id from string
UniqueId from the given data, NULL otherwise

code: FUniqueNetIdPtr CreateUniquePlayerId ( const [FString](API\Runtime\Core\Containers\FString) & Str )


description:
Create a unique id from binary data (used during replication)
UniqueId from the given data, NULL otherwise

code: FUniqueNetIdPtr CreateUniquePlayerId ( uint8 * Bytes, int32 Size )


className: EPrivilegeResults

code: enum EPrivilegeResults { NoFailures = 0, RequiredPatchAvailable = 1 << 0, RequiredSystemUpdate = 1 << 1, AgeRestrictionFailure = 1 << 2, AccountTypeFailure = 1 << 3, UserNotFound = 1 << 4, UserNotLoggedIn = 1 << 5, ChatRestriction = 1 << 6, UGCRestriction = 1 << 7, GenericFailure = 1 << 8, OnlinePlayRestricted = 1 << 9, NetworkConnectionUnavailable = 1 << 10, }


className: FOnGetUserPrivilegeCompleteDelegate

description: Delegate executed when we get a user privilege result.

code: typedef TBaseDelegate_ThreeParams< void, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) &, [EUserPrivileges::Type](API\Plugins\OnlineSubsystem\Interfaces\EUserPrivileges__Type), uint32 > FOnGetUserPrivilegeCompleteDelegate


description: Delegate executed when the user's auth ticket has arrived

code: typedef TBaseDelegate_ThreeParams< void, int32, bool, const [FExternalAuthToken](API\Plugins\OnlineSubsystem\Interfaces\FExternalAuthToken) & > FOnGetLinkedAccountAuthTokenCompleteDelegate


description:
Obtain list of all known/registered user accounts
info about the users if found, NULL otherwise

code: [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FUserOnlineAccount](API\Plugins\OnlineSubsystem\FUserOnlineAccount) > > GetAllUserAccounts() const


description:
Gets a user's platform specific authentication token to verify their identity
String representing the authentication token

code: [FString](API\Runtime\Core\Containers\FString) GetAuthToken ( int32 LocalUserNum ) const


code: virtual void ClearOnLoginStatusChangedDelegates ( int32 LocalUserNum, void * Object )


description:
Get the auth type associated with accounts for this platform
The auth type associated with accounts for this platform


description: Deprecated* Please use GetLinkedAccountAuthToken taking a TokenType

code: virtual void GetLinkedAccountAuthToken ( int32 LocalUserNum, const [FOnGetLinkedAccountAuthTokenCompleteDelegate](API\Plugins\OnlineSubsystem\Interfaces\IOnlineIdentity\FOnGetLinkedAcco-) & Delegate ) const


description: Gets a user's platform specific authentication ticket used to sign into linked account(s)

code: virtual void GetLinkedAccountAuthToken ( int32 LocalUserNum, const [FString](API\Runtime\Core\Containers\FString) & TokenType, const [FOnGetLinkedAccountAuthTokenCompleteDelegate](API\Plugins\OnlineSubsystem\Interfaces\IOnlineIdentity\FOnGetLinkedAcco-) & Delegate ) const


description:
Converts from a PlatformUserId used by application code to a local user num used by the online system
The corresponding user number of INDEX_NONE if invalid

code: virtual int32 GetLocalUserNumFromPlatformUserId ( [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) PlatformUserId ) const


description:
Fetches the login status for a given player
the enum value of their status

code: [ELoginStatus::Type](API\Plugins\OnlineSubsystem\ELoginStatus__Type) GetLoginStatus ( int32 LocalUserNum ) const


code: [ELoginStatus::Type](API\Plugins\OnlineSubsystem\ELoginStatus__Type) GetLoginStatus ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId ) const


description:
Converts from a local user num used by the online system to a PlatformUserId used by application code
The corresponding id or PLATFORMID_NONE if invalid

code: virtual [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) GetPlatformUserIdFromLocalUserNum ( int32 LocalUserNum ) const


description:
Converts from an online unique id to a PlatformUserId used by application code
The corresponding id or PLATFORMID_NONE if not found

code: [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) GetPlatformUserIdFromUniqueNetId ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UniqueNetId ) const


description:
Reads the player's nick name from the online service
a string containing the players nick name

code: [FString](API\Runtime\Core\Containers\FString) GetPlayerNickname ( int32 LocalUserNum ) const


code: [FString](API\Runtime\Core\Containers\FString) GetPlayerNickname ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId ) const


description:
Gets the platform specific unique id for the sponsor of the specified player
Valid player id object if the sponsor exists, NULL otherwise

code: virtual FUniqueNetIdPtr GetSponsorUniquePlayerId ( int32 LocalUserNum ) const


description:
Gets the platform specific unique id for the specified player
Valid player id object if the call succeeded, NULL otherwise

code: FUniqueNetIdPtr GetUniquePlayerId ( int32 LocalUserNum ) const


description:
Obtain online account info for a user that has been registered
info about the user if found, NULL otherwise

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FUserOnlineAccount](API\Plugins\OnlineSubsystem\FUserOnlineAccount) > GetUserAccount ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId ) const


description: Gets the status of a user's privilege.

code: void GetUserPrivilege ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & LocalUserId, [EUserPrivileges::Type](API\Plugins\OnlineSubsystem\Interfaces\EUserPrivileges__Type) Privilege, const [FOnGetUserPrivilegeCompleteDelegate](API\Plugins\OnlineSubsystem\Interfaces\IOnlineIdentity\FOnGetUserPrivil-) & Delegate )


description:
Signs the player out of the online service Will call OnLogoutComplete() delegate when async task completes
true if logout task was started

code: bool Logout ( int32 LocalUserNum )


description:
Login/Authenticate with user credentials. Will call OnLoginComplete() delegate when async task completes
true if login task was started

code: bool Login ( int32 LocalUserNum, const [FOnlineAccountCredentials](API\Plugins\OnlineSubsystem\Interfaces\FOnlineAccountCredentials) & AccountCredentials )


description: Revoke the user's registered auth token.

code: void RevokeAuthToken ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & LocalUserId, const [FOnRevokeAuthTokenCompleteDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnRevokeAuthTokenCompleteDelega-) & Delegate )


code: virtual void TriggerOnControllerPairingChangedDelegates ( int Param1, [FControllerPairingChangedUserInfo](API\Plugins\OnlineSubsystem\Interfaces\FControllerPairingChangedUserInf-) Param2, [FControllerPairingChangedUserInfo](API\Plugins\OnlineSubsystem\Interfaces\FControllerPairingChangedUserInf-) Param3 )


code: virtual void TriggerOnLoginChangedDelegates ( int32 Param1 )


code: virtual void TriggerOnLoginCompleteDelegates ( int32 LocalUserNum, bool Param1, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param2, const [FString](API\Runtime\Core\Containers\FString) & Param3 )


code: virtual void TriggerOnLoginFlowLogoutDelegates ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & Param1 )


code: virtual void TriggerOnLoginStatusChangedDelegates ( int32 LocalUserNum, [ELoginStatus::Type](API\Plugins\OnlineSubsystem\ELoginStatus__Type) Param1, [ELoginStatus::Type](API\Plugins\OnlineSubsystem\ELoginStatus__Type) Param2, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Param3 )


code: virtual void TriggerOnLogoutCompleteDelegates ( int32 LocalUserNum, bool Param1 )


code: virtual ~IOnlineIdentity()


className: IOnlineIdentityPtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IOnlineIdentity](API\Plugins\OnlineSubsystem\Interfaces\IOnlineIdentity), ESPMode::ThreadSafe > IOnlineIdentityPtr


className: IOnlineIdentity

description: Interface for registration/authentication of user identities

code: class IOnlineIdentity

OnControllerPairingChangedDelegates

type: FOnControllerPa...

description: Delegate called when a controller-user pairing changes

OnLoginChangedDelegates

type: FOnLoginChanged

description: Delegate called when a player logs in/out

OnLoginCompleteDelegates

type: FOnLoginComplet...

description: Called when user account login has completed after callingLogin()orAutoLogin()

OnLoginFlowLogoutDelegates

type: FOnLoginFlowLog...

description: Delegate called when the online subsystem requires the login flow to logout and cleanup

OnLoginStatusChangedDelegates

type: FOnLoginStatusC...

description: Delegate called when a player's login status changes but doesn't change identity

OnLogoutCompleteDelegates

type: FOnLogoutComple...

description: Delegate used in notifying the that manual logout completed


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnLeaderboardReadCompleteDelegate_Handle ( const [FOnLeaderboardReadCompleteDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnLeaderboardReadCompleteDelega-) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnLeaderboardFlushCompleteDelegate_Handle ( const [FOnLeaderboardFlushCompleteDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnLeaderboardFlushCompleteDeleg-) & Delegate )


code: virtual void ClearOnLeaderboardReadCompleteDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnLeaderboardReadCompleteDelegates ( void * Object )


code: virtual void ClearOnLeaderboardFlushCompleteDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnLeaderboardFlushCompleteDelegates ( void * Object )


description:
Commits any changes in the online stats cache to the permanent storage
true if the call is successful, false otherwise

code: bool FlushLeaderboards ( const [FName](API\Runtime\Core\UObject\FName) & SessionName )


description: Cleans up any platform specific allocated data contained in the stats data

code: void FreeStats ( [FOnlineLeaderboardRead](API\Plugins\OnlineSubsystem\FOnlineLeaderboardRead) & ReadObject )


description:
Reads a player's stats and all of that player's friends stats for the specified set of stat views. This allows you to easily compare a player's stats to their friends.
true if the call is successful, false otherwise

code: bool ReadLeaderboardsForFriends ( int32 LocalUserNum, [FOnlineLeaderboardReadRef](API\Plugins\OnlineSubsystem\FOnlineLeaderboardReadRef) & ReadObject )


description:
Reads stats for a given rank in the leaderboard, as well as a range of stats above and below that rank. For example, if Rank = 100 and Range = 10, entries for ranks 90-110 will be returned.
true if the call is successful, false otherwise

code: bool ReadLeaderboardsAroundRank ( int32 Rank, uint32 Range, [FOnlineLeaderboardReadRef](API\Plugins\OnlineSubsystem\FOnlineLeaderboardReadRef) & ReadObject )


description:
Reads stats for a given player in the leaderboard, as well as a range of stats above and below that user. For example, if the player is 100th in the leaderboard and Range = 10, entries for ranks 90-110 will be returned.
true if the call is successful, false otherwise

code: bool ReadLeaderboardsAroundUser ( FUniqueNetIdRef Player, uint32 Range, [FOnlineLeaderboardReadRef](API\Plugins\OnlineSubsystem\FOnlineLeaderboardReadRef) & ReadObject )


description:
Reads a set of stats for the specified list of players
true if the call is successful, false otherwise

code: bool ReadLeaderboards ( const [TArray](API\Runtime\Core\Containers\TArray)< FUniqueNetIdRef > & Players, [FOnlineLeaderboardReadRef](API\Plugins\OnlineSubsystem\FOnlineLeaderboardReadRef) & ReadObject )


code: virtual void TriggerOnLeaderboardReadCompleteDelegates ( bool Param1 )


code: virtual void TriggerOnLeaderboardFlushCompleteDelegates ( const [FName](API\Runtime\Core\UObject\FName) & Param1, bool Param2 )


description:
Writes out the stats contained within the stats write object to the online subsystem's cache of stats data. Note the new data replaces the old. Stats cannot be written without a session or the write request is ignored. No more than 5 stats views can be written to at a time or the write request is ignored.
true if the call is successful, false otherwise

code: bool WriteLeaderboards ( const [FName](API\Runtime\Core\UObject\FName) & SessionName, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & Player, [FOnlineLeaderboardWrite](API\Plugins\OnlineSubsystem\FOnlineLeaderboardWrite) & WriteObject )


description:
Writes the score data for the match, used for rankings/ratings
true if the call is successful, false otherwise

code: bool WriteOnlinePlayerRatings ( const [FName](API\Runtime\Core\UObject\FName) & SessionName, int32 LeaderboardId, const [TArray](API\Runtime\Core\Containers\TArray)< [FOnlinePlayerScore](API\Plugins\OnlineSubsystem\FOnlinePlayerScore) > & PlayerScores )


code: virtual ~IOnlineLeaderboards()


className: IOnlineLeaderboards

description: Interface definition for the online services leaderboard services

code: class IOnlineLeaderboards

OnLeaderboardFlushCompleteDelegates

type: FOnLeaderboardF...

description: Delegate called when the stats flush operation has completed

OnLeaderboardReadCompleteDelegates

type: FOnLeaderboardR...

description: Notifies the interested party that the last stats read has completed


className: IOnlineLeaderboardsPtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IOnlineLeaderboards](API\Plugins\OnlineSubsystem\Interfaces\IOnlineLeaderboards), ESPMode::ThreadSafe > IOnlineLeaderboardsPtr


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnDeleteMessageCompleteDelegate_Handle ( int32 LocalUserNum, const [FOnDeleteMessageCompleteDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnDeleteMessageCompleteDelegate) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnEnumerateMessagesCompleteDelegate_Handle ( int32 LocalUserNum, const [FOnEnumerateMessagesCompleteDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnEnumerateMessagesCompleteDele-) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnReadMessageCompleteDelegate_Handle ( int32 LocalUserNum, const [FOnReadMessageCompleteDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnReadMessageCompleteDelegate) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnSendMessageCompleteDelegate_Handle ( int32 LocalUserNum, const [FOnSendMessageCompleteDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnSendMessageCompleteDelegate) & Delegate )


description:
Clear the given cached message
true if messages were clear, false if there was a problem

code: bool ClearMessage ( int32 LocalUserNum, const [FUniqueMessageId](API\Plugins\OnlineSubsystem\Interfaces\FUniqueMessageId) & MessageId )


description:
Clear the cached list of message headers
true if messages were clear, false if there was a problem

code: bool ClearMessageHeaders ( int32 LocalUserNum )


code: virtual void ClearOnDeleteMessageCompleteDelegate_Handle ( int32 LocalUserNum, [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


description:
Clear all the cached messages
true if messages were clear, false if there was a problem

code: bool ClearMessages ( int32 LocalUserNum )


code: virtual void ClearOnDeleteMessageCompleteDelegates ( int32 LocalUserNum, void * Object )


code: virtual void ClearOnEnumerateMessagesCompleteDelegate_Handle ( int32 LocalUserNum, [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnReadMessageCompleteDelegate_Handle ( int32 LocalUserNum, [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnEnumerateMessagesCompleteDelegates ( int32 LocalUserNum, void * Object )


code: virtual void ClearOnReadMessageCompleteDelegates ( int32 LocalUserNum, void * Object )


code: virtual void ClearOnSendMessageCompleteDelegate_Handle ( int32 LocalUserNum, [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnSendMessageCompleteDelegates ( int32 LocalUserNum, void * Object )


description:
Delete a message from currently logged in user's inbox
true if request was started

code: bool DeleteMessage ( int32 LocalUserNum, const [FUniqueMessageId](API\Plugins\OnlineSubsystem\Interfaces\FUniqueMessageId) & MessageId )


description:
Enumerate list of available message headers from user's inbox
true if request was started

code: bool EnumerateMessages ( int32 LocalUserNum )


description:
Get the cached message and its contents for a user. Cache is populated by calling ReadMessage with a message id
pointer to message entry if found or NULL

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [FOnlineMessage](API\Plugins\OnlineSubsystem\Interfaces\FOnlineMessage) > GetMessage ( int32 LocalUserNum, const [FUniqueMessageId](API\Plugins\OnlineSubsystem\Interfaces\FUniqueMessageId) & MessageId )


description:
Get the cached list of message headers for a user. Cache is populated by calling EnumerateMessages
true if cached entry was found

code: bool GetMessageHeaders ( int32 LocalUserNum, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [FOnlineMessageHeader](API\Plugins\OnlineSubsystem\Interfaces\FOnlineMessageHeader) > > & OutHeaders )


description:
Download a message and its payload from user's inbox
true if request was started

code: bool ReadMessage ( int32 LocalUserNum, const [FUniqueMessageId](API\Plugins\OnlineSubsystem\Interfaces\FUniqueMessageId) & MessageId )


description:
Send a message from the currently logged in user to a list of recipients
true if request was started

code: bool SendMessage ( int32 LocalUserNum, const [TArray](API\Runtime\Core\Containers\TArray)< FUniqueNetIdRef > & RecipientIds, const [FString](API\Runtime\Core\Containers\FString) & MessageType, const [FOnlineMessagePayload](API\Plugins\OnlineSubsystem\Interfaces\FOnlineMessagePayload) & Payload )


code: virtual void TriggerOnDeleteMessageCompleteDelegates ( int32 LocalUserNum, bool Param1, const [FUniqueMessageId](API\Plugins\OnlineSubsystem\Interfaces\FUniqueMessageId) & Param2, const [FString](API\Runtime\Core\Containers\FString) & Param3 )


code: virtual void TriggerOnEnumerateMessagesCompleteDelegates ( int32 LocalUserNum, bool Param1, const [FString](API\Runtime\Core\Containers\FString) & Param2 )


code: virtual void TriggerOnReadMessageCompleteDelegates ( int32 LocalUserNum, bool Param1, const [FUniqueMessageId](API\Plugins\OnlineSubsystem\Interfaces\FUniqueMessageId) & Param2, const [FString](API\Runtime\Core\Containers\FString) & Param3 )


code: virtual void TriggerOnSendMessageCompleteDelegates ( int32 LocalUserNum, bool Param1, const [FString](API\Runtime\Core\Containers\FString) & Param2 )


code: virtual ~IOnlineMessage()


code: const [IOnlineNotificationTransportMessage](API\Plugins\OnlineSubsystem\Interfaces\IOnlineNotificationTransportMess-) * Convert ( const [FOnlineNotification](API\Plugins\OnlineSubsystem\FOnlineNotification) & Notification )


className: IOnlineMessage

description: Interface class for enumerating/sending/receiving messages between users

code: class IOnlineMessage

OnDeleteMessageCompleteDelegates

type: FOnDeleteMessag...

description: Delegate used when deleting a message has completed

OnEnumerateMessagesCompleteDelegates

type: FOnEnumerateMes...

description: Delegate used when the enumeration of message headers has completed

OnReadMessageCompleteDelegates

type: FOnReadMessageC...

description: Delegate used when downloading of message contents has completed

OnSendMessageCompleteDelegates

type: FOnSendMessageC...

description: Delegate used when sending of message has completed


code: const [FOnlineNotification](API\Plugins\OnlineSubsystem\FOnlineNotification) & Convert ( const [IOnlineNotificationTransportMessage](API\Plugins\OnlineSubsystem\Interfaces\IOnlineNotificationTransportMess-) * TransportMessage )


description: Equality operator

code: bool operator== ( const [IOnlineNotificationTransport](API\Plugins\OnlineSubsystem\Interfaces\IOnlineNotificationTransport) & Other ) const


description: Receive a transport-specific notification in from this transport mechanism and pass along to be delivered

code: bool ReceiveNotification ( const [IOnlineNotificationTransportMessage](API\Plugins\OnlineSubsystem\Interfaces\IOnlineNotificationTransportMess-) & TransportMessage )