Navigation
API > API/Plugins > API/Plugins/OnlineFrameworkCommon
Class to manage creation of and links between FCommonAccount
| Name | FCommonAccountManager |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineFrameworkCommon/Source/OnlineFrameworkCommon/Public/OnlineFramework/CommonAccountManager.h |
| Include Path | #include "OnlineFramework/CommonAccountManager.h" |
Syntax
class FCommonAccountManager : public TSharedFromThis< FCommonAccountManager >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FCommonAccountManager
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FCommonAccountManager
(
FPrivateToken, |
Constructor: Do not construct directly. Use Create instead. | OnlineFramework/CommonAccountManager.h | |
FCommonAccountManager
(
const FCommonAccountManager& |
OnlineFramework/CommonAccountManager.h | ||
| OnlineFramework/CommonAccountManager.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FCommonAccountManager() |
OnlineFramework/CommonAccountManager.h |
Structs
| Name | Remarks |
|---|---|
| FPrivateToken | |
| FRegisteredLookupFunction | Registered account id lookups. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FLookupIdAsync | TTuple< FCommonAccountRef, UE::Online::FAccountId > | Lookup an id for a account. | OnlineFramework/CommonAccountManager.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| RegisteredIdCounter | int32 | OnlineFramework/CommonAccountManager.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AccountIdLookups | TArray< FRegisteredLookupFunction > | OnlineFramework/CommonAccountManager.h | ||
| Accounts | TMap< UE::Online::FAccountId, FCommonAccountRef > | Registered accounts. Note that while FAccountId lacks context to know which framework instance it is for, FAccountId is unique enough to index on. | OnlineFramework/CommonAccountManager.h | |
| bCanPerformAsyncLookup | bool | Whether we can accept new async lookup requests or not. | OnlineFramework/CommonAccountManager.h | |
| CommonConfig | FCommonConfig | Common config to resolve FrameworkInstance to online services. | OnlineFramework/CommonAccountManager.h | |
| OnCommonAccountCreatedEvent | FOnCommonAccountCreated | OnlineFramework/CommonAccountManager.h | ||
| OnCommonAccountDuplicateDetectedEvent | FOnCommonAccountDuplicateDetected | OnlineFramework/CommonAccountManager.h | ||
| OnCommonAccountIdAddedEvent | FOnCommonAccountIdAdded | OnlineFramework/CommonAccountManager.h | ||
| PendingLookups | TMap< TSharedRef< TPromise< FLookupIdAsync > >, FCommonAccountPtr > | In progress lookups. | OnlineFramework/CommonAccountManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FCommonAccountPtr GetAccount
(
UE::Online::FAccountId AccountId, |
Get an existing or create a new account given an account id and FrameworkInstance | OnlineFramework/CommonAccountManager.h | |
FOnCommonAccountCreated & OnCommonAccountCreated() |
OnlineFramework/CommonAccountManager.h | ||
FOnCommonAccountDuplicateDetected & OnCommonAccountDuplicateDetected() |
OnlineFramework/CommonAccountManager.h | ||
FOnCommonAccountIdAdded & OnCommonAccountIdAdded() |
OnlineFramework/CommonAccountManager.h | ||
FCommonAccountLookupAccountIdFnHandle RegisterAccountIdLookup
(
FStringView Name, |
Register a function to perform lookups | OnlineFramework/CommonAccountManager.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void ClearRegistered
(
const FCommonConfig& InCommonConfig |
Clear the account manager for a context. | OnlineFramework/CommonAccountManager.h | |
static FCommonAccountManagerPtr Get
(
const FCommonConfig& InCommonConfig |
Get the account manager for a context | OnlineFramework/CommonAccountManager.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FCommonAccountManager & operator=
(
const FCommonAccountManager& |
OnlineFramework/CommonAccountManager.h | ||
| OnlineFramework/CommonAccountManager.h |