1. Epic GamesDeveloper
  3. Interfaces

Interfaces

Unreal Engine C++ API Reference > Plugins > OnlineSubsystem

Classes

  Type Name Description
Public struct FApplicationEntry An entry in the list of user pending membership applications.  
Public struct FBlockedQueryResult    
Public class FChatMessage Chat message received from user/room  
Public class FChatRoomConfig Configuration for creating/joining a chat room  
Public class FChatRoomInfo Info for a joined/created chat room  
Public class FChatRoomMember Member of a chat room  
Public class FCodeEvaluationInfo    
Public class FCodeLockInfo    
Public struct FControllerPairingChangedUserInfo This struct will be broadcast with the FOnControllerPairingChanged event.  
Public struct FExternalAuthToken A struct for the external account token in case we need per platform fields  
Public struct FExternalIdQueryOptions    
Public struct FFinalGameMatchReport Final match report container. Holds all information to close out the game match  
Public struct FFindGroupsResult Specialized result for FindGroups  
Public struct FFriendSettings Stores a generic list of settings for the Query/UpdateSettings calls  
Public struct FGameMatchCompetitiveResults Results of the competitive game match  
Public struct FGameMatchesData Top most container that contains all game match data  
Public struct FGameMatchPlayer Player information needed when creating a new game match  
Public struct FGameMatchPlayerResult Player game match results  
Public struct FGameMatchPlayerStats Per player stats  
Public struct FGameMatchResult Overall game match results container to house coop and competitive game match data  
Public struct FGameMatchRoster Game match roster  
Public struct FGameMatchStats Complete team and player game match stats  
Public struct FGameMatchStatsData Stats container  
Public struct FGameMatchTeam Data needed to construct a team  
Public struct FGameMatchTeamResult Game match results for the team  
Public struct FGameMatchTeamStats Complete team stats with players  
Public struct FGroupDenylistEntry An entry in a group denylist  
Public struct FGroupDisplayInfo Data about the group that is used for display  
Public struct FGroupMember An entry in a group member list.  
Public struct FGroupMemberInvite An entry in a pending invite list.  
Public struct FGroupMemberRequest An entry in a pending application list.  
Public struct FGroupSearchOptions Group search options  
Public struct FGroupsResult Structure to encapsulate the result of a call to the server.  
Public struct FInvitationEntry An entry in a user's list of groups to which they are invited.  
Public struct FJoinGameMatchPlayer Player information needed to join a game match  
Public struct FLeaveGameMatchPlayer Data required to leave a game match  
Public struct FLocalTalker Definition of a local player's talking state  
Public struct FLoginFlowResult A single login flow result  
Public class FOnlineAccountCredentials Account credentials needed to sign in to an online service  
Public struct FOnlineAchievement FOnlineAchievement - Interface class for accessing the common achievement information  
Public struct FOnlineAchievementDesc FOnlineAchievementDesc - Interface class for accessing the common achievement description information  
Public struct FOnlineActivityInformation Information about a game activity  
Public struct FOnlineActivityPlayerLocation Players location information for the activity service  
Public struct FOnlineActivityTasksToReset Task ids for in progress and completed activity tasks to be reset  
Public struct FOnlineEntitlement Details of an entitlement  
Public class FOnlineEventParms    
Public class FOnlineMessage Downloaded message obtained via passing message id to ReadMessage  
Public class FOnlineMessageHeader Message header obtained via EnumerateMessages Represents an inbox message that can be downloaded  
Public class FOnlineMessagePayload Message payload that stores key value pairs for variant type data  
Public class FOnlineParty Current state associated with a party  
Public class FOnlinePartyData Data associated with the entire party  
Public class FOnlinePartyMember Party member user info returned by IOnlineParty interface  
Public struct FOnlinePresenceSetPresenceParameters Parameters to IOnlinePresence::SetPresence.  
Public struct FOnlineStatUpdate Object to represent a new stat value and how to use it in relation to previous values  
Public struct FOnlineStatusUpdate FOnlineStatusUpdate - Object which hosts all the content we will post to a news feed  
Public class FOnlineStoreCategory Category used to organize offers in the online store  
Public class FOnlineStoreFilter Filter for querying a subset of offers from the online store  
Public class FOnlineStoreOffer Offer entry for display from online store  
Public struct FOnlineTournamentMatchResults The results of a match  
Public struct FOnlineTournamentParticipantQueryFilter Filters to use when querying for participant information.  
Public struct FOnlineTournamentQueryFilter Filters to use when querying for tournament information.  
Public struct FOnlineTournamentScore Details about a participant and their current score  
Public struct FOnlineTransportTap A pattern used to open a tap and associated event handlers  
Public class FOnlineTransportTapHandle    
Public class FOnlineUserPresence Presence info for an online user returned via IOnlinePresence interface  
Public class FOnlineUserPresenceStatus    
Public struct FOnlineUserStatsPair    
Public struct FPartyConfiguration Options for configuring a new party or for updating an existing party  
Public struct FPartyInvitationRecipient Recipient information for SendInvitation  
Public class FPurchaseCheckoutRequest Info needed for checkout  
Public class FPurchaseReceipt Receipt result from checkout  
Public struct FQueryPartyJoinabilityResult QueryPartyJoinability result  
Public class FRedeemCodeRequest Info needed for code redemption  
Public struct FRemoteTalker Definition of a remote player's talking state  
Public struct FReportPlayedWithUser Stores information about a recent player  
Public struct FSessionMatchmakingResults Matchmaking results  
Public struct FSessionMatchmakingUser Attributes for a matchmaking user  
Public struct FSharingPermission Contains information about a single permission granted by a backend service  
Public struct FShowSendMessageParams    
Public struct FShowStoreParams    
Public struct FShowWebUrlParams Parameters used to show a web UI  
Public class FTurnBasedEventDelegate FTurnBasedEventDelegate provides the interface for responding to events in turn based games  
Public class FTurnBasedMatch FTurnBasedMatch contains all of the information about an in-progress turn based match  
Public class FTurnBasedMatchmakerDelegate FTurnBasedMatchmakerDelegate provides the interface for all turn based matchmaking callbacks  
Public class FTurnBasedMatchRequest FTurnBasedMatchRequest contains all of the information required for a matchmaker to create an FTurnBasedMatch  
Public struct FUserMembershipEntry An entry in a group member list.  
Public struct FUsersOnlineActivities Requested friend's activity information  
Public struct FVoiceChatRoomEntered Payload for a room entered callback  
Public struct FVoiceChatRoomExited Payload for a room exited callback  
Public class FVoiceChatRoomInfo Basic information about a voice chat room in various possible states  
Public class FVoiceChatRoomMember Representation of a user inside of a voice chat room  
Public class IGroupInfo This struct describes metadata about a group.  
Public struct IGroupUserCollection    
Public class IMessageSanitizer    
Public class IOnlineAchievements IOnlineAchievements - Interface class for achievements  
Public class IOnlineChat Interface class for user-user and user-room chat  
Public class IOnlineCodeRedemption IOnlineCodeRedemption - Interface for locking, unlocking, and evaluating codes.  
Public class IOnlineContentAgeRestriction IOnlineContentAgeRestriction - Interface class for managing a user's content age restriction status  
Public class IOnlineDeviceNotification IOnlineDeviceNotification - Interface for communications service  
Public class IOnlineEntitlements Interface for retrieving user entitlements  
Public class IOnlineEvents IOnlineEvents - Interface class for events  
Public class IOnlineExternalUI Interface definition for the online services external UIs Any online service that provides extra UI overlays will implement the relevant functions  
Public class IOnlineFriends Interface definition for the online services friends services Friends services are anything related to the maintenance of friends and friends lists  
Public class IOnlineFulfillment IOnlineFulfillment - Interface for redeeming codes.  
Public class IOnlineGameActivity IOnlineGameActivity - Interface class for managing a user's activity state  
Public class IOnlineGameItemStats    
Public class IOnlineGameMatches IOnlineGameMatches - Interface class for managing a user's game matches  
Public class IOnlineGroups Interface definition for the online teams (groups) service Groups are collections of users with an owner and a set of administrators  
Public class IOnlineIdentity Interface for registration/authentication of user identities  
Public class IOnlineLeaderboards Interface definition for the online services leaderboard services  
Public class IOnlineMessage Interface class for enumerating/sending/receiving messages between users  
Public class IOnlineNotificationTransport Interface for notification transport mechanisms  
Public class IOnlineNotificationTransportMessage Abstract base class for messages of the type understood by the specific transport mechanism, eg. xmpp  
Public class IOnlinePartyJoinInfo Info needed to join a party  
Public class IOnlinePartyPendingJoinRequestInfo Info about a group of users requesting to join a party  
Public class IOnlinePartyRequestToJoinInfo Info about a request to join a local user's party  
Public class IOnlinePartySystem Interface definition for the online party services Allows for forming a party and communicating with party members  
Public class IOnlinePartyUserPendingJoinRequestInfo Info about a user requesting to join a party  
Public class IOnlinePlayTimeLimit Interface to provide play time limits  
Public class IOnlinePresence Interface class for getting and setting rich presence information.  
Public class IOnlinePurchase IOnlinePurchase - Interface for IAP (In App Purchases) services  
Public class IOnlineSession Interface definition for the online services session services Session services are defined as anything related managing a session and its state within a platform service  
Public class IOnlineSharedCloud Provides the interface for sharing files already on the cloud with other users  
Public class IOnlineSharing IOnlineSharing - Interface class for sharing.  
Public class IOnlineStats An interface to update stat backends with  
Public class IOnlineStoreV2 Access to available offers for purchase  
Public class IOnlineTime Interface for querying server time from an online service  
Public class IOnlineTitleFile    
Public class IOnlineTournament Interface to handle requesting and submitting information related to tournaments  
Public struct IOnlineTournamentDetails The details of a tournament  
Public struct IOnlineTournamentMatchDetails The details of a match  
Public struct IOnlineTournamentParticipantDetails The tournament-specific details of a participant in a tournament  
Public struct IOnlineTournamentTeamDetails The details of a team in a tournament  
Public class IOnlineTracing Online Tracing Interface  
Public class IOnlineTurnBased IOnlineTurnBased - Interface class for turn based multiplayer matches  
Public class IOnlineUser Interface class for obtaining online User info  
Public class IOnlineUserCloud Provides access to per user cloud file storage  
Public class IOnlineVoice This interface is an abstract mechanism for managing voice data.  
Public class ITurnBasedMatchInterface    
Public class IVoiceChatRoom    
Public class IVoiceEngine This interface is an abstract mechanism for acquiring voice data from a hardware source.  
Public struct TGroupConfigEntry    
Public class UTurnBasedMatchInterface    

Constants

Name Description
EOnlinePresenceState::AwayText  
EOnlinePresenceState::ChatText  
EOnlinePresenceState::DoNotDisturbText  
EOnlinePresenceState::OfflineText  
EOnlinePresenceState::OnlineText  

Typedefs

Name Description
FAdditionalMetaDataMap  
FChatRoomId Id of a chat room
FDownloadMatchDataSignature  
FEndMatchSignature  
FGroupConfigEntryBool  
FGroupConfigEntryInt  
FLoadTurnBasedMatchesSignature  
FLoadTurnBasedMatchWithIDSignature  
FOfferNamespace  
FOnAcceptInviteComplete Delegate used when an invite accept request has completed
FOnAcceptPartyInvitationComplete Accepting an invite to a user to join party async task completed callback
FOnAccountCreationUIClosedDelegate Delegate executed when the external account creation UI has been closed.
FOnAchievementsWritten Delegate fired when achievements have been written to the server
FOnAchievementsWrittenDelegate  
FOnAchievementUnlocked Delegate fired when an achievement has been unlocked
FOnAchievementUnlockedDelegate  
FOnAddRecentPlayersComplete Delegate used when adding a group of recent players has completed
FOnAuthAboutToExpire Delegate called when an auth session is about to expire and a new auth token is needed.
FOnAuthAboutToExpireDelegate  
FOnBlockedPlayerComplete Delegate used when a block request has completed
FOnBlockedPlayerCompleteDelegate  
FOnBlockListChange Delegate used in block list change notifications
FOnBlockListChangeDelegate  
FOnCancelFindSessionsComplete Delegate fired when the cancellation of a search for an online session has completed
FOnCancelFindSessionsCompleteDelegate  
FOnCancelMatchmakingComplete Delegate fired when the Matchmaking request has been canceled
FOnCancelMatchmakingCompleteDelegate  
FOnCancelPartyInvitationComplete Party invitation cancel completed callback
FOnChatPrivateMessageReceived Delegate used when a private chat message is received from another user
FOnChatPrivateMessageReceivedDelegate  
FOnChatPrivateMessageSent Delegate used when a private chat message is sent to another user
FOnChatPrivateMessageSentDelegate  
FOnChatRoomConfigured Delegate used when configuring a chat room
FOnChatRoomConfiguredDelegate  
FOnChatRoomCreated Delegate used when creating a new chat room
FOnChatRoomCreatedDelegate  
FOnChatRoomExit Delegate used when exiting a chat room
FOnChatRoomExitDelegate  
FOnChatRoomJoinPrivate Delegate used when joining a private chat room
FOnChatRoomJoinPrivateDelegate  
FOnChatRoomJoinPublic Delegate used when joining a public chat room
FOnChatRoomJoinPublicDelegate  
FOnChatRoomMemberExit Delegate used when another chat room member exits
FOnChatRoomMemberExitDelegate  
FOnChatRoomMemberJoin Delegate used when another chat room member enters/joins
FOnChatRoomMemberJoinDelegate  
FOnChatRoomMemberUpdate Delegate used when another chat room member is updated
FOnChatRoomMemberUpdateDelegate  
FOnChatRoomMessageReceived Delegate used when a chat message is received from a chat room
FOnChatRoomMessageReceivedDelegate  
FOnChatRoomMessageSent Delegate used when a chat message is sent to a chat room
FOnChatRoomMessageSentDelegate  
FOnCleanupPartiesComplete Cleanup parties async task completed callback
FOnControllerPairingChanged Delegate called when a controller-user pairing changes
FOnControllerPairingChangedDelegate  
FOnCreateAccountFlowUIRequired DECLARE_DELEGATE_OneParam(FOnCreateAccountFlowComplete, const FLoginFlowResult& /*Result*/); DECLARE_DELEGATE_RetVal_OneParam(FLoginFlowResult, FOnLoginRedirectURL, const FString& /*URL*/); Delegate executed by the requesting system when a supporting account creation flow browser window is asked to handle the request
FOnCreateAccountFlowUIRequiredDelegate  
FOnCreateGameMatchComplete Delegate fired when the CreateGameMatch call has completed
FOnCreatePartyComplete Party creation async task completed callback
FOnCreateSessionComplete Delegate fired when a session create request has completed
FOnCreateSessionCompleteDelegate  
FOnDeleteFriendAliasComplete Delegate used when a delete friend alias request has completed
FOnDeleteFriendComplete Delegate used when an friend delete request has completed
FOnDeleteFriendCompleteDelegate  
FOnDeleteFriendsListComplete Delegate used when the friends list delete request has completed
FOnDeleteMessageComplete Delegate used when deleting a message has completed
FOnDeleteMessageCompleteDelegate  
FOnDeleteUserFileComplete Delegate fired when a user file delete from the network platform's storage is complete
FOnDeleteUserFileCompleteDelegate  
FOnDestroySessionComplete Delegate fired when a destroying an online session has completed
FOnDestroySessionCompleteDelegate  
FOnDestroySessionRequested Delegate called when the service requests that we destroy the session.
FOnDestroySessionRequestedDelegate  
FOnEndActivityComplete Delegate fired when an end activity call has completed
FOnEndSessionComplete Delegate fired when the online session has transitioned to the ending state
FOnEndSessionCompleteDelegate  
FOnEnumerateFilesComplete Delegate fired when the list of files has been returned from the network store
FOnEnumerateFilesCompleteDelegate  
FOnEnumerateMessagesComplete Delegate used when the enumeration of message headers has completed
FOnEnumerateMessagesCompleteDelegate  
FOnEnumerateUserFilesComplete Delegate fired when the list of files has been returned from the network store
FOnEnumerateUserFilesCompleteDelegate  
FOnExternalUIChange Delegate called when the external UI is opened or closed
FOnExternalUIChangeDelegate  
FOnFillPartyJoinRequestData Request for the game to fill in data to be sent with the join request for the leader to make an informed decision based on the joiner's state
FOnFillPartyJoinRequestDataDelegate  
FOnFinalizeReceiptValidationInfoComplete Delegate called when receipt validation completes
FOnFindFriendSessionComplete Delegate fired once a single search result is returned (ie friend invite / join) Session has not been joined at this point, and requires a call to JoinSession()
FOnFindFriendSessionCompleteDelegate  
FOnFindGroupsCompleted  
FOnFindSessionsComplete Delegate fired when the search for an online session has completed
FOnFindSessionsCompleteDelegate  
FOnFriendRemoved Delegate called when a remote friend removes user from friends list
FOnFriendRemovedDelegate  
FOnFriendsChange Delegate used in friends list change notifications
FOnFriendsChangeDelegate  
FOnFriendSettingsUpdated Delegate used when the friends settings are updated
FOnFriendSettingsUpdatedDelegate  
FOnGameActivityActivationRequested Multicast delegate fired when an activity request has happened
FOnGameActivityActivationRequestedDelegate  
FOnGameMatchFeedbackComplete Delegate fired when the game match feedback call has completed
FOnGameMatchReportComplete Delegate fired when the ReportGameMatchResults call has completed
FOnGameMatchStatusUpdateComplete Delegate fired when the UpdateGameMatchStatus call has completed
FOnGroupsRequestCompleted Generic delegate used for when an asynchronous query completes
FOnInviteAborted Delegate called when a remote friend cancels/aborts an invite
FOnInviteAbortedDelegate  
FOnInviteAccepted Delegate called when a remote friend accepts an invite
FOnInviteAcceptedDelegate  
FOnInviteReceived Delegate called when remote friend sends an invite
FOnInviteReceivedDelegate  
FOnInviteRejected Delegate called when a remote friend rejects an invite
FOnInviteRejectedDelegate  
FOnItemAvailabilityChangeComplete Delegate fired when a item availability change call has completed
FOnItemImpactComplete Delegate fired when a item impact call has completed
FOnItemInventoryChangeComplete Delegate fired when a item inventory change call has completed
FOnItemLoadoutChangeComplete Delegate fired when a item loadout change call has completed
FOnItemMitigationComplete Delegate fired when a item mitigation call has completed
FOnItemUsageComplete Delegate fired when a item usage call has completed
FOnJoinGameMatchComplete Delegate fired when the JoinGameMatch call has completed
FOnJoinPartyComplete Party join async task completed callback
FOnJoinSessionComplete Delegate fired when the joining process for an online session has completed
FOnJoinSessionCompleteDelegate  
FOnKickPartyMemberComplete Kicking a member of a party async task completed callback
FOnLeaderboardFlushComplete Delegate called when the stats flush operation has completed
FOnLeaderboardFlushCompleteDelegate  
FOnLeaderboardReadComplete Delegate called when the last leaderboard read is complete
FOnLeaderboardReadCompleteDelegate  
FOnLeaveGameMatchComplete Delegate fired when the LeaveGameMatch match call has completed
FOnLeavePartyComplete Party leave async task completed callback
FOnlinePartyConstPtr  
FOnlinePartyConstRef  
FOnlinePartyDataConstPtr  
FOnlinePartyDataConstRef  
FOnlinePartyDataPtr  
FOnlinePartyDataRef  
FOnlinePartyMemberConstPtr  
FOnlinePartyMemberConstRef  
FOnlineStatsQueryUsersStatsComplete Delegate called when multiple users' stats have finished being queried, with a ResultState parameter to represent success or failure
FOnlineStatsQueryUserStatsComplete Delegate called when a user's stats have finished being queried, with a ResultState parameter to represent success or failure
FOnlineStatsUpdateStatsComplete Delegate called when a stat update has completed, with a ResultState parameter to represent success or failure
FOnlineStatsUserStats A pair of a user and an array of their stats
FOnlineStatsUserUpdatedStats A pair of a user and an array of their stats to be updated
FOnlineStatValue  
FOnlineStoreOfferRef  
FOnlineTournamentId UniqueNetId of a tournament
FOnlineTournamentIdPtr  
FOnlineTournamentIdRef  
FOnlineTournamentMatchId UniqueNetId of a match in a tournament
FOnlineTournamentMatchIdPtr  
FOnlineTournamentMatchIdRef  
FOnlineTournamentParticipantId UniqueNetId of a participant (Player or team) in a tournament
FOnlineTournamentParticipantIdPtr  
FOnlineTournamentParticipantIdRef  
FOnlineTournamentQueryMatchDetailsComplete A delegate for when match details have finished being queried.
FOnlineTournamentQueryMatchListComplete A delegate for when a match list has finished being queried.
FOnlineTournamentQueryParticipantListComplete A delegate for when participant lists have finished being queried.
FOnlineTournamentQueryTeamDetailsComplete A delegate for when team details have finished being queried.
FOnlineTournamentQueryTournamentDetailsComplete A delegate for when tournament details have finished being queried.
FOnlineTournamentQueryTournamentListComplete A delegate for when a tournament list has finished being queried.
FOnlineTournamentSubmitMatchResultsComplete A delegate for when match results have finished being submitted.
FOnlineTournamentTeamId UniqueNetId of a team in a tournament
FOnlineTournamentTeamIdPtr  
FOnlineTournamentTeamIdRef  
FOnLoginChanged Delegate called when a player logs in/out
FOnLoginChangedDelegate  
FOnLoginComplete Called when user account login has completed after calling Login() or AutoLogin()
FOnLoginCompleteDelegate  
FOnLoginFlowComplete Delegate executed with a login flow has completed@Param Result the result of the login process
FOnLoginFlowLogout Delegate called when logout requires login flow to cleanup
FOnLoginFlowLogoutDelegate  
FOnLoginFlowUIRequired Delegate executed by the requesting system when a supporting login flow browser window is asked to handle the request
FOnLoginFlowUIRequiredDelegate  
FOnLoginRedirectURL Delegate executed when a redirect URL request has been received by the internal browser window
FOnLoginStatusChanged Delegate called when a player's status changes but doesn't change profiles
FOnLoginStatusChangedDelegate  
FOnLoginUIClosedDelegate Delegate executed when the external login UI has been closed.
FOnLogoutComplete Delegate used in notifying the UI/game that the manual logout completed
FOnLogoutCompleteDelegate  
FOnMatchmakingComplete Broadcast delegate fired when the Matchmaking for an online session has completed
FOnMatchmakingCompleteDelegate  
FOnMessageArrayProcessed  
FOnMessageProcessed  
FOnOnlineTournamentMatchJoined A delegate for when a tournament has been joined
FOnOnlineTournamentMatchJoinedDelegate  
FOnOnlineTournamentTournamentJoined A delegate for when a tournament has been joined
FOnOnlineTournamentTournamentJoinedDelegate  
FOnOutgoingInviteSent Delegate used in outgoing invite list change notifications
FOnOutgoingInviteSentDelegate  
FOnPartyAnalyticsEvent Notification when an analytics event needs to be recorded
FOnPartyAnalyticsEventDelegate  
FOnPartyConfigChanged Notification when party config is updated
FOnPartyConfigChangedDelegate  
FOnPartyDataReceived Notification when party data is updated
FOnPartyDataReceivedDelegate  
FOnPartyExited Notification when a party is joined
FOnPartyExitedDelegate  
FOnPartyInviteReceivedEx Notification when a new invite is received
FOnPartyInviteReceivedExDelegate  
FOnPartyInviteRemovedEx Notification when an invite has been removed
FOnPartyInviteRemovedExDelegate  
FOnPartyInviteRequestReceived Notification when a request for an invite has been received
FOnPartyInviteRequestReceivedDelegate  
FOnPartyInviteResponseReceived Notification when a new invite is received
FOnPartyInviteResponseReceivedDelegate  
FOnPartyInvitesChanged Notification when an invite list has changed for a party the user is in
FOnPartyInvitesChangedDelegate  
FOnPartyJoined Notification delegates.
FOnPartyJoinedDelegate  
FOnPartyJoinRequestReceived Notification when a new reservation request is received
FOnPartyJoinRequestReceivedDelegate  
FOnPartyMemberDataReceived Notification when party member data is updated
FOnPartyMemberDataReceivedDelegate  
FOnPartyMemberExited Notification when a member exits a party
FOnPartyMemberExitedDelegate  
FOnPartyMemberJoined Notification when a member joins the party
FOnPartyMemberJoinedDelegate  
FOnPartyMemberPromoted Notification when a member is promoted in a party
FOnPartyMemberPromotedDelegate  
FOnPartyPromotionLockoutChanged Notification when player promotion is locked out.
FOnPartyPromotionLockoutChangedDelegate  
FOnPartyRequestToJoinReceived Notification when a new party join request is received
FOnPartyRequestToJoinReceivedDelegate  
FOnPartyRequestToJoinRemoved Notification when a request to join has been removed
FOnPartyRequestToJoinRemovedDelegate  
FOnPartyStateChanged Notification when a party's state has changed
FOnPartyStateChangedDelegate  
FOnPartySystemStateChange Notification of party system state change
FOnPartySystemStateChangeDelegate  
FOnPingSearchResultsComplete Delegate fired when an individual server's query has completed
FOnPingSearchResultsCompleteDelegate  
FOnPlayerTalkingStateChanged Delegate called when a player is talking either remotely or locally Called once for each active talker each frame
FOnPlayerTalkingStateChangedDelegate  
FOnPresenceArrayUpdated Delegate executed when the array of presence data for a user changes.
FOnPresenceArrayUpdatedDelegate  
FOnPresenceReceived Delegate executed when new presence data is available for a user.
FOnPresenceReceivedDelegate  
FOnProductCodeEvaluateComplete Delegate used when the an evaluate code request is completed
FOnProductCodeLockedComplete Delegate used when the a lock code request is completed
FOnProductCodeUnlockedComplete Delegate used when the an evaluate code request is completed
FOnProfileUIClosedDelegate Delegate executed when the user profile UI has been closed.
FOnPromotePartyMemberComplete Promoting a member of a party async task completed callback
FOnPurchaseCheckoutComplete Delegate called when checkout process completes
FOnPurchaseReceiptlessCheckoutComplete Delegate called when checkout process completes, this delegate is used when the entitlement or receipt information of the purchase is not needed by the caller.
FOnPurchaseRedeemCodeComplete Delegate called when code redemption process completes
FOnQosDataRequested Delegate fired when session is requesting QOS measurements
FOnQosDataRequestedDelegate  
FOnQueryAchievementsCompleteDelegate Delegate fired when an achievement has been queried
FOnQueryBlockedPlayersComplete Delegate used when the query for blocked players has completed
FOnQueryBlockedPlayersCompleteDelegate  
FOnQueryContentAgeRestictionComplete Delegate fired when content age restriction check is completed
FOnQueryEntitlementsComplete Delegate declaration for when entitlements are enumerated
FOnQueryEntitlementsCompleteDelegate  
FOnQueryForAvailablePurchasesComplete Delegate fired when a session create request has completed
FOnQueryForAvailablePurchasesCompleteDelegate  
FOnQueryFriendSettingsComplete Delegate used when the query for friends settings has completed
FOnQueryOnlineStoreCategoriesComplete Delegate called when available online categories have been queried
FOnQueryOnlineStoreOffersComplete Delegate called when online store query completes
FOnQueryPartyJoinabilityCompleteEx Party query joinability async task completed callback
FOnQueryPartyJoinabilityReceived Notification when a player wants to know if the party is in a joinable state
FOnQueryPartyJoinabilityReceivedDelegate  
FOnQueryReceiptsComplete Delegate called when query receipt process completes
FOnQueryRecentPlayersComplete Delegate used when the query for recent players has completed
FOnQueryRecentPlayersCompleteDelegate  
FOnQueryServerUtcTimeComplete Called when the time request from the server is complete
FOnQueryServerUtcTimeCompleteDelegate  
FOnQueryUserActivitiesComplete Delegate fired when querying remote user activities call has completed
FOnQueryUserBlockedResponse  
FOnQueryUserInfoComplete Delegate used when the user query request has completed
FOnQueryUserInfoCompleteDelegate  
FOnReadFileComplete Delegate fired when a file read from the network platform's storage is complete
FOnReadFileCompleteDelegate  
FOnReadFileProgress Delegate fired when as file read from the network platform's storage progresses
FOnReadFileProgressDelegate  
FOnReadFriendsListComplete Delegate used when the friends read request has completed
FOnReadMessageComplete Delegate used when downloading of message contents has completed
FOnReadMessageCompleteDelegate  
FOnReadNewsFeedComplete Called to notify that a read request for a news feed has completed.
FOnReadNewsFeedCompleteDelegate  
FOnReadSharedFileComplete Delegate fired when a shared file read from the network platform's storage is complete
FOnReadSharedFileCompleteDelegate  
FOnReadUserFileComplete Delegate fired when a user file read from the network platform's storage is complete
FOnReadUserFileCompleteDelegate  
FOnRecentPlayersAdded Delegate used when recent players have been added
FOnRecentPlayersAddedDelegate  
FOnRegisterDeviceComplete Delegate used when the register device request is completed
FOnRegisterLocalPlayerCompleteDelegate Delegate fired when local player registration has completed
FOnRegisterPlayersComplete Delegate fired when the session registration process has completed
FOnRegisterPlayersCompleteDelegate  
FOnRejectInviteComplete Delegate used when an invite reject request has completed
FOnRejectInviteCompleteDelegate  
FOnRejectPartyInvitationComplete Rejecting an invite to a user to join party async task completed callback
FOnRequestCurrentPermissionsComplete Called when a current permissions query has completed
FOnRequestNewPublishPermissionsComplete Called to notify that publish permissions have been updated on the server
FOnRequestNewPublishPermissionsCompleteDelegate  
FOnRequestNewReadPermissionsComplete Called to notify that read permissions have been updated on the server
FOnRequestNewReadPermissionsCompleteDelegate  
FOnRequestPartyInvitationComplete Party update async task completed callback
FOnRequestToJoinPartyComplete Request to join party async task completed callback
FOnRequestUsageInfoComplete Delegate fired when getting usage statistics from the network platform's storage is complete
FOnRequestUsageInfoCompleteDelegate  
FOnResetAllActiveActivitiesComplete Delegate fired when the reset all active activities call has completed
FOnRestoreInvitesComplete Restore invites async task completed callback
FOnRestorePartiesComplete Completion delegates.
FOnResumeActivityComplete Delegate fired when the resume activity call has completed
FOnRevokeAuthTokenCompleteDelegate Delegate executed when we get a user privilege result.
FOnSendInviteComplete Delegate used when an invite send request has completed
FOnSendMessageComplete Send a message from the currently logged in user to a list of recipients
FOnSendMessageCompleteDelegate  
FOnSendPartyInvitationComplete Party invitation sent completed callback
FOnSessionFailure Delegate fired when an unexpected error occurs that impacts session connectivity or use
FOnSessionFailureDelegate  
FOnSessionInviteReceived Called when a user receives a session invitation.
FOnSessionInviteReceivedDelegate  
FOnSessionParticipantJoined Delegate fired when a player has joined a session
FOnSessionParticipantJoinedDelegate  
FOnSessionParticipantLeft Delegate fired when a player has left a session
FOnSessionParticipantLeftDelegate  
FOnSessionParticipantSettingsUpdated Delegate fired when a session's member settings have changed
FOnSessionParticipantSettingsUpdatedDelegate  
FOnSessionSettingsUpdated Delegate fired when a session's settings have changed
FOnSessionSettingsUpdatedDelegate  
FOnSessionUserInviteAccepted Called when a user accepts a session invitation.
FOnSessionUserInviteAcceptedDelegate  
FOnSetActivityAvailabilityComplete Delegate fired when a set activity availability call has completed
FOnSetActivityPriorityComplete Delegate fired when a set activity priority call has completed
FOnSetFriendAliasComplete Delegate used when a set alias request has completed
FOnSetFriendSettingsComplete Delegate used when the query for friends settings has completed
FOnSettingsOperationComplete Delegate used when the friends settings are read
FOnSharePostComplete Called to notify of a post being shared on the server
FOnSharePostCompleteDelegate  
FOnShowSendMessageUIClosedDelegate Delegate executed when the send message UI has been closed
FOnShowStoreUIClosedDelegate Delegate executed when the store UI has been closed
FOnShowVoiceChatUI  
FOnShowWebUrlClosedDelegate Delegate executed when the web url UI has been closed
FOnSingleSessionResultComplete Delegate fired once a single search result is returned (ie friend invite / join) Session has not been joined at this point, and requires a call to JoinSession()
FOnSingleSessionResultCompleteDelegate  
FOnStartActivityComplete Delegate fired when a start activity call has completed
FOnStartMatchmakingComplete Delegate fired when StartMatchmaking completes Related to FOnMatchmakingComplete, but this is not a broadcast delegate
FOnStartSessionComplete Delegate fired when the online session has transitioned to the started state
FOnStartSessionCompleteDelegate  
FOnTapStateChanged  
FOnTitleFileAnalyticsEvent Delegate fired when we would like to report an event to an analytics provider.
FOnTitleFileAnalyticsEventDelegate  
FOnUnblockedPlayerComplete Delegate used when an unblock request has completed
FOnUnblockedPlayerCompleteDelegate  
FOnUnexpectedPurchaseReceipt Delegate called when we are informed of a new receipt we did not initiate in-game
FOnUnexpectedPurchaseReceiptDelegate  
FOnUnregisterDeviceByChannelTypeComplete Delegate used when the unregister device by channel type request is completed
FOnUnregisterLocalPlayerCompleteDelegate Delegate fired when local player unregistration has completed
FOnUnregisterPlayersComplete Delegate fired when the un-registration process has completed
FOnUnregisterPlayersCompleteDelegate  
FOnUpdateGameMatchDetailsComplete Delegate fired when the UpdateGameMatchStatus request has completed
FOnUpdatePartyComplete Party update async task completed callback
FOnUpdateSessionComplete Delegate fired when a update session request has completed
FOnUpdateSessionCompleteDelegate  
FOnUserCloudAnalyticsEvent Delegate fired when we would like to report an event to an analytics provider.
FOnUserCloudAnalyticsEventDelegate  
FOnVoiceChatRoomEntered  
FOnVoiceChatRoomExited  
FOnWriteSharedFileComplete Delegate fired when a shared file write to the network platform's storage is complete
FOnWriteSharedFileCompleteDelegate  
FOnWriteUserFileCanceled Delegate fired when a user file write to the network platform's storage is canceled
FOnWriteUserFileCanceledDelegate  
FOnWriteUserFileComplete Delegate fired when a user file write to the network platform's storage is complete
FOnWriteUserFileCompleteDelegate  
FOnWriteUserFileProgress64 Delegate fired at intervals during a user file write to the network platform's storage
FOnWriteUserFileProgress64Delegate  
FPartyConfigurationConstRef  
FPresenceKey Type of presence keys
FPresenceProperties Type of presence properties - a key/value map
FQuitMatchSignature  
FRemoveMatchSignature  
FTurnBasedEventDelegatePtr  
FTurnBasedEventDelegateRef  
FTurnBasedEventDelegateWeakPtr  
FTurnBasedMatchmakerDelegatePtr  
FTurnBasedMatchmakerDelegateRef  
FTurnBasedMatchmakerDelegateWeakPtr  
FTurnBasedMatchPtr  
FTurnBasedMatchRef  
FUniqueCategoryId  
FUniqueEntitlementId Unique identifier for entitlements
FUniqueMessageId Unique identifier for messages
FUniqueMessageIdPtr  
FUniqueMessageIdRef  
FUniqueMessageIdSet  
FUniqueOfferId  
FUploadMatchDataSignature  
FWarnUserPlayTime Delegate called to warn a user of their play time amount This is called when RewardRate changes, and periodically to remind the user of their play time
FWarnUserPlayTimeDelegate  
IApplications A list of pending membership applications for a given user.
IGroupConfigBool Configuration key->values (boolean)
IGroupConfigInt Configuration key->values (int)
IGroupDenylist A structure for caching a list of people who have been banned from a group
IGroupInvites A structure for caching a list of people that have been invited to join a group
IGroupRequests A structure for caching a list of people who have requested to join the group
IGroupRoster A structure for caching a list of people in the group and their roles
IInvitations A list of pending membership invitations for a given user.
IMessageSanitizerPtr  
IOnlineEntitlementsPtr  
IOnlineExternalUIPtr  
IOnlineFriendsPtr  
IOnlineGroupsPtr  
IOnlineIdentityPtr  
IOnlineLeaderboardsPtr  
IOnlineNotificationTransportPtr  
IOnlinePartyJoinInfoConstPtr  
IOnlinePartyJoinInfoConstRef  
IOnlinePartyPendingJoinRequestInfoConstPtr  
IOnlinePartyPendingJoinRequestInfoConstRef  
IOnlinePartyRequestToJoinInfoConstPtr  
IOnlinePartyRequestToJoinInfoConstRef  
IOnlinePartyUserPendingJoinRequestInfoConstPtr  
IOnlinePartyUserPendingJoinRequestInfoConstRef  
IOnlineSessionPtr  
IOnlineSharedCloudPtr  
IOnlineTimePtr  
IOnlineTitleFilePtr  
IOnlineTitleFileRef  
IOnlineTurnBasedPtr  
IOnlineUserCloudPtr  
IOnlineVoicePtr  
IUserMembership What groups does a particular user currently belong to and what roles do they fill
IVoiceEnginePtr  
VoiceChatRoomId  

Enums

  Type Name Description
Public enum EAcceptPartyInvitationCompletionResult    
Public enum ECreatePartyCompletionResult    
Public enum EFriendsLists::Type List of known friends list types  
Public enum EGroupSortOrder    
Public enum UEnum BlueprintType EInAppPurchaseState::Type Possible result states of an in-app purchase transaction  
Public enum EInvitationResponse    
Public enum EJoinPartyCompletionResult    
Public enum EJoinRequestAction    
Public enum EKickMemberCompletionResult    
Public enum ELeavePartyCompletionResult    
Public enum ELeaveReason Options available when leaving a game match  
Public enum EMatchCoopResults Coop game match results  
Public enum EMatchGroupType Options available for match grouping  
Public enum EMemberConnectionStatus    
Public enum EMemberExitedReason    
Public enum UEnum BlueprintType EMPMatchOutcome::Outcome EMPMatchOutcome represents all the possible outcomes for this player in a match  
Public enum EOnJoinSessionCompleteResult::Type Possible results of a JoinSession attempt  
Public enum EOnlineActivityOutcome Outcome representation of ending an activity.  
Public enum EOnlinePresenceState::Type    
Public enum EOnlineStoreOfferDiscountType    
Public enum EOnlineTournamentFormat What format the tournament is being run as  
Public enum EOnlineTournamentMatchState States this match can be in  
Public enum EOnlineTournamentParticipantState    
Public enum EOnlineTournamentParticipantType What participant format does this tournament support?  
Public enum EOnlineTournamentState What state the tournament is currently in  
Public enum EOnSessionParticipantLeftReason Possible motives for a participant leaving an online session  
Public enum EPartyInvitationRemovedReason    
Public enum EPartyRequestToJoinRemovedReason    
Public enum EPartyState    
Public enum EPartySystemState    
Public enum EPlatformMessageType Union of all the platform informational message types we handle (some may be handled by more than one platform)  
Public enum EPromoteMemberCompletionResult    
Public enum EPurchaseTransactionState State of a purchase transaction  
Public enum ERecentPlayerEncounterType Encounter type of recent player  
Public enum ERejectPartyInvitationCompletionResult    
Public enum ERequestPartyInvitationCompletionResult    
Public enum ERequestToJoinPartyCompletionResult    
Public enum ESendPartyInvitationCompletionResult    
Public enum ESessionFailure::Type Possible reasons for the service to cause a session failure  
Public enum EShowPrivilegeResolveUI Whether to show UI to resolve the privilege if there is no access when GetUserPrivilege  
Public enum EUpdateConfigCompletionResult    
Public enum EUpdateGameMatchStatus Options available for updating game match status  
Public enum EUserPrivileges::Type    
Public enum EVoiceChatRoomState    
Public enum PartySystemPermissions::EPermissionType Who has permissions to perform party actions  

Functions

  Type Name Description
Public function bool

EFriendsLists::FromString ( EFriendsLists::Type& OutEnum,
const TCHAR* InString
)

  
Public function const TCHAR *  
Public function EOnlinePresenceState::Type  
Public function const FText  
Public function const TCHAR *  
Public function EOnlineStoreOfferDiscountType  
Public function EPartyState

EPartyStateFromString ( const TCHAR* Value
)

  
Public function EJoinRequestAction  
Public function void

LexFromString ( TOptional< EOnlineTournamentMatchState >& State,
const TCHAR*const String
)

  
Public function void

LexFromString ( TOptional< EOnlineTournamentFormat >& Format,
const TCHAR*const String
)

  
Public function void

LexFromString ( TOptional< EOnlineTournamentState >& State,
const TCHAR*const String
)

  
Public function void  
Public function void  
Public function FString  
Public function FString  
Public function FString  
Public function FString

LexToString ( const EOnlineTournamentParticipantType ParticipantType
)

  
Public function const TCHAR * Convert a ESessionFailure into a string
Public function FString

LexToString ( const EOnlineTournamentMatchState ParticipantType
)

  
Public function const TCHAR *  
Public function const TCHAR *  
Public function const TCHAR * Convert a EOnJoinSessionCompleteResult into a string
Public function PartySystemPermissions::EPermissionType  
Public function FString

ToDebugString ( const FOnlinePartyData& PartyData
)

 Dump state about the party data for debugging
Public function FString Dump key/value pairs for debugging
Public function FString

ToDebugString ( const FPartyConfiguration& PartyConfiguration
)

 Dump party configuration for debugging
Public function FString

ToDebugString ( const IOnlinePartyJoinInfo& JoinInfo
)

 Dump join info for debugging
Public function FString  
Public function FString  
Public function FString

ToDebugString ( const FControllerPairingChangedUserInfo& ControllerPairingChangedUserInfo
)

  
Public function const TCHAR *  
Public function const TCHAR *  
Public function const TCHAR *  
Public function const TCHAR *

ToString ( const EInvitationResponse Value
)

  
Public function const TCHAR *  
Public function const TCHAR *  
Public function const TCHAR *  
Public function const TCHAR *  
Public function const TCHAR *  
Public function const TCHAR *  
Public function const TCHAR *  
Public function const TCHAR *  
Public function const TCHAR *

ToString ( const EMemberExitedReason Value
)

  
Public function const TCHAR *

ToString ( const EPartyState Value
)

  
Public function const TCHAR *  
Public function const TCHAR *  
Public function const TCHAR *

ToString ( const EJoinRequestAction Value
)

  

Variables

  Type Name Description
Public variable const FString CustomPresenceDataKey Custom presence data that is not seen by users but can be polled
Public variable const FString DefaultAppIdKey Name of the client that sent the presence update
Public variable FName DefaultPartyDataNamespace  
Public variable const FString DefaultPlatformKey Platform of the client that sent the presence update
Public variable const FString DefaultPresenceKey The default key that will update presence text in the platform's UI
Public variable const FString DefaultProductNameKey User friendly name of the client that sent the presence update
Public variable const FString DefaultSessionIdKey Id of the session for the presence update.

Id of the session for the presence update. |

Public variable const FString OverrideAppIdKey Override Id of the client to set the presence state to
Public variable const FString PresenceResourceKey Resource the client is logged in with

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page