description: Gets the name of this node, shown in title bar

code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetNodeTitle ( [ENodeTitleType::Type](API\Runtime\Engine\EdGraph\ENodeTitleType__Type) TitleType ) const


description:
Override to provide a default category for specific node types to be listed under.
A localized category string (or an empty string if you want this node listed at the menu's root).

module: OnlineBlueprintSupport

code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetMenuCategory() const


description: Gets the tooltip to display when over the node

code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetTooltipText() const


code: UK2Node_LeaderboardFlush ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UK2Node_LeaderboardFlush : public [UK2Node_BaseAsyncTask](API\Editor\BlueprintGraph\UK2Node_BaseAsyncTask)


code: UK2Node_LeaderboardQuery ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UK2Node_LeaderboardQuery : public [UK2Node_BaseAsyncTask](API\Editor\BlueprintGraph\UK2Node_BaseAsyncTask)


module: OnlineServicesCommon

code: template<typename T> auto Requires()


className: CLocalAccountIdDefined

code: struct CLocalAccountIdDefined


code: template<typename T> auto Requires ( uint32 & Result, const T & Val )


className: COnlineGetTypeHashable

description: Different than the standardCGetTypeHashableas we want to detect GetTypeHash using more than the standard name lookup rules.

code: struct COnlineGetTypeHashable


code: virtual void DoRegister ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAccountInfo](API\Plugins\OnlineServicesInterface\Online\FAccountInfo) > & AccountInfo )


code: virtual void DoUnregister ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAccountInfo](API\Plugins\OnlineServicesInterface\Online\FAccountInfo) > & AccountInfo )


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FAccountInfo](API\Plugins\OnlineServicesInterface\Online\FAccountInfo) > Find ( [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) PlatformUserId ) const


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FAccountInfo](API\Plugins\OnlineServicesInterface\Online\FAccountInfo) > Find ( [FAccountId](API\Runtime\CoreOnline\Online\FAccountId) AccountId ) const


code: [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAccountInfo](API\Plugins\OnlineServicesInterface\Online\FAccountInfo) > > GetAllAccountInfo ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool(const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAccountInfo](API\Plugins\OnlineServicesInterface\Online\FAccountInfo) > &)> Predicate ) const


code: virtual ~FAccountInfoRegistry()


className: FAccountInfoRegistry

code: class FAccountInfoRegistry

IndexLock

type: FRWLock


description: Launch the platform UI for a particular achievement

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FDisplayAchievementUI](API\Plugins\OnlineServicesInterface\Online\FDisplayAchievementUI) > DisplayAchievementUI ( [FDisplayAchievementUI::Params](API\Plugins\OnlineServicesInterface\Online\FDisplayAchievementUI\Params) && Params )


code: void ExecuteUnlockRulesRelatedToStat ( const [FAccountId](API\Runtime\CoreOnline\Online\FAccountId) & AccountId, const [FString](API\Runtime\Core\Containers\FString) & StatName, const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FStatValue](API\Plugins\OnlineServicesInterface\Online\FStatValue) > & Stats, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutAchievementsToUnlock )


className: FAchievementStateMap


description: Gets an achievement definition by id. Requires first calling QueryAchievementDefinitions.

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FGetAchievementDefinition](API\Plugins\OnlineServicesInterface\Online\FGetAchievementDefinition) > GetAchievementDefinition ( [FGetAchievementDefinition::Params](API\Plugins\OnlineServicesInterface\Online\FGetAchievementDefinition\Params) && Params )


description: Gets the achievement id's. Requires first calling QueryAchievementDefinitions.

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FGetAchievementIds](API\Plugins\OnlineServicesInterface\Online\FGetAchievementIds) > GetAchievementIds ( [FGetAchievementIds::Params](API\Plugins\OnlineServicesInterface\Online\FGetAchievementIds\Params) && Params )


description: Gets the state of an achievement by id for the given player. Requires first calling QueryAchievementStates.

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FGetAchievementState](API\Plugins\OnlineServicesInterface\Online\FGetAchievementState) > GetAchievementState ( [FGetAchievementState::Params](API\Plugins\OnlineServicesInterface\Online\FGetAchievementState\Params) && Params ) const


description: TOnlineComponent.

code: virtual void Initialize()


code: bool IsUnlocked ( const [FAccountId](API\Runtime\CoreOnline\Online\FAccountId) & AccountId, const [FString](API\Runtime\Core\Containers\FString) & AchievementName ) const


code: bool MeetUnlockCondition ( const [FAchievementUnlockRule](API\Plugins\OnlineServicesCommon\Online\FAchievementUnlockRule) & AchievementUnlockRule, const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FStatValue](API\Plugins\OnlineServicesInterface\Online\FStatValue) > & Stats )


description: Event triggered when a player's achievement state changes


code: void OnAchievementStatesQueried ( const [FAccountId](API\Runtime\CoreOnline\Online\FAccountId) & AccountId )


description: IAchievements.


description: Query the state of all achievements for the given player. Requires first calling QueryAchievementDefinitions.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FQueryAchievementStates](API\Plugins\OnlineServicesInterface\Online\FQueryAchievementStates) > QueryAchievementStates ( [FQueryAchievementStates::Params](API\Plugins\OnlineServicesInterface\Online\FQueryAchievementStates\Params) && Params )


code: virtual void RegisterCommands()


description: Called right before the component is destroyed. It is not safe to reference any other components at this time.

code: virtual void Shutdown()


code: void UnlockAchievementsByStats ( const [FStatsUpdated](API\Plugins\OnlineServicesInterface\Online\FStatsUpdated) & StatsUpdated )


description: Manually unlock achievements Requires first calling QueryAchievementStates.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FUnlockAchievements](API\Plugins\OnlineServicesInterface\Online\FUnlockAchievements) > UnlockAchievements ( [FUnlockAchievements::Params](API\Plugins\OnlineServicesInterface\Online\FUnlockAchievements\Params) && Params )


code: FAchievementsCommon ( [FOnlineServicesCommon](API\Plugins\OnlineServicesCommon\Online\FOnlineServicesCommon) & InServices )


description: Called whenever we need to reload data from config.

code: virtual void UpdateConfig()


className: FAchievementsCommon

code: class FAchievementsCommon : public [UE::Online::TOnlineComponent< IAchievements >](API\Plugins\OnlineServicesCommon\Online\TOnlineComponent)

AchievementStates

type: TMap<FAccountI...

Config

type: FAchievementsCo...

OnAchievementStateUpdatedEvent

type: TOnlineEventCal...

StatEventHandle

type: FOnlineEventDel...


className: FAchievementsCommonConfig

code: struct FAchievementsCommonConfig

bIsTitleManaged

type: bool

UnlockRules

type: TArray<FAchiev...


className: FAchievementUnlockCondition

code: struct FAchievementUnlockCondition

StatName

type: FString

UnlockThreshold

type: FStatValue


code: bool ContainsStat ( const [FString](API\Runtime\Core\Containers\FString) & StatName ) const


className: FAchievementUnlockRule

code: struct FAchievementUnlockRule


description: Creating a verified auth session will generate a FVerifiedAuthSessionId. This id is a cryptographically secure random id intended to be transmitted between the established peers to refer to the remote auth session. This id is needed when the client changes how they communicate with the server. An example is connecting to a server reservation beacon to reserve a spot before traveling to the server url using a different connection.


description: Cancels the ticket associated with a verified auth session. When the session created using a verified auth ticket is no longer in use, CancelVerifiedAuthTicket must be called to clean up any resources associated with the ticket.


code: const [FAccountInfoRegistry](API\Plugins\OnlineServicesCommon\Online\FAccountInfoRegistry) & GetAccountInfoRegistry() const


description: Clean up the remote verified auth session and handle any required book-keeping.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FAuthEndVerifiedAuthSession](API\Plugins\OnlineServicesInterface\Online\FAuthEndVerifiedAuthSession) > EndVerifiedAuthSession ( [FAuthEndVerifiedAuthSession::Params](API\Plugins\OnlineServicesInterface\Online\FAuthEndVerifiedAuthSession\Params) && Params )


description: Retrieve all logged in user accounts.

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FAuthGetAllLocalOnlineUsers](API\Plugins\OnlineServicesInterface\Online\FAuthGetAllLocalOnlineUsers) > GetAllLocalOnlineUsers ( [FAuthGetAllLocalOnlineUsers::Params](API\Plugins\OnlineServicesInterface\Online\FAuthGetAllLocalOnlineUsers\Params) && Params ) const


description: Retrieve a logged in user account.

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FAuthGetLocalOnlineUserByOnlineAccountId](API\Plugins\OnlineServicesInterface\Online\FAuthGetLocalOnl-) > GetLocalOnlineUserByOnlineAccountId ( [FAuthGetLocalOnlineUserByOnlineAccountId::Params](API\Plugins\OnlineServicesInterface\Online\FAuthGetLocalOnl-\Params) && Params ) const


description: Retrieve a logged in user account.

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FAuthGetLocalOnlineUserByPlatformUserId](API\Plugins\OnlineServicesInterface\Online\FAuthGetLocalOnl-_1) > GetLocalOnlineUserByPlatformUserId ( [FAuthGetLocalOnlineUserByPlatformUserId::Params](API\Plugins\OnlineServicesInterface\Online\FAuthGetLocalOnl-_1\Params) && Params ) const


description: Helper for querying the login status of a local user.

code: virtual bool IsLoggedIn ( const [FAccountId](API\Runtime\CoreOnline\Online\FAccountId) & AccountId ) const


description: IAuth.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FAuthLogin](API\Plugins\OnlineServicesInterface\Online\FAuthLogin) > Login ( [FAuthLogin::Params](API\Plugins\OnlineServicesInterface\Online\FAuthLogin\Params) && Params )


description: Concludes the auth session for the local user.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FAuthLogout](API\Plugins\OnlineServicesInterface\Online\FAuthLogout) > Logout ( [FAuthLogout::Params](API\Plugins\OnlineServicesInterface\Online\FAuthLogout\Params) && Params )


description: Modify attributes associated with an authenticated account. Signals OnAccountAttributesChanged on completion.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FAuthModifyAccountAttributes](API\Plugins\OnlineServicesInterface\Online\FAuthModifyAccountAttributes) > ModifyAccountAttributes ( [FAuthModifyAccountAttributes::Params](API\Plugins\OnlineServicesInterface\Online\FAuthModifyAccountAttributes\Params) && Params )


description: Triggered when the additional attributes associated with an authenticated account are changed.


description: Triggered when the login status for a logged in user changes.


description: Triggered when the auth token will expire soon. Services which allow login using an external auth token may trigger this notification when an updated external auth token is required to maintain the auth session without interruption.


description: Retrieves a token appropriate for linking the service account with a service account of a different service type. On most platforms this will return an OpenId token. May return a cached token, but will handle refreshing if necessary.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FAuthQueryExternalAuthToken](API\Plugins\OnlineServicesInterface\Online\FAuthQueryExternalAuthToken) > QueryExternalAuthToken ( [FAuthQueryExternalAuthToken::Params](API\Plugins\OnlineServicesInterface\Online\FAuthQueryExternalAuthToken\Params) && Params )


description: It is the responsibility of the game code to provide an audience enumeration value appropriate for the usage.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FAuthQueryVerifiedAuthTicket](API\Plugins\OnlineServicesInterface\Online\FAuthQueryVerifiedAuthTicket) > QueryVerifiedAuthTicket ( [FAuthQueryVerifiedAuthTicket::Params](API\Plugins\OnlineServicesInterface\Online\FAuthQueryVerifiedAuthTicket\Params) && Params )


description: Queries a ticket which is appropriate for making server-to-server calls on behalf of the signed in user. Tickets are intended to be single use - users must call the API again to retrieve a new ticket when making repeated calls which use a ticket.


description: IOnlineComponent.

code: virtual void RegisterCommands()


code: FAuthCommon ( [FOnlineServicesCommon](API\Plugins\OnlineServicesCommon\Online\FOnlineServicesCommon) & InServices )


className: FAuthCommon

code: class FAuthCommon : public [UE::Online::TOnlineComponent< IAuth >](API\Plugins\OnlineServicesCommon\Online\TOnlineComponent)


description: Initiate the checkout process for purchasing one or more offers

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FCommerceCheckout](API\Plugins\OnlineServicesInterface\Online\FCommerceCheckout) > Checkout ( [FCommerceCheckout::Params](API\Plugins\OnlineServicesInterface\Online\FCommerceCheckout\Params) && Params )


description: Get the complete list of cached entitlements

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FCommerceGetEntitlements](API\Plugins\OnlineServicesInterface\Online\FCommerceGetEntitlements) > GetEntitlements ( [FCommerceGetEntitlements::Params](API\Plugins\OnlineServicesInterface\Online\FCommerceGetEntitlements\Params) && Params )


description: CommerceCommon.

code: [FText](API\Runtime\Core\Internationalization\FText) GetFormattedPrice ( uint64 Price, int32 DecimalPoint, [FString](API\Runtime\Core\Containers\FString) CurrencyCode )


description: Get the complete list of cached offers

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FCommerceGetOffers](API\Plugins\OnlineServicesInterface\Online\FCommerceGetOffers) > GetOffers ( [FCommerceGetOffers::Params](API\Plugins\OnlineServicesInterface\Online\FCommerceGetOffers\Params) && Params )


description: Get the offers for a list of offer ids

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FCommerceGetOffersById](API\Plugins\OnlineServicesInterface\Online\FCommerceGetOffersById) > GetOffersById ( [FCommerceGetOffersById::Params](API\Plugins\OnlineServicesInterface\Online\FCommerceGetOffersById\Params) && Params )


description: Fires whenever a purchase is completed


description: Get the list of all entitlements

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FCommerceQueryEntitlements](API\Plugins\OnlineServicesInterface\Online\FCommerceQueryEntitlements) > QueryEntitlements ( [FCommerceQueryEntitlements::Params](API\Plugins\OnlineServicesInterface\Online\FCommerceQueryEntitlements\Params) && Params )


description: ICommerce.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FCommerceQueryOffers](API\Plugins\OnlineServicesInterface\Online\FCommerceQueryOffers) > QueryOffers ( [FCommerceQueryOffers::Params](API\Plugins\OnlineServicesInterface\Online\FCommerceQueryOffers\Params) && Params )


description: Query the offers matching specified offer ids

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FCommerceQueryOffersById](API\Plugins\OnlineServicesInterface\Online\FCommerceQueryOffersById) > QueryOffersById ( [FCommerceQueryOffersById::Params](API\Plugins\OnlineServicesInterface\Online\FCommerceQueryOffersById\Params) && Params )


description: Retrieve the list of entitlements from a transaction id returned from a checkout call


description: Mark an entitlement as redeemed. Used when there is no external service managing redemption of entitlements or the redemption must be done on the client side

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FCommerceRedeemEntitlement](API\Plugins\OnlineServicesInterface\Online\FCommerceRedeemEntitlement) > RedeemEntitlement ( [FCommerceRedeemEntitlement::Params](API\Plugins\OnlineServicesInterface\Online\FCommerceRedeemEntitlement\Params) && Params )


description: Bring up the platform store ui

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FCommerceShowStoreUI](API\Plugins\OnlineServicesInterface\Online\FCommerceShowStoreUI) > ShowStoreUI ( [FCommerceShowStoreUI::Params](API\Plugins\OnlineServicesInterface\Online\FCommerceShowStoreUI\Params) && Params )


description: Get a token suitable for making service to service Commerce related calls

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FCommerceRetrieveS2SToken](API\Plugins\OnlineServicesInterface\Online\FCommerceRetrieveS2SToken) > RetrieveS2SToken ( [FCommerceRetrieveS2SToken::Params](API\Plugins\OnlineServicesInterface\Online\FCommerceRetrieveS2SToken\Params) && Params )


code: FCommerceCommon ( [FOnlineServicesCommon](API\Plugins\OnlineServicesCommon\Online\FOnlineServicesCommon) & InServices )


className: FCommerceCommon

code: class FCommerceCommon : public [UE::Online::TOnlineComponent< ICommerce >](API\Plugins\OnlineServicesCommon\Online\TOnlineComponent)


description: IConnectivity.

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FGetConnectionStatus](API\Plugins\OnlineServicesInterface\Online\FGetConnectionStatus) > GetConnectionStatus ( [FGetConnectionStatus::Params](API\Plugins\OnlineServicesInterface\Online\FGetConnectionStatus\Params) && Params )


description: Event triggered when the connection status changes


description: TOnlineComponent.

code: virtual void RegisterCommands()


code: FConnectivityCommon ( [FOnlineServicesCommon](API\Plugins\OnlineServicesCommon\Online\FOnlineServicesCommon) & InServices )


className: FConnectivityCommon

code: class FConnectivityCommon : public [UE::Online::TOnlineComponent< IConnectivity >](API\Plugins\OnlineServicesCommon\Online\TOnlineComponent)

ConnectionStatus

type: EOnlineServices...


description: Event triggered when an external UI's status changes


description: Shows the online service's friends UI

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FExternalUIShowFriendsUI](API\Plugins\OnlineServicesInterface\Online\FExternalUIShowFriendsUI) > ShowFriendsUI ( [FExternalUIShowFriendsUI::Params](API\Plugins\OnlineServicesInterface\Online\FExternalUIShowFriendsUI\Params) && Params )


description: IExternalUI.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FExternalUIShowLoginUI](API\Plugins\OnlineServicesInterface\Online\FExternalUIShowLoginUI) > ShowLoginUI ( [FExternalUIShowLoginUI::Params](API\Plugins\OnlineServicesInterface\Online\FExternalUIShowLoginUI\Params) && Params )


code: FExternalUICommon ( [FOnlineServicesCommon](API\Plugins\OnlineServicesCommon\Online\FOnlineServicesCommon) & InServices )


className: FExternalUICommon

code: class FExternalUICommon : public [UE::Online::TOnlineComponent< IExternalUI >](API\Plugins\OnlineServicesCommon\Online\TOnlineComponent)


code: bool operator() ( const [FUserStats](API\Plugins\OnlineServicesInterface\Online\FUserStats) & UserStats ) const


code: FFindUserStatsByAccountId ( const [FAccountId](API\Runtime\CoreOnline\Online\FAccountId) & InAccountId )


className: FFindUserStatsByAccountId

code: struct FFindUserStatsByAccountId

AccountId

type: FAccountId


className: Name

code: static constexpr TCHAR Name = TEXT("FunctionalTest");


className: FFunctionalTestLobbies

code: struct FFunctionalTestLobbies


code: static constexpr TCHAR Name = TEXT("GetMutableSessionById");


className: Params

code: struct Params

SessionId

type: FOnlineSessionI...


className: Result

code: struct Result

Session

type: TSharedRef<FSe...


className: FGetMutableSessionById

code: struct FGetMutableSessionById


code: static constexpr TCHAR Name = TEXT("GetMutableSessionByName");


LocalName

type: FName


className: FGetMutableSessionByName

code: struct FGetMutableSessionByName


className: FLeaderboardDefinition

code: struct FLeaderboardDefinition

Id

description: Corresponding leaderboard id on the platform if needed

Name

description: The name of the leaderboard

OrderMethod

type: ELeaderboardOrd...

description: How the leaderboard score will be ordered

UpdateMethod

type: ELeaderboardUpd...

description: How the leaderboard score will be updated


description: TOnlineComponent.

code: virtual void Initialize()


description: Read leaderboard entries around specified rank index

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FReadEntriesAroundRank](API\Plugins\OnlineServicesInterface\Online\FReadEntriesAroundRank) > ReadEntriesAroundRank ( [FReadEntriesAroundRank::Params](API\Plugins\OnlineServicesInterface\Online\FReadEntriesAroundRank\Params) && Params )


description: ILeaderboards.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FReadEntriesForUsers](API\Plugins\OnlineServicesInterface\Online\FReadEntriesForUsers) > ReadEntriesForUsers ( [FReadEntriesForUsers::Params](API\Plugins\OnlineServicesInterface\Online\FReadEntriesForUsers\Params) && Params )


description: Read leaderboard entries around specified user. If the Offset is bigger than the Limit, the user may not appear in the returned entries. It makes sense in situations like getting prev page of users above my rank

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FReadEntriesAroundUser](API\Plugins\OnlineServicesInterface\Online\FReadEntriesAroundUser) > ReadEntriesAroundUser ( [FReadEntriesAroundUser::Params](API\Plugins\OnlineServicesInterface\Online\FReadEntriesAroundUser\Params) && Params )


code: virtual void RegisterCommands()


description: Called whenever we need to reload data from config.

code: virtual void UpdateConfig()


description: Internal use only, for stats common implementation.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FWriteLeaderboardScores](API\Plugins\OnlineServicesCommon\Online\FWriteLeaderboardScores) > WriteLeaderboardScores ( [FWriteLeaderboardScores::Params](API\Plugins\OnlineServicesCommon\Online\FWriteLeaderboardScores\Params) && Params )


code: void WriteLeaderboardsByStats ( const [FStatsUpdated](API\Plugins\OnlineServicesInterface\Online\FStatsUpdated) & StatsUpdated )


code: FLeaderboardsCommon ( [FOnlineServicesCommon](API\Plugins\OnlineServicesCommon\Online\FOnlineServicesCommon) & InServices )


className: FLeaderboardsCommon

code: class FLeaderboardsCommon : public [UE::Online::TOnlineComponent< ILeaderboards >](API\Plugins\OnlineServicesCommon\Online\TOnlineComponent)

LeaderboardDefinitions

type: TMap<FString, ...


className: FLeaderboardsCommonConfig

code: struct FLeaderboardsCommonConfig

type: TArray<FLeader...


description: ILobbies.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FCreateLobby](API\Plugins\OnlineServicesInterface\Online\FCreateLobby) > CreateLobby ( [FCreateLobby::Params](API\Plugins\OnlineServicesInterface\Online\FCreateLobby\Params) && Params )


description: Decline an invitation to join a lobby.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FDeclineLobbyInvitation](API\Plugins\OnlineServicesInterface\Online\FDeclineLobbyInvitation) > DeclineLobbyInvitation ( [FDeclineLobbyInvitation::Params](API\Plugins\OnlineServicesInterface\Online\FDeclineLobbyInvitation\Params) && Params )


description: Search for lobbies using filtering parameters.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FFindLobbies](API\Plugins\OnlineServicesInterface\Online\FFindLobbies) > FindLobbies ( [FFindLobbies::Params](API\Plugins\OnlineServicesInterface\Online\FFindLobbies\Params) && Params )


code: [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FFunctionalTestLobbies](API\Plugins\OnlineServicesCommon\Online\FFunctionalTestLobbies) > FunctionalTest ( [FFunctionalTestLobbies::Params](API\Plugins\OnlineServicesCommon\Online\FFunctionalTestLobbies\Params) && Params )


description: Retrieve the list of joined lobbies for the target local user.

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FGetJoinedLobbies](API\Plugins\OnlineServicesInterface\Online\FGetJoinedLobbies) > GetJoinedLobbies ( [FGetJoinedLobbies::Params](API\Plugins\OnlineServicesInterface\Online\FGetJoinedLobbies\Params) && Params )


description: Params for the GetPresenceLobby call

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FGetPresenceLobby](API\Plugins\OnlineServicesInterface\Online\FGetPresenceLobby) > GetPresenceLobby ( [FGetPresenceLobby::Params](API\Plugins\OnlineServicesInterface\Online\FGetPresenceLobby\Params) && Params )


description: Retrieve the list of received invitations for the target local user.

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FGetReceivedInvitations](API\Plugins\OnlineServicesInterface\Online\FGetReceivedInvitations) > GetReceivedInvitations ( [FGetReceivedInvitations::Params](API\Plugins\OnlineServicesInterface\Online\FGetReceivedInvitations\Params) && Params )


description: TOnlineComponent.

code: virtual void Initialize()


description: Invite a player to join a lobby.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FInviteLobbyMember](API\Plugins\OnlineServicesInterface\Online\FInviteLobbyMember) > InviteLobbyMember ( [FInviteLobbyMember::Params](API\Plugins\OnlineServicesInterface\Online\FInviteLobbyMember\Params) && Params )


description: Params for the IsPresenceLobby call

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FIsPresenceLobby](API\Plugins\OnlineServicesInterface\Online\FIsPresenceLobby) > IsPresenceLobby ( [FIsPresenceLobby::Params](API\Plugins\OnlineServicesInterface\Online\FIsPresenceLobby\Params) && Params )


description: Join a lobby using its id.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FJoinLobby](API\Plugins\OnlineServicesInterface\Online\FJoinLobby) > JoinLobby ( [FJoinLobby::Params](API\Plugins\OnlineServicesInterface\Online\FJoinLobby\Params) && Params )


description: Leave a joined lobby.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FLeaveLobby](API\Plugins\OnlineServicesInterface\Online\FLeaveLobby) > LeaveLobby ( [FLeaveLobby::Params](API\Plugins\OnlineServicesInterface\Online\FLeaveLobby\Params) && Params )


description: Kick a member from a the target lobby.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FKickLobbyMember](API\Plugins\OnlineServicesInterface\Online\FKickLobbyMember) > KickLobbyMember ( [FKickLobbyMember::Params](API\Plugins\OnlineServicesInterface\Online\FKickLobbyMember\Params) && Params )


description: Change the attributes applied to the lobby. Only the lobby leader may change the lobby attributes. Attributes are validated against the lobby schema before an update can succeed.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FModifyLobbyAttributes](API\Plugins\OnlineServicesInterface\Online\FModifyLobbyAttributes) > ModifyLobbyAttributes ( [FModifyLobbyAttributes::Params](API\Plugins\OnlineServicesInterface\Online\FModifyLobbyAttributes\Params) && Params )


description: Change the join policy applied to the lobby. Only the lobby leader may change the join policy.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FModifyLobbyJoinPolicy](API\Plugins\OnlineServicesInterface\Online\FModifyLobbyJoinPolicy) > ModifyLobbyJoinPolicy ( [FModifyLobbyJoinPolicy::Params](API\Plugins\OnlineServicesInterface\Online\FModifyLobbyJoinPolicy\Params) && Params )


description: Change the attributes applied to a lobby member. Lobby members may only change their own attributes. Attributes are validated against the lobby schema before an update can succeed.


description: Change the schema applied to the lobby and member attributes. Only the lobby leader may change the schema. Existing attributes not present in the new schema will be cleared.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FModifyLobbySchema](API\Plugins\OnlineServicesInterface\Online\FModifyLobbySchema) > ModifyLobbySchema ( [FModifyLobbySchema::Params](API\Plugins\OnlineServicesInterface\Online\FModifyLobbySchema\Params) && Params )


description:
Get the event that is triggered when lobby attributes have changed.
Event that can be bound to


description:
Get the event that is triggered when an invitation is received.
Event that can be bound to


description:
Get the event that is triggered when an invitation is removed.
Event that can be bound to


description:
Get the event that is triggered when a lobby is joined. This will happen as a result of creating or joining a lobby.
Event that can be bound to

code: virtual [TOnlineEvent](API\Plugins\OnlineServicesInterface\Online\TOnlineEvent)< void(const [FLobbyJoined](API\Plugins\OnlineServicesInterface\Online\FLobbyJoined) &)> OnLobbyJoined()


description:
Get the event that is triggered when the leadership of a lobby changes.
Event that can be bound to


description:
Get the event that is triggered when a lobby has been left by all local members.
Event that can be bound to

code: virtual [TOnlineEvent](API\Plugins\OnlineServicesInterface\Online\TOnlineEvent)< void(const [FLobbyLeft](API\Plugins\OnlineServicesInterface\Online\FLobbyLeft) &)> OnLobbyLeft()


description:
Get the event that is triggered when a lobby member leaves a joined lobby.
Event that can be bound to

code: virtual [TOnlineEvent](API\Plugins\OnlineServicesInterface\Online\TOnlineEvent)< void(const [FLobbyMemberLeft](API\Plugins\OnlineServicesInterface\Online\FLobbyMemberLeft) &)> OnLobbyMemberLeft()


description:
Get the event that is triggered when lobby member attributes have changed.
Event that can be bound to


description:
Get the event that is triggered when a lobby member joins. This will happen as a result of creating or joining a lobby for local users, and will trigger when a remote user joins.
Event that can be bound to


description:
Get the event that is triggered when a join is requested through an external mechanism.
Event that can be bound to


description:
Get the event that is triggered when the attribute schema of a lobby changes.
Event that can be bound to


description: Promote another lobby member to leader. The local user must be the current lobby leader to promote another member.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FPromoteLobbyMember](API\Plugins\OnlineServicesInterface\Online\FPromoteLobbyMember) > PromoteLobbyMember ( [FPromoteLobbyMember::Params](API\Plugins\OnlineServicesInterface\Online\FPromoteLobbyMember\Params) && Params )


code: virtual void RegisterCommands()


description: Try to rejoin previously joined lobbies.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FRestoreLobbies](API\Plugins\OnlineServicesInterface\Online\FRestoreLobbies) > RestoreLobbies ( [FRestoreLobbies::Params](API\Plugins\OnlineServicesInterface\Online\FRestoreLobbies\Params) && Params )


code: FLobbiesCommon ( [FOnlineServicesCommon](API\Plugins\OnlineServicesCommon\Online\FOnlineServicesCommon) & InServices )


className: FLobbiesCommon

code: class FLobbiesCommon : public [UE::Online::TOnlineComponent< ILobbies >](API\Plugins\OnlineServicesCommon\Online\TOnlineComponent)

LobbyEvents

type: FLobbyEvents

PresenceLobbiesUserMap

type: TMap<FAccountI...

SchemaRegistry

type: TSharedRef<FSc...


className: FLobbiesSchemaCategoryInstance

description: Alias for schema category instance used by lobby and lobby member data.


className: FLobbyClientAttributeChanges

code: struct FLobbyClientAttributeChanges

RemovedAttributes

type: TSet<FSchemaAt...

description: Attributes to be removed.

UpdatedAttributes

type: TMap<FSchemaAt...

description: New or changed attributes.


className: FLobbyClientChanges

description: Local changes to a lobby to be applied to the service.

code: struct FLobbyClientChanges

Attributes

type: TOptional<FLob...

description: Setting for changing lobby attributes.

JoinPolicy

type: TOptional<ELob...

description: Setting for new join policy.

KickedTargetMember

type: TOptional<FAcc...

description: Setting for kicking the target lobby member.

LobbySchema

type: TOptional<FSch...

description: Setting for lobby schema change.

LocalName

type: TOptional<FNam...

description: Local name for the lobby.

LocalUserLeaveReason

description: Setting for removing the local user.

MemberAttributes

description: Setting for adding or updating the local user.

OwnerAccountId

description: Setting for lobby ownership change.


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FLobbyMemberInternal](API\Plugins\OnlineServicesCommon\Online\FLobbyMemberInternal) > GetMemberData ( [FAccountId](API\Runtime\CoreOnline\Online\FAccountId) MemberAccountId ) const


code: const [FLobby](API\Plugins\OnlineServicesInterface\Online\FLobby) & GetPublicData() const


code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FLobby](API\Plugins\OnlineServicesInterface\Online\FLobby) > GetPublicDataPtr() const


code: [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FLobbyClientDataPrepareClientChanges](API\Plugins\OnlineServicesCommon\Online\FLobbyClientDataPrepareClientCha-) > PrepareClientChanges ( [FLobbyClientDataPrepareClientChanges::Params](API\Plugins\OnlineServicesCommon\Online\FLobbyClientDataPrepareClientCha-\Params) && Params ) const


description: Apply updated lobby data and generate changes. The LeaveReason provides context for members who have left since the most recent snapshot. Changing a lobby generates events for the local client.


code: FLobbyClientData ( [FLobbyId](API\Runtime\CoreOnline\Online\FLobbyId) LobbyId, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FSchemaRegistry](API\Plugins\OnlineServicesInterface\Online\FSchemaRegistry) > & InSchemaRegistry )


className: FLobbyClientData

description: Lobby data as seen by the client.

code: struct FLobbyClientData


code: struct Params

LobbyEvents

type: FLobbyEvents&#...

description: Notifier for signaling client events on data change.


code: struct Result

LeavingLocalMembers

type: TArray<FAccoun...

description: List of local members leaving the lobby.


className: FLobbyClientDataCommitClientChanges


className: FLobbyClientDataCommitServiceSnapshot


ClientChanges

type: FLobbyClientCha...

description: Changes to be applied to service data.

LocalAccountId

type: FAccountId

description: The local user who is making the changes.


ServiceChanges

type: FLobbyClientSer...

description: Translated changes to be applied to the service.


className: FLobbyClientDataPrepareClientChanges


LeaveReasons

description: Any leaving members notified by the service.

LobbyMemberSnapshots

description: Full snapshot for each member from the service.

LobbySnapshot

type: FLobbyServiceSn...

description: Full snapshot from the service.


className: FLobbyClientDataPrepareServiceSnapshot


className: FLobbyClientMemberAttributeChanges

RemovedAttributes

description: Attributes to be removed.

UpdatedAttributes

description: New or changed attributes.


className: FLobbyClientServiceChanges

description: Local changes to a lobby translated to the changes which will be applied to the service.

code: struct FLobbyClientServiceChanges

JoinPolicy

description: Setting for new join policy.

KickedTargetMember

description: Target member to be kicked.

OwnerAccountId

description: Setting for lobby ownership change.

RemovedAttributes

type: TSet<FSchemaSe...

description: Removed lobby attribute ids.

RemovedMemberAttributes

description: Removed lobby member attribute ids.

type: TMap<FSchemaSe...

description: Added or changed lobby attributes and their values.

UpdatedMemberAttributes

description: Added or changed lobby member attributes and their values.


className: FLobbyEvents

code: struct FLobbyEvents

OnLobbyAttributesChanged

type: TOnlineEventCal...


code: FLobbyInternal ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FSchemaRegistry](API\Plugins\OnlineServicesInterface\Online\FSchemaRegistry) > & SchemaRegistry )


className: FLobbyInternal

description: Lobby data structure as seen by the client with additional fields for internal use.

code: struct FLobbyInternal : public [UE::Online::FLobby](API\Plugins\OnlineServicesInterface\Online\FLobby)

SchemaData

type: FLobbiesSchemaC...


code: FLobbyMemberInternal ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FSchemaRegistry](API\Plugins\OnlineServicesInterface\Online\FSchemaRegistry) > & SchemaRegistry )


className: FLobbyMemberInternal

description: Lobby member data structure as seen by the client with additional fields for internal use.

code: struct FLobbyMemberInternal : public [UE::Online::FLobbyMember](API\Plugins\OnlineServicesInterface\Online\FLobbyMember)


className: FLobbyMemberServiceSnapshot

description: Full snapshot of a lobby member.

code: struct FLobbyMemberServiceSnapshot

SchemaServiceSnapshot

type: FSchemaServiceS...


className: FLobbyServiceSnapshot

description: Full snapshot of lobby data excluding the individual member attributes

code: struct FLobbyServiceSnapshot

JoinPolicy

type: ELobbyJoinPolic...

Members

type: TSet<FAccountI...


code: const [EOnlineAsyncExecutionPolicy](API\Plugins\OnlineServicesCommon\Online\UE__Online__EOnlineAsyncExecutio-) & GetExecutionPolicy() const


code: FOnlineAsyncExecutionPolicy ( [EOnlineAsyncExecutionPolicy](API\Plugins\OnlineServicesCommon\Online\UE__Online__EOnlineAsyncExecutio-) InExecutionPolicy )


className: FOnlineAsyncExecutionPolicy

code: class FOnlineAsyncExecutionPolicy


code: void SetError ( [FOnlineError](API\Plugins\OnlineServicesInterface\Online\FOnlineError) && Error )


code: virtual ~FOnlineAsyncOp()


className: FOnlineAsyncOp

code: class FOnlineAsyncOp


description: Join an existing operation or use a non-expired cached result, or create an operation that can later be joined.

code: template<typename OpType, typename ParamsFuncsType> [TOnlineAsyncOpRef](API\Plugins\OnlineServicesCommon\Online\TOnlineAsyncOpRef)< OpType > GetJoinableOp ( typename OpType::Params && Params, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & ConfigSectionHeiarchy )


description: Merge with a pending operation, or create an operation.

code: template<typename OpType, typename ParamsFuncsType> [TOnlineAsyncOpRef](API\Plugins\OnlineServicesCommon\Online\TOnlineAsyncOpRef)< OpType > GetMergeableOp ( typename OpType::Params && Params, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & ConfigSectionHeiarchy )


code: void SetLoadConfigFn ( [TUniqueFunction](API\Runtime\Core\Templates\TUniqueFunction)< bool([FOperationConfig](API\Plugins\OnlineServicesCommon\Online\FOperationConfig) &, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > &)> && InLoadConfigFn )


description: Create an operation.

code: template<typename OpType> [TOnlineAsyncOpRef](API\Plugins\OnlineServicesCommon\Online\TOnlineAsyncOpRef)< OpType > GetOp ( typename OpType::Params && Params, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & ConfigSectionHeiarchy )


code: FOnlineAsyncOpCache ( const [FString](API\Runtime\Core\Containers\FString) & ConfigPath, class [FOnlineServicesCommon](API\Plugins\OnlineServicesCommon\Online\FOnlineServicesCommon) & InServices )


className: FOnlineAsyncOpCache

code: class FOnlineAsyncOpCache

Services

type: FOnlineServices...


code: template<typename OpType> void Enqueue ( [TOnlineAsyncOp](API\Plugins\OnlineServicesCommon\Online\TOnlineAsyncOp)< OpType > & Op )


code: void Cancel &40; const FOnlineError & Reason &41;


code: bool IsComplete&40;&41; const


code: virtual &126;IWrappedOp&40;&41;


className: IWrappedOp

code: class IWrappedOp


code: void TryStartOperations()


code: virtual void Cancel &40; const FOnlineError & Reason &41;


code: virtual bool IsComplete&40;&41; const


code: virtual TOnlineEvent< void(void)> OnComplete&40;&41;


code: virtual void Start&40;&41;


code: TWrappedOp &40; TOnlineAsyncOp< OpType > & InOp &41;


code: virtual &126;TWrappedOp&40;&41;


className: TWrappedOp

code: template<typename OpType> class TWrappedOp : public [UE::Online::FOnlineAsyncOpQueue::IWrappedOp](API\Plugins\OnlineServicesCommon\Online\FOnlineAsyncOpQueue\IWrappedOp), public [TSharedFromThis< TWrappedOp< OpType > >](API\Runtime\Core\Templates\TSharedFromThis)


code: FOnlineAsyncOpQueue()


code: virtual ~FOnlineAsyncOpQueue()


className: FOnlineAsyncOpQueue

code: class FOnlineAsyncOpQueue

QueuedOperations

type: TSpscQueue<TSh...


code: void Tick ( float DeltaSeconds )


code: void SetMaxConcurrentOperations ( int InMaxConcurrentOperations )


code: void Enqueue ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IWrappedOp](API\Plugins\OnlineServicesCommon\Online\FOnlineAsyncOpQueue\IWrappedOp) > & Operation )


code: virtual void TryStartOperations()


className: FOnlineAsyncOpQueueParallel

code: class FOnlineAsyncOpQueueParallel : public [UE::Online::FOnlineAsyncOpQueue](API\Plugins\OnlineServicesCommon\Online\FOnlineAsyncOpQueue)

InFlightOperations

type: TArray< TPair< ...

MaxConcurrentOperations

type: int


code: FOnlineAsyncOpQueueSerial ( [FOnlineAsyncOpQueueParallel](API\Plugins\OnlineServicesCommon\Online\FOnlineAsyncOpQueueParallel) & InParentQueue )


className: FOnlineAsyncOpQueueSerial

code: class FOnlineAsyncOpQueueSerial : public [UE::Online::FOnlineAsyncOpQueue](API\Plugins\OnlineServicesCommon\Online\FOnlineAsyncOpQueue)

ContinuationDelegateHandle

type: FOnlineEventDel...

InFlightOperation

type: TSharedPtr<IWr...

ParentQueue

type: FOnlineAsyncOpQ...


description: Internal use only. Used to implementIOnlineServices::GetInterface()

code: void AssignBaseSharedPtr ( const [FOnlineTypeName](API\Plugins\OnlineServicesInterface\Online\FOnlineTypeName) & TypeName, void * OutBaseInterfaceSP )


description:
Get the component of type ComponentType
The component or null if one of ComponentType has not been registered

code: template<typename ComponentType> ComponentType * Get() const


description: Destroy and unregister a component of type ComponentType

code: template<typename ComponentType> void Unregister()


description: Create and register a component of type ComponentType if one has not already been registered

code: template<typename ComponentType, typename... ParamTypes> void Register ( ParamTypes &&... Params )


description:
Get aFStringvalue
true if a value was read

code: virtual bool GetValue ( const TCHAR * Section, const TCHAR * Key, [FString](API\Runtime\Core\Containers\FString) & Value )


description: Call a callable for each of the components

code: template<typename CallableType, typename... ParamTypes> void Visit ( CallableType && Callable, ParamTypes &&... Params )


className: FOnlineComponentRegistry

code: class FOnlineComponentRegistry


description:
Get an value consisting of aTArrayof FStrings
number of values in the array

code: virtual int32 GetValue ( const TCHAR * Section, const TCHAR * Key, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & Value )


code: virtual bool GetValue ( const TCHAR * Section, const TCHAR * Key, [IOnlineConfigStructPtr](API\Plugins\OnlineServicesCommon\Online\IOnlineConfigStructPtr) & Value )


code: virtual int32 GetValue ( const TCHAR * Section, const TCHAR * Key, [TArray](API\Runtime\Core\Containers\TArray)< [IOnlineConfigStructPtr](API\Plugins\OnlineServicesCommon\Online\IOnlineConfigStructPtr) > & Value )


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


code: virtual ~FOnlineConfigProviderGConfig()


code: virtual bool GetValue ( const TCHAR * Key, [FString](API\Runtime\Core\Containers\FString) & Value )


className: FOnlineConfigProviderGConfig

description: IOnlineConfigProviderimplementation that uses GConfig to retrieve values

code: class FOnlineConfigProviderGConfig : public [UE::Online::IOnlineConfigProvider](API\Plugins\OnlineServicesCommon\Online\IOnlineConfigProvider)


code: virtual int32 GetValue ( const TCHAR * Key, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & Value )


code: virtual bool GetValue ( const TCHAR * Key, [IOnlineConfigStructPtr](API\Plugins\OnlineServicesCommon\Online\IOnlineConfigStructPtr) & Value )


code: virtual int32 GetValue ( const TCHAR * Key, [TArray](API\Runtime\Core\Containers\TArray)< [IOnlineConfigStructPtr](API\Plugins\OnlineServicesCommon\Online\IOnlineConfigStructPtr) > & Value )


code: FOnlineConfigStructGConfig ( FPrivateToken )


code: virtual ~FOnlineConfigStructGConfig()


className: FOnlineConfigStructGConfig

code: class FOnlineConfigStructGConfig : public [UE::Online::IOnlineConfigStruct](API\Plugins\OnlineServicesCommon\Online\IOnlineConfigStruct)


code: bool operator&61;&61; &40; const FOperationDataKey & Other &41; const


className: FOperationDataKey

code: struct FOperationDataKey

Key

type: FString

TypeName

type: FOnlineTypeName


code: template<typename T> const T * Get ( const [FString](API\Runtime\Core\Containers\FString) & Key ) const


code: template<typename T> void Set ( const [FString](API\Runtime\Core\Containers\FString) & Key, T && InData )


code: template<typename T> void Set ( const [FString](API\Runtime\Core\Containers\FString) & Key, const T & InData )


className: FOnlineOperationData

code: class FOnlineOperationData


description: Add a config section override. These will be used in the order they are added

code: void AddConfigSectionOverride ( const [FString](API\Runtime\Core\Containers\FString) & Override )


code: virtual void AssignBaseInterfaceSharedPtr ( const [FOnlineTypeName](API\Plugins\OnlineServicesInterface\Online\FOnlineTypeName) & TypeName, void * OutBaseInterfaceSP )


code: virtual void Destroy()


description: Call a callable according to a specified execution policy

code: template<typename CallableType> void Execute ( [FOnlineAsyncExecutionPolicy](API\Plugins\OnlineServicesCommon\Online\FOnlineAsyncExecutionPolicy) ExecutionPolicy, CallableType && Callable )


description: Retrieve any of the Interface IOnlineComponents

code: template<typename ComponentType> ComponentType * Get()


description: Call a callable on the game thread

code: template<typename CallableType> void ExecuteOnGameThread ( CallableType && Callable )


description: Get the config name for the Subsystem

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


code: [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetConfigSectionHeiarchy ( const [FString](API\Runtime\Core\Containers\FString) & OperationName ) const


description:
Get an array of a config section with the overrides added in
Array of the sections with overrides for values to be loaded from

code: [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetConfigSectionHeirachWithOverrides ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & SectionHeiarchy ) const


description:
Get the instance name of this instance.
instance name

code: virtual [FName](API\Runtime\Core\UObject\FName) GetInstanceName() const


code: template<typename OpType, typename ParamsFuncsType> [TOnlineAsyncOpRef](API\Plugins\OnlineServicesCommon\Online\TOnlineAsyncOpRef)< OpType > GetJoinableOp ( typename OpType::Params && Params )


code: template<typename OpType, typename ParamsFuncsType> [TOnlineAsyncOpRef](API\Plugins\OnlineServicesCommon\Online\TOnlineAsyncOpRef)< OpType > GetJoinableOp ( typename OpType::Params && Params, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & ConfigSectionHeiarchy )


description:
Get the leaderboards implementation
leaderboards implementation, may be null if not implemented for this service


description:
Get the lobbies implementation
lobbies implementation, may be null if not implemented for this service


code: template<typename OpType, typename ParamsFuncsType> [TOnlineAsyncOpRef](API\Plugins\OnlineServicesCommon\Online\TOnlineAsyncOpRef)< OpType > GetMergeableOp ( typename OpType::Params && Params )


code: template<typename OpType, typename ParamsFuncsType> [TOnlineAsyncOpRef](API\Plugins\OnlineServicesCommon\Online\TOnlineAsyncOpRef)< OpType > GetMergeableOp ( typename OpType::Params && Params, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & ConfigSectionHeiarchy )


description: Get op (OnlineServices)

code: template<typename OpType> [TOnlineAsyncOpRef](API\Plugins\OnlineServicesCommon\Online\TOnlineAsyncOpRef)< OpType > GetOp ( typename OpType::Params && Params )


description: Get op (Interface)

code: template<typename OpType> [TOnlineAsyncOpRef](API\Plugins\OnlineServicesCommon\Online\TOnlineAsyncOpRef)< OpType > GetOp ( typename OpType::Params && Params, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & ConfigSectionHeiarchy )


description: Queue for executing tasks in parallel. Serial queues feed into this


description: Get the connectivity string used for client travel

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FGetResolvedConnectString](API\Plugins\OnlineServicesInterface\Online\FGetResolvedConnectString) > GetResolvedConnectString ( [FGetResolvedConnectString::Params](API\Plugins\OnlineServicesInterface\Online\FGetResolvedConnectString\Params) && Params )


description: Queue for executing tasks in serial


description: Queues for executing per-user tasks in serial

code: [FOnlineAsyncOpQueue](API\Plugins\OnlineServicesCommon\Online\FOnlineAsyncOpQueue) & GetSerialQueue ( const [FAccountId](API\Runtime\CoreOnline\Online\FAccountId) & AccountId )


description:
Get the sessions implementation
sessions implementation, may be null if not implemented for this service


description:
Get the social interface, used to interact with friends lists, blocked user lists, and any other social relationships
social interface implementation, may be null if not implemented for this service


description:
Get the stats implementation
stats implementation, may be null if not implemented for this service


description: IOnlineServices.

code: virtual void Init()


description: Calls Initialize on all the components, called after RegisterComponents

code: virtual void Initialize()


code: void LoadCommonConfig()


description:
Load a config struct for a section heiarchy, also using the ConfigSectionOverrides
true if a value was loaded

code: template<typename StructType> bool LoadConfig ( StructType & Struct, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & SectionHeiarchy ) const


description:
Load a config struct for an interface + operation Will load values from the following sections: OnlineServices OnlineServices.(if InterfaceName is set) OnlineServices.OnlineServices..(if InterfaceName is set) OnlineServices...(if OperationName is set)
true if a value was loaded

code: template<typename StructType> bool LoadConfig ( StructType & Struct, const [FString](API\Runtime\Core\Containers\FString) & InterfaceName, const [FString](API\Runtime\Core\Containers\FString) & OperationName ) const


className: NextInstanceIndex

code: static uint32 NextInstanceIndex = 0;


description: Calls PostInitialize on all the components, called after Initialize

code: virtual void PostInitialize()


description: Called to register all the IOnlineComponents with the IOnlineService, called after this is constructed

code: virtual void RegisterComponents()


description: Calls PreShutdown on all the components, called prior to Shutdown

code: virtual void PreShutdown()


code: void RegisterExecHandler ( const [FString](API\Runtime\Core\Containers\FString) & Name, [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IOnlineExecHandler](API\Plugins\OnlineServicesCommon\Online\IOnlineExecHandler) > && Handler )


description: Clear the list of config overrides

code: void ResetConfigSectionOverrides()


description: Override the default config provider (FOnlineConfigProviderGConfig(GEngineini))

code: void SetConfigProvider ( [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IOnlineConfigProvider](API\Plugins\OnlineServicesCommon\Online\IOnlineConfigProvider) > && InConfigProvider )


description: Calls Shutdown on all the components, called before this is destructed

code: virtual void Shutdown()


description: Calls Tick on all the components

code: virtual bool Tick ( float DeltaSeconds )


code: FOnlineServicesCommon ( const [FOnlineServicesCommon](API\Plugins\OnlineServicesCommon\Online\FOnlineServicesCommon) & )


description: Calls UpdateConfig on all the components

code: virtual void UpdateConfig()


code: FOnlineServicesCommon ( [FOnlineServicesCommon](API\Plugins\OnlineServicesCommon\Online\FOnlineServicesCommon) && )


code: FOnlineServicesCommon ( const [FString](API\Runtime\Core\Containers\FString) & InConfigName, [FName](API\Runtime\Core\UObject\FName) InInstanceName )


code: virtual ~FOnlineServicesCommon()


className: FOnlineServicesCommon

code: class FOnlineServicesCommon : public [UE::Online::IOnlineServices](API\Plugins\OnlineServicesInterface\Online\IOnlineServices), public [TSharedFromThis< FOnlineServicesCommon >](API\Runtime\Core\Templates\TSharedFromThis), public [FTSTickerObjectBase](API\Runtime\Core\Containers\FTSTickerObjectBase), public [FSelfRegisteringExec](API\Runtime\Core\Misc\FSelfRegisteringExec)

Components

type: FOnlineComponen...

ConfigProvider

type: TUniquePtr<IOn...

ConfigSectionOverrides

type: TArray<FString...

description: Config section overrides

ExecCommands

type: TMap<FString, ...

InstanceName

type: FName

OpCache

type: FOnlineAsyncOpC...

PerUserSerialQueue

type: TMap<FAccountI...


code: virtual [FOnlineSessionId](API\Runtime\CoreOnline\Online\FOnlineSessionId) FromReplicationData ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & ReplicationData )


code: bool IsSessionIdExpired ( const [FOnlineSessionId](API\Runtime\CoreOnline\Online\FOnlineSessionId) & InSessionId ) const


code: virtual [FString](API\Runtime\Core\Containers\FString) ToLogString ( const [FOnlineSessionId](API\Runtime\CoreOnline\Online\FOnlineSessionId) & SessionId ) const


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< uint8 > ToReplicationData ( const [FOnlineSessionId](API\Runtime\CoreOnline\Online\FOnlineSessionId) & SessionId ) const


description: Begin IOnlineSessionIdRegistry.

code: virtual [FString](API\Runtime\Core\Containers\FString) ToString ( const [FOnlineSessionId](API\Runtime\CoreOnline\Online\FOnlineSessionId) & SessionId ) const


code: FOnlineSessionIdStringRegistry ( [EOnlineServices](API\Runtime\CoreOnline\Online\UE__Online__EOnlineServices) OnlineServicesType )


className: FOnlineSessionIdStringRegistry

code: class FOnlineSessionIdStringRegistry : public [UE::Online::IOnlineIdRegistry< IdType >](API\Runtime\CoreOnline\Online\IOnlineIdRegistry)

BasicRegistry

type: TOnlineBasicSes...


code: virtual [FSessionInviteId](API\Runtime\CoreOnline\Online\FSessionInviteId) FromReplicationData ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & ReplicationData )


code: virtual [FString](API\Runtime\Core\Containers\FString) ToLogString ( const [FSessionInviteId](API\Runtime\CoreOnline\Online\FSessionInviteId) & SessionInviteId ) const


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< uint8 > ToReplicationData ( const [FSessionInviteId](API\Runtime\CoreOnline\Online\FSessionInviteId) & SessionInviteId ) const


description: Begin IOnlineSessionIdRegistry.

code: virtual [FString](API\Runtime\Core\Containers\FString) ToString ( const [FSessionInviteId](API\Runtime\CoreOnline\Online\FSessionInviteId) & SessionInviteId ) const


code: FOnlineSessionInviteIdStringRegistry ( [EOnlineServices](API\Runtime\CoreOnline\Online\UE__Online__EOnlineServices) OnlineServicesType )


className: FOperationConfig

code: struct FOperationConfig

bCacheError

type: bool

CacheExpiration

type: EOperationCache...

CacheExpirySeconds

type: double


className: FOnlineSessionInviteIdStringRegistry

code: class FOnlineSessionInviteIdStringRegistry : public [UE::Online::IOnlineIdRegistry< IdType >](API\Runtime\CoreOnline\Online\IOnlineIdRegistry)


description: Queries presences for all users in the array

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FBatchQueryPresence](API\Plugins\OnlineServicesInterface\Online\FBatchQueryPresence) > BatchQueryPresence ( [FBatchQueryPresence::Params](API\Plugins\OnlineServicesInterface\Online\FBatchQueryPresence\Params) && Params )


description: Get the presence of a user Presence typically comes from QueryPresence or push events from the online service

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FGetCachedPresence](API\Plugins\OnlineServicesInterface\Online\FGetCachedPresence) > GetCachedPresence ( [FGetCachedPresence::Params](API\Plugins\OnlineServicesInterface\Online\FGetCachedPresence\Params) && Params )


description:
Get the event that is triggered when presence is updated
Event that can be bound to

code: virtual [TOnlineEvent](API\Plugins\OnlineServicesInterface\Online\TOnlineEvent)< void(const [FPresenceUpdated](API\Plugins\OnlineServicesInterface\Online\FPresenceUpdated) &)> OnPresenceUpdated()


description: Updates only the parts of the presence that are specified

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FPartialUpdatePresence](API\Plugins\OnlineServicesInterface\Online\FPartialUpdatePresence) > PartialUpdatePresence ( [FPartialUpdatePresence::Params](API\Plugins\OnlineServicesInterface\Online\FPartialUpdatePresence\Params) && Params )


description: IPresence.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FQueryPresence](API\Plugins\OnlineServicesInterface\Online\FQueryPresence) > QueryPresence ( [FQueryPresence::Params](API\Plugins\OnlineServicesInterface\Online\FQueryPresence\Params) && Params )


description: Update your presence

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FUpdatePresence](API\Plugins\OnlineServicesInterface\Online\FUpdatePresence) > UpdatePresence ( [FUpdatePresence::Params](API\Plugins\OnlineServicesInterface\Online\FUpdatePresence\Params) && Params )


code: FPresenceCommon ( [FOnlineServicesCommon](API\Plugins\OnlineServicesCommon\Online\FOnlineServicesCommon) & InServices )


className: FPresenceCommon

code: class FPresenceCommon : public [UE::Online::TOnlineComponent< IPresence >](API\Plugins\OnlineServicesCommon\Online\TOnlineComponent)

OnPresenceUpdatedEvent

type: TOnlineEventCal...

Services

type: FOnlineServices...


description: IPermission.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FQueryUserPrivilege](API\Plugins\OnlineServicesInterface\Online\FQueryUserPrivilege) > QueryUserPrivilege ( [FQueryUserPrivilege::Params](API\Plugins\OnlineServicesInterface\Online\FQueryUserPrivilege\Params) && Params )


description: TOnlineComponent.

code: virtual void RegisterCommands()


code: FPrivilegesCommon ( [FOnlineServicesCommon](API\Plugins\OnlineServicesCommon\Online\FOnlineServicesCommon) & InServices )


className: FPrivilegesCommon

code: class FPrivilegesCommon : public [UE::Online::TOnlineComponent< IPrivileges >](API\Plugins\OnlineServicesCommon\Online\TOnlineComponent)


code: FSchemaCategoryInstanceLobbySnapshotAccessor ( [TMap](API\Runtime\Core\Containers\TMap)< [FSchemaAttributeId](API\Plugins\OnlineServicesInterface\Online\FSchemaAttributeId), [FSchemaVariant](API\Plugins\OnlineServicesInterface\Online\FSchemaVariant) > & InClientSnapshot )


description: Accessor for using the public lobby attributes directly when committing schema changes.


code: void DumpMemberData() const


code: void DumpSessionInfo() const


code: void DumpSessionSettings() const


description: Returns a string with all the information in the session

code: virtual void DumpState() const


description: Retrieves the number of available slots for new session members

code: virtual const uint32 GetNumOpenConnections() const


description: ISession.

code: virtual const [FAccountId](API\Runtime\CoreOnline\Online\FAccountId) GetOwnerAccountId() const


description: Retrieves the id handle for the session

code: virtual const [FOnlineSessionId](API\Runtime\CoreOnline\Online\FOnlineSessionId) GetSessionId() const


description: Retrieves the set of constant information about the session

code: virtual const [FSessionInfo](API\Plugins\OnlineServicesInterface\Online\FSessionInfo) & GetSessionInfo() const


description: Retrieves the list of users currently in the session

code: virtual const [FSessionMemberIdsSet](API\Plugins\OnlineServicesInterface\Online\FSessionMemberIdsSet) & GetSessionMembers() const


description: Retrieves the set of variable information about the session

code: virtual const [FSessionSettings](API\Plugins\OnlineServicesInterface\Online\FSessionSettings) & GetSessionSettings() const


description: Evaluates a series of factors to determine if a session is accepting new members

code: virtual bool IsJoinable() const


description: FSessionCommon

code: [FSessionCommon](API\Plugins\OnlineServicesCommon\Online\FSessionCommon) & operator+= ( const [FSessionUpdate](API\Plugins\OnlineServicesInterface\Online\FSessionUpdate) & SessionUpdate )


description: Returns a string with the minimal information to identify the session

code: virtual [FString](API\Runtime\Core\Containers\FString) ToLogString() const


code: FSessionCommon ( const [FSessionCommon](API\Plugins\OnlineServicesCommon\Online\FSessionCommon) & InSession )


code: virtual ~FSessionCommon()


className: FSessionCommon

code: class FSessionCommon : public [UE::Online::ISession](API\Plugins\OnlineServicesInterface\Online\ISession)

OwnerAccountId

type: FAccountId

description: The following members can be updated, and such update will be transmitted via aFSessionUpdatedevent The user who currently owns the session

SessionInfo

type: FSessionInfo

description: Session information that will remain constant throughout the session's lifetime

SessionMembers

type: FSessionMemberI...

description: Set containing user ids for all the session members

SessionSettings

type: FSessionSetting...

description: Set of session properties that can be altered by the session owner


code: virtual const [FSessionInviteId](API\Runtime\CoreOnline\Online\FSessionInviteId) GetInviteId() const


description: Retrieves the id handle for the user who received the invite

code: virtual const [FAccountId](API\Runtime\CoreOnline\Online\FAccountId) GetRecipientId() const


description: Retrieves the id handle for the user who sent the invite

code: virtual const [FAccountId](API\Runtime\CoreOnline\Online\FAccountId) GetSenderId() const


description: FSessionInvitecommon

code: FSessionInviteCommon ( const [FAccountId](API\Runtime\CoreOnline\Online\FAccountId) & InRecipientId, const [FAccountId](API\Runtime\CoreOnline\Online\FAccountId) & InSenderId, const [FSessionInviteId](API\Runtime\CoreOnline\Online\FSessionInviteId) & InInviteId, const [FOnlineSessionId](API\Runtime\CoreOnline\Online\FOnlineSessionId) & InSessionId )


code: FSessionInviteCommon()


className: FSessionInviteCommon

code: class FSessionInviteCommon : public [UE::Online::ISessionInvite](API\Plugins\OnlineServicesInterface\Online\ISessionInvite)

InviteId

type: FSessionInviteI...

description: The invite id handle, needed for retrieving invite information and rejecting the invite

RecipientId

description: The id handle for the user which the invite got sent to

SenderId

description: The id handle for the user which sent the invite

SessionId

type: FOnlineSessionI...

description: The session id handle, needed for retrieving the session information


code: void AddSearchResult ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FSessionCommon](API\Plugins\OnlineServicesCommon\Online\FSessionCommon) > Session, const [FAccountId](API\Runtime\CoreOnline\Online\FAccountId) & LocalAccountId )


code: void AddSessionInvite ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FSessionInviteCommon](API\Plugins\OnlineServicesCommon\Online\FSessionInviteCommon) > SessionInvite, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FSessionCommon](API\Plugins\OnlineServicesCommon\Online\FSessionCommon) > Session, const [FAccountId](API\Runtime\CoreOnline\Online\FAccountId) & LocalAccountId )


description: Parameters for the AddSessionMember call

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FAddSessionMember](API\Plugins\OnlineServicesInterface\Online\FAddSessionMember) > AddSessionMember ( [FAddSessionMember::Params](API\Plugins\OnlineServicesInterface\Online\FAddSessionMember\Params) && Params )


code: virtual [TFuture](API\Runtime\Core\Async\TFuture)< [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FAddSessionMember](API\Plugins\OnlineServicesInterface\Online\FAddSessionMember) > > AddSessionMemberImpl ( const [FAddSessionMember::Params](API\Plugins\OnlineServicesInterface\Online\FAddSessionMember\Params) & Params )


code: [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FAddSessionMember](API\Plugins\OnlineServicesInterface\Online\FAddSessionMember) > AddSessionMemberInternal ( const [FAddSessionMember::Params](API\Plugins\OnlineServicesInterface\Online\FAddSessionMember\Params) & Params )


code: void AddSessionReferences ( const [FOnlineSessionId](API\Runtime\CoreOnline\Online\FOnlineSessionId) SessionId, const [FName](API\Runtime\Core\UObject\FName) & SessionName, const [FAccountId](API\Runtime\CoreOnline\Online\FAccountId) & LocalAccountId, bool bIsPresenceSession )


code: void AddSessionWithReferences ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FSessionCommon](API\Plugins\OnlineServicesCommon\Online\FSessionCommon) > Session, const [FName](API\Runtime\Core\UObject\FName) & SessionName, const [FAccountId](API\Runtime\CoreOnline\Online\FAccountId) & LocalAccountId, bool bIsPresenceSession )


code: [FSessionUpdate](API\Plugins\OnlineServicesInterface\Online\FSessionUpdate) BuildSessionUpdate ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FSessionCommon](API\Plugins\OnlineServicesCommon\Online\FSessionCommon) > & Session, const [FSessionSettingsUpdate](API\Plugins\OnlineServicesInterface\Online\FSessionSettingsUpdate) & UpdatedValues ) const


code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FOnlineError](API\Plugins\OnlineServicesInterface\Online\FOnlineError) > CheckParams ( const [FCreateSession::Params](API\Plugins\OnlineServicesInterface\Online\FCreateSession\Params) & Params ) const


code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FOnlineError](API\Plugins\OnlineServicesInterface\Online\FOnlineError) > CheckParams ( const [FRejectSessionInvite::Params](API\Plugins\OnlineServicesInterface\Online\FRejectSessionInvite\Params) & Params ) const


code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FOnlineError](API\Plugins\OnlineServicesInterface\Online\FOnlineError) > CheckParams ( const [FUpdateSessionSettings::Params](API\Plugins\OnlineServicesInterface\Online\FUpdateSessionSettings\Params) & Params ) const


code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FOnlineError](API\Plugins\OnlineServicesInterface\Online\FOnlineError) > CheckParams ( const [FLeaveSession::Params](API\Plugins\OnlineServicesInterface\Online\FLeaveSession\Params) & Params ) const


code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FOnlineError](API\Plugins\OnlineServicesInterface\Online\FOnlineError) > CheckParams ( const [FFindSessions::Params](API\Plugins\OnlineServicesInterface\Online\FFindSessions\Params) & Params ) const


code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FOnlineError](API\Plugins\OnlineServicesInterface\Online\FOnlineError) > CheckParams ( const [FStartMatchmaking::Params](API\Plugins\OnlineServicesInterface\Online\FStartMatchmaking\Params) & Params ) const


code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FOnlineError](API\Plugins\OnlineServicesInterface\Online\FOnlineError) > CheckParams ( const [FJoinSession::Params](API\Plugins\OnlineServicesInterface\Online\FJoinSession\Params) & Params ) const


code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FOnlineError](API\Plugins\OnlineServicesInterface\Online\FOnlineError) > CheckParams ( const [FAddSessionMember::Params](API\Plugins\OnlineServicesInterface\Online\FAddSessionMember\Params) & Params ) const


code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FOnlineError](API\Plugins\OnlineServicesInterface\Online\FOnlineError) > CheckParams ( const [FRemoveSessionMember::Params](API\Plugins\OnlineServicesInterface\Online\FRemoveSessionMember\Params) & Params ) const


code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FOnlineError](API\Plugins\OnlineServicesInterface\Online\FOnlineError) > CheckParams ( const [FSendSessionInvite::Params](API\Plugins\OnlineServicesInterface\Online\FSendSessionInvite\Params) & Params ) const


code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FOnlineError](API\Plugins\OnlineServicesInterface\Online\FOnlineError) > CheckState ( const [FCreateSession::Params](API\Plugins\OnlineServicesInterface\Online\FCreateSession\Params) & Params ) const


code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FOnlineError](API\Plugins\OnlineServicesInterface\Online\FOnlineError) > CheckState ( const [FRejectSessionInvite::Params](API\Plugins\OnlineServicesInterface\Online\FRejectSessionInvite\Params) & Params ) const


code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FOnlineError](API\Plugins\OnlineServicesInterface\Online\FOnlineError) > CheckState ( const [FUpdateSessionSettings::Params](API\Plugins\OnlineServicesInterface\Online\FUpdateSessionSettings\Params) & Params ) const


code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FOnlineError](API\Plugins\OnlineServicesInterface\Online\FOnlineError) > CheckState ( const [FLeaveSession::Params](API\Plugins\OnlineServicesInterface\Online\FLeaveSession\Params) & Params ) const


code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FOnlineError](API\Plugins\OnlineServicesInterface\Online\FOnlineError) > CheckState ( const [FFindSessions::Params](API\Plugins\OnlineServicesInterface\Online\FFindSessions\Params) & Params ) const


code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FOnlineError](API\Plugins\OnlineServicesInterface\Online\FOnlineError) > CheckState ( const [FStartMatchmaking::Params](API\Plugins\OnlineServicesInterface\Online\FStartMatchmaking\Params) & Params ) const


code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FOnlineError](API\Plugins\OnlineServicesInterface\Online\FOnlineError) > CheckState ( const [FJoinSession::Params](API\Plugins\OnlineServicesInterface\Online\FJoinSession\Params) & Params ) const


code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FOnlineError](API\Plugins\OnlineServicesInterface\Online\FOnlineError) > CheckState ( const [FAddSessionMember::Params](API\Plugins\OnlineServicesInterface\Online\FAddSessionMember\Params) & Params ) const


code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FOnlineError](API\Plugins\OnlineServicesInterface\Online\FOnlineError) > CheckState ( const [FRemoveSessionMember::Params](API\Plugins\OnlineServicesInterface\Online\FRemoveSessionMember\Params) & Params ) const


code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FOnlineError](API\Plugins\OnlineServicesInterface\Online\FOnlineError) > CheckState ( const [FSendSessionInvite::Params](API\Plugins\OnlineServicesInterface\Online\FSendSessionInvite\Params) & Params ) const


description: Parameters for the ClearPresenceSession call return

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FClearPresenceSession](API\Plugins\OnlineServicesInterface\Online\FClearPresenceSession) > ClearPresenceSession ( [FClearPresenceSession::Params](API\Plugins\OnlineServicesInterface\Online\FClearPresenceSession\Params) && Params )


code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FClearPresenceSession](API\Plugins\OnlineServicesInterface\Online\FClearPresenceSession) > ClearPresenceSessionImpl ( [FClearPresenceSession::Params](API\Plugins\OnlineServicesInterface\Online\FClearPresenceSession\Params) && Params )


code: void ClearSessionInvitesForSession ( const [FAccountId](API\Runtime\CoreOnline\Online\FAccountId) & LocalAccountId, const [FOnlineSessionId](API\Runtime\CoreOnline\Online\FOnlineSessionId) SessionId )


code: void ClearSessionReferences ( const [FOnlineSessionId](API\Runtime\CoreOnline\Online\FOnlineSessionId) SessionId, const [FName](API\Runtime\Core\UObject\FName) & SessionName, const [FAccountId](API\Runtime\CoreOnline\Online\FAccountId) & LocalAccountId )


description: Creates a new session with the given parameters, and assigns to it the given local name. Depending on the implementation, the creating user might not be added to the Session Members automatically, so a subsequent call to AddSessionMember is recommended

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FCreateSession](API\Plugins\OnlineServicesInterface\Online\FCreateSession) > CreateSession ( [FCreateSession::Params](API\Plugins\OnlineServicesInterface\Online\FCreateSession\Params) && Params )


code: virtual [TFuture](API\Runtime\Core\Async\TFuture)< [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FCreateSession](API\Plugins\OnlineServicesInterface\Online\FCreateSession) > > CreateSessionImpl ( const [FCreateSession::Params](API\Plugins\OnlineServicesInterface\Online\FCreateSession\Params) & Params )


description: Queries the API session service for sessions matching the given parameters.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FFindSessions](API\Plugins\OnlineServicesInterface\Online\FFindSessions) > FindSessions ( [FFindSessions::Params](API\Plugins\OnlineServicesInterface\Online\FFindSessions\Params) && Params )


code: virtual [TFuture](API\Runtime\Core\Async\TFuture)< [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FFindSessions](API\Plugins\OnlineServicesInterface\Online\FFindSessions) > > FindSessionsImpl ( const [FFindSessions::Params](API\Plugins\OnlineServicesInterface\Online\FFindSessions\Params) & Params )


className: FSessionEvents

code: struct FSessionEvents


description: Gets an array of references to all the session invites the given user has received.

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FGetAllSessionInvites](API\Plugins\OnlineServicesInterface\Online\FGetAllSessionInvites) > GetAllSessionInvites ( [FGetAllSessionInvites::Params](API\Plugins\OnlineServicesInterface\Online\FGetAllSessionInvites\Params) && Params )


description: ISessions.

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FGetAllSessions](API\Plugins\OnlineServicesInterface\Online\FGetAllSessions) > GetAllSessions ( [FGetAllSessions::Params](API\Plugins\OnlineServicesInterface\Online\FGetAllSessions\Params) && Params ) const


code: [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FGetMutableSessionById](API\Plugins\OnlineServicesCommon\Online\FGetMutableSessionById) > GetMutableSessionById ( [FGetMutableSessionById::Params](API\Plugins\OnlineServicesCommon\Online\FGetMutableSessionById\Params) && Params ) const


description: Auxiliary methods.

code: [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FGetMutableSessionByName](API\Plugins\OnlineServicesCommon\Online\FGetMutableSessionByName) > GetMutableSessionByName ( [FGetMutableSessionByName::Params](API\Plugins\OnlineServicesCommon\Online\FGetMutableSessionByName\Params) && Params ) const


description: Parameters for the GetPresenceSession call return

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FGetPresenceSession](API\Plugins\OnlineServicesInterface\Online\FGetPresenceSession) > GetPresenceSession ( [FGetPresenceSession::Params](API\Plugins\OnlineServicesInterface\Online\FGetPresenceSession\Params) && Params ) const


description: Parameters for the GetSessionById call return

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FGetSessionById](API\Plugins\OnlineServicesInterface\Online\FGetSessionById) > GetSessionById ( [FGetSessionById::Params](API\Plugins\OnlineServicesInterface\Online\FGetSessionById\Params) && Params ) const


description: Parameters for the GetSessionByName call return

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FGetSessionByName](API\Plugins\OnlineServicesInterface\Online\FGetSessionByName) > GetSessionByName ( [FGetSessionByName::Params](API\Plugins\OnlineServicesInterface\Online\FGetSessionByName\Params) && Params ) const


description: Gets a reference to the session invite with the given invite id.

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FGetSessionInviteById](API\Plugins\OnlineServicesInterface\Online\FGetSessionInviteById) > GetSessionInviteById ( [FGetSessionInviteById::Params](API\Plugins\OnlineServicesInterface\Online\FGetSessionInviteById\Params) && Params )


description: TOnlineComponent.

code: virtual void Initialize()


description: Parameters for the IsPresenceSession call return

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FIsPresenceSession](API\Plugins\OnlineServicesInterface\Online\FIsPresenceSession) > IsPresenceSession ( [FIsPresenceSession::Params](API\Plugins\OnlineServicesInterface\Online\FIsPresenceSession\Params) && Params ) const


description: Joins the session with the given session id, and assigns to it the given local name.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FJoinSession](API\Plugins\OnlineServicesInterface\Online\FJoinSession) > JoinSession ( [FJoinSession::Params](API\Plugins\OnlineServicesInterface\Online\FJoinSession\Params) && Params )


code: virtual [TFuture](API\Runtime\Core\Async\TFuture)< [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FJoinSession](API\Plugins\OnlineServicesInterface\Online\FJoinSession) > > JoinSessionImpl ( const [FJoinSession::Params](API\Plugins\OnlineServicesInterface\Online\FJoinSession\Params) & Params )


description: Leaves and optionally destroys the session with the given name.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FLeaveSession](API\Plugins\OnlineServicesInterface\Online\FLeaveSession) > LeaveSession ( [FLeaveSession::Params](API\Plugins\OnlineServicesInterface\Online\FLeaveSession\Params) && Params )


description: This event will trigger as a result of receiving a session invite.


code: virtual [TFuture](API\Runtime\Core\Async\TFuture)< [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FLeaveSession](API\Plugins\OnlineServicesInterface\Online\FLeaveSession) > > LeaveSessionImpl ( const [FLeaveSession::Params](API\Plugins\OnlineServicesInterface\Online\FLeaveSession\Params) & Params )


description: This event will trigger as a result of joining a session.

code: virtual [TOnlineEvent](API\Plugins\OnlineServicesInterface\Online\TOnlineEvent)< void(const [FSessionJoined](API\Plugins\OnlineServicesInterface\Online\FSessionJoined) &)> OnSessionJoined()


description: This event will trigger as a result of leaving or destroying a session.

code: virtual [TOnlineEvent](API\Plugins\OnlineServicesInterface\Online\TOnlineEvent)< void(const [FSessionLeft](API\Plugins\OnlineServicesInterface\Online\FSessionLeft) &)> OnSessionLeft()


description: This event will trigger as a result of updating a session's settings, or whenever a session update event is received by the API.

code: virtual [TOnlineEvent](API\Plugins\OnlineServicesInterface\Online\TOnlineEvent)< void(const [FSessionUpdated](API\Plugins\OnlineServicesInterface\Online\FSessionUpdated) &)> OnSessionUpdated()


description: This event will trigger as a result of accepting a session invite or joining a session via the platform UI.


code: virtual void RegisterCommands()


description: Rejects the session invite with the given invite id.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FRejectSessionInvite](API\Plugins\OnlineServicesInterface\Online\FRejectSessionInvite) > RejectSessionInvite ( [FRejectSessionInvite::Params](API\Plugins\OnlineServicesInterface\Online\FRejectSessionInvite\Params) && Params )


code: [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FRemoveSessionMember](API\Plugins\OnlineServicesInterface\Online\FRemoveSessionMember) > RemoveSessionMemberInternal ( const [FRemoveSessionMember::Params](API\Plugins\OnlineServicesInterface\Online\FRemoveSessionMember\Params) & Params )


description: Parameters for the RemoveSessionMember call

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FRemoveSessionMember](API\Plugins\OnlineServicesInterface\Online\FRemoveSessionMember) > RemoveSessionMember ( [FRemoveSessionMember::Params](API\Plugins\OnlineServicesInterface\Online\FRemoveSessionMember\Params) && Params )


code: virtual [TFuture](API\Runtime\Core\Async\TFuture)< [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FRemoveSessionMember](API\Plugins\OnlineServicesInterface\Online\FRemoveSessionMember) > > RemoveSessionMemberImpl ( const [FRemoveSessionMember::Params](API\Plugins\OnlineServicesInterface\Online\FRemoveSessionMember\Params) & Params )


code: virtual [TFuture](API\Runtime\Core\Async\TFuture)< [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FSendSessionInvite](API\Plugins\OnlineServicesInterface\Online\FSendSessionInvite) > > SendSessionInviteImpl ( const [FSendSessionInvite::Params](API\Plugins\OnlineServicesInterface\Online\FSendSessionInvite\Params) & Params )


description: Sends an invite to the session with the given name to all given users.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FSendSessionInvite](API\Plugins\OnlineServicesInterface\Online\FSendSessionInvite) > SendSessionInvite ( [FSendSessionInvite::Params](API\Plugins\OnlineServicesInterface\Online\FSendSessionInvite\Params) && Params )


description: Parameters for the SetPresenceSession call return

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FSetPresenceSession](API\Plugins\OnlineServicesInterface\Online\FSetPresenceSession) > SetPresenceSession ( [FSetPresenceSession::Params](API\Plugins\OnlineServicesInterface\Online\FSetPresenceSession\Params) && Params )


code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FSetPresenceSession](API\Plugins\OnlineServicesInterface\Online\FSetPresenceSession) > SetPresenceSessionImpl ( [FSetPresenceSession::Params](API\Plugins\OnlineServicesInterface\Online\FSetPresenceSession\Params) && Params )


description: Starts the matchmaking process, which will either create a session with the given parameters, or join one that matches the given search filters.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FStartMatchmaking](API\Plugins\OnlineServicesInterface\Online\FStartMatchmaking) > StartMatchmaking ( [FStartMatchmaking::Params](API\Plugins\OnlineServicesInterface\Online\FStartMatchmaking\Params) && Params )


code: virtual [TFuture](API\Runtime\Core\Async\TFuture)< [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FRejectSessionInvite](API\Plugins\OnlineServicesInterface\Online\FRejectSessionInvite) > > RejectSessionInviteImpl ( const [FRejectSessionInvite::Params](API\Plugins\OnlineServicesInterface\Online\FRejectSessionInvite\Params) & Params )


code: virtual [TFuture](API\Runtime\Core\Async\TFuture)< [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FStartMatchmaking](API\Plugins\OnlineServicesInterface\Online\FStartMatchmaking) > > StartMatchmakingImpl ( const [FStartMatchmaking::Params](API\Plugins\OnlineServicesInterface\Online\FStartMatchmaking\Params) & Params )


description: Update the settings for the session with the given name. Should only be called by the session owner.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FUpdateSessionSettings](API\Plugins\OnlineServicesInterface\Online\FUpdateSessionSettings) > UpdateSessionSettings ( [FUpdateSessionSettings::Params](API\Plugins\OnlineServicesInterface\Online\FUpdateSessionSettings\Params) && Params )


code: virtual [TFuture](API\Runtime\Core\Async\TFuture)< [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FUpdateSessionSettings](API\Plugins\OnlineServicesInterface\Online\FUpdateSessionSettings) > > UpdateSessionSettingsImpl ( const [FUpdateSessionSettings::Params](API\Plugins\OnlineServicesInterface\Online\FUpdateSessionSettings\Params) & Params )


description: FSessionsCommon

code: FSessionsCommon ( [FOnlineServicesCommon](API\Plugins\OnlineServicesCommon\Online\FOnlineServicesCommon) & InServices )


className: FSessionsCommon

code: class FSessionsCommon : public [UE::Online::TOnlineComponent< ISessions >](API\Plugins\OnlineServicesCommon\Online\TOnlineComponent)

AllSessionsById

type: TMap<FOnlineSe...

description: Set of every distinct FSession found, indexed by Id

CurrentSessionSearchPromisesUserMap

description: Handle for an ongoing session search operation, mapped per user

LocalSessionsByName

type: TMap<FName,FO...

description: Map of sessions that local users are part of, indexed by their local name

NamedSessionUserMap

description: Map of named sessions a user is part of, indexed by user

PresenceSessionsUserMap

description: Map of sessions that local users have set as their presence session to appear in the platform UI.

SearchResultsUserMap

description: Cache for the last set of session search results, mapped per user

SessionInvitesUserMap

description: Cache for received session invites, mapped per user


description:
Accept a friend invite
AsyncOpHandle

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FAcceptFriendInvite](API\Plugins\OnlineServicesInterface\Online\FAcceptFriendInvite) > AcceptFriendInvite ( [FAcceptFriendInvite::Params](API\Plugins\OnlineServicesInterface\Online\FAcceptFriendInvite\Params) && Params )


description:
Block a user
AsyncOpHandle

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FBlockUser](API\Plugins\OnlineServicesInterface\Online\FBlockUser) > BlockUser ( [FBlockUser::Params](API\Plugins\OnlineServicesInterface\Online\FBlockUser\Params) && Params )


code: void BroadcastRelationshipUpdated ( [FAccountId](API\Runtime\CoreOnline\Online\FAccountId) LocalAccountId, [FAccountId](API\Runtime\CoreOnline\Online\FAccountId) RemoteAccountId, [ERelationship](API\Plugins\OnlineServicesInterface\Online\UE__Online__ERelationship) OldRelationship, [ERelationship](API\Plugins\OnlineServicesInterface\Online\UE__Online__ERelationship) NewRelationship )


description:
Get the contents of a previously queried friends list
Result

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FGetFriends](API\Plugins\OnlineServicesInterface\Online\FGetFriends) > GetFriends ( [FGetFriends::Params](API\Plugins\OnlineServicesInterface\Online\FGetFriends\Params) && Params )


description:
Get the contents of a previously queried blocked users list
Result

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FGetBlockedUsers](API\Plugins\OnlineServicesInterface\Online\FGetBlockedUsers) > GetBlockedUsers ( [FGetBlockedUsers::Params](API\Plugins\OnlineServicesInterface\Online\FGetBlockedUsers\Params) && Params )


description:
Get the event that is triggered when a friends list is updated This typically happens when QueryFriends is called, a friend or block list modifying function is called, or is called in response to an event coming from a backend service
Event that can be bound to


description:
Query the blocked users list
AsyncOpHandle

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FQueryBlockedUsers](API\Plugins\OnlineServicesInterface\Online\FQueryBlockedUsers) > QueryBlockedUsers ( [FQueryBlockedUsers::Params](API\Plugins\OnlineServicesInterface\Online\FQueryBlockedUsers\Params) && Params )


description: ISocial.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FQueryFriends](API\Plugins\OnlineServicesInterface\Online\FQueryFriends) > QueryFriends ( [FQueryFriends::Params](API\Plugins\OnlineServicesInterface\Online\FQueryFriends\Params) && Params )


description: TOnlineComponent.

code: virtual void RegisterCommands()


description:
Reject a friend invite
AsyncOpHandle

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FRejectFriendInvite](API\Plugins\OnlineServicesInterface\Online\FRejectFriendInvite) > RejectFriendInvite ( [FRejectFriendInvite::Params](API\Plugins\OnlineServicesInterface\Online\FRejectFriendInvite\Params) && Params )


description:
Send a friend invite
AsyncOpHandle

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FSendFriendInvite](API\Plugins\OnlineServicesInterface\Online\FSendFriendInvite) > SendFriendInvite ( [FSendFriendInvite::Params](API\Plugins\OnlineServicesInterface\Online\FSendFriendInvite\Params) && Params )


code: FSocialCommon ( [FOnlineServicesCommon](API\Plugins\OnlineServicesCommon\Online\FOnlineServicesCommon) & InServices )


className: FSocialCommon

code: class FSocialCommon : public [UE::Online::TOnlineComponent< ISocial >](API\Plugins\OnlineServicesCommon\Online\TOnlineComponent)


className: FStatDefinition

code: struct FStatDefinition

DefaultValue

type: FStatValue

description: Store the default type and value

Id

description: Corresponding stat id on the platform if needed

ModifyMethod

type: EStatModifyMeth...

description: How the stat will be modified

Name

type: FString

description: The name of the stat


description: Get stats of the specified users.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FBatchQueryStats](API\Plugins\OnlineServicesInterface\Online\FBatchQueryStats) > BatchQueryStats ( [FBatchQueryStats::Params](API\Plugins\OnlineServicesInterface\Online\FBatchQueryStats\Params) && Params )


code: void CacheUserStats ( const [FUserStats](API\Plugins\OnlineServicesInterface\Online\FUserStats) & UserStats )


description: Retrieve cached users' stats, which was retrieved when call QueryStats or BatchQueryStats, or after calling UpdateStats. When choose to use StatsNull, make sure to listen to OnStatsUpdated event and use this function to get all latest local stats and put them into SaveGame

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FGetCachedStats](API\Plugins\OnlineServicesInterface\Online\FGetCachedStats) > GetCachedStats ( [FGetCachedStats::Params](API\Plugins\OnlineServicesInterface\Online\FGetCachedStats\Params) && Params ) const


code: const [FStatDefinition](API\Plugins\OnlineServicesCommon\Online\FStatDefinition) * GetStatDefinition ( const [FString](API\Runtime\Core\Containers\FString) & StatName ) const


description: Get stats of the specified user.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FQueryStats](API\Plugins\OnlineServicesInterface\Online\FQueryStats) > QueryStats ( [FQueryStats::Params](API\Plugins\OnlineServicesInterface\Online\FQueryStats\Params) && Params )


description: Event triggered when stats of user(s) changed

code: virtual [TOnlineEvent](API\Plugins\OnlineServicesInterface\Online\TOnlineEvent)< void(const [FStatsUpdated](API\Plugins\OnlineServicesInterface\Online\FStatsUpdated) &)> OnStatsUpdated()


description: Reset stats of the local user.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FResetStats](API\Plugins\OnlineServicesInterface\Online\FResetStats) > ResetStats ( [FResetStats::Params](API\Plugins\OnlineServicesInterface\Online\FResetStats\Params) && Params )


description: TOnlineComponent.

code: virtual void UpdateConfig()


description: IStats.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FUpdateStats](API\Plugins\OnlineServicesInterface\Online\FUpdateStats) > UpdateStats ( [FUpdateStats::Params](API\Plugins\OnlineServicesInterface\Online\FUpdateStats\Params) && Params )


code: FStatsCommon ( [FOnlineServicesCommon](API\Plugins\OnlineServicesCommon\Online\FOnlineServicesCommon) & InServices )


className: FStatsCommon

code: class FStatsCommon : public [UE::Online::TOnlineComponent< IStats >](API\Plugins\OnlineServicesCommon\Online\TOnlineComponent)

CachedUsersStats

type: TArray<FUserSt...

StatDefinitions

type: TMap<FString, ...


className: FStatsCommonConfig

code: struct FStatsCommonConfig

type: TArray<FStatDe...


description: ITitleFile.

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FTitleFileEnumerateFiles](API\Plugins\OnlineServicesInterface\Online\FTitleFileEnumerateFiles) > EnumerateFiles ( [FTitleFileEnumerateFiles::Params](API\Plugins\OnlineServicesInterface\Online\FTitleFileEnumerateFiles\Params) && Params )


description: Get the cached list of files enumerated by previous call to EnumerateFiles

code: virtual [TOnlineResult](API\Plugins\OnlineServicesInterface\Online\TOnlineResult)< [FTitleFileGetEnumeratedFiles](API\Plugins\OnlineServicesInterface\Online\FTitleFileGetEnumeratedFiles) > GetEnumeratedFiles ( [FTitleFileGetEnumeratedFiles::Params](API\Plugins\OnlineServicesInterface\Online\FTitleFileGetEnumeratedFiles\Params) && Params )


description: Read a file and return the file contents

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FTitleFileReadFile](API\Plugins\OnlineServicesInterface\Online\FTitleFileReadFile) > ReadFile ( [FTitleFileReadFile::Params](API\Plugins\OnlineServicesInterface\Online\FTitleFileReadFile\Params) && Params )


description: TOnlineComponent.

code: virtual void RegisterCommands()


code: FTitleFileCommon ( [FOnlineServicesCommon](API\Plugins\OnlineServicesCommon\Online\FOnlineServicesCommon) & InServices )


className: FTitleFileCommon

code: class FTitleFileCommon : public [UE::Online::TOnlineComponent< ITitleFile >](API\Plugins\OnlineServicesCommon\Online\TOnlineComponent)


description: Copy file contents to another file

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FUserFileCopyFile](API\Plugins\OnlineServicesInterface\Online\FUserFileCopyFile) > CopyFile ( [FUserFileCopyFile::Params](API\Plugins\OnlineServicesInterface\Online\FUserFileCopyFile\Params) && Params )


description: Delete a file

code: virtual [TOnlineAsyncOpHandle](API\Plugins\OnlineServicesInterface\Online\TOnlineAsyncOpHandle)< [FUserFileDeleteFile](API\Plugins\OnlineServicesInterface\Online\FUserFileDeleteFile) > DeleteFile ( [FUserFileDeleteFile::Params](API\Plugins\OnlineServicesInterface\Online\FUserFileDeleteFile\Params) && Params )