code: typedef TMulticastDelegate_TwoParams< void, const [FConcertClientLocalTransactionCommonData](API\Plugins\ConcertSyncClient\FConcertClientLocalTransactionCo-) &, const [FConcertClientLocalTransactionFinalizedData](API\Plugins\ConcertSyncClient\FConcertClientLocalTransactionFi-) & > FOnConcertClientLocalTransactionFinalized


module: ConcertSyncClient

code: typedef TMulticastDelegate_OneParam< void, const [IConcertSyncClient](API\Plugins\ConcertSyncClient\IConcertSyncClient) * > FOnConcertClientSyncSessionStartupOrShutdown


code: typedef TMulticastDelegate_OneParam< void, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IConcertClientWorkspace](API\Plugins\ConcertSyncClient\IConcertClientWorkspace) > & > FOnConcertClientWorkspaceStartupOrShutdown


code: typedef TMulticastDelegate_OneParam< void, const [FConcertConflictDescriptionBase](API\Plugins\ConcertSyncClient\FConcertConflictDescriptionBase) &ConflictDescription > FOnConcertConflictResolutionForPendingSend


className: FOnExecuteAction

code: typedef TBaseDelegate_NoParams< void > FOnExecuteAction


className: FOnFinalizeWorkspaceSyncCompleted

code: typedef TMulticastDelegate_NoParams< void > FOnFinalizeWorkspaceSyncCompleted


className: FOnWorkspaceSynchronized

code: typedef TMulticastDelegate_NoParams< void > FOnWorkspaceSynchronized


className: FPackageFilterDelegate

code: typedef TBaseDelegate_OneParam< [EPackageFilterResult](API\Plugins\ConcertSyncClient\EPackageFilterResult), const [FConcertPackageInfo](API\Plugins\ConcertSyncCore\FConcertPackageInfo) & > FPackageFilterDelegate


className: FPersistParameters

description: Input parameters for persistance of an existing session.

code: struct FPersistParameters

bShouldMakeWritableIfNoSourceControl

type: bool

description: Boolean to control if we will force the file writable when no source control provider is active.

PackagesToPersist

type: TArrayView< con...

description: Name of the packages to persist.

SourceControlProvider

type: ISourceControlP...

description: Pointer to the source control provider.


className: FPersistResult

description: Result of a persist.

code: struct FPersistResult

FailureReasons

type: TArray<FText>

description: List of reasons for persist failure.

PersistStatus

type: EPersistStatus

description: Success or failure of the session persist.


className: FTransactionFilterDelegate

code: typedef TBaseDelegate_TwoParams< [ETransactionFilterResult](API\Plugins\ConcertSyncCore\ETransactionFilterResult), [UObject](API\Runtime\CoreUObject\UObject\UObject) *, [UPackage](API\Runtime\CoreUObject\UObject\UPackage) * > FTransactionFilterDelegate


description: Collects any reference toUObjectthe mode may have Called by the presence manager in its own AddReferencedObjects

code: void AddReferencedObjects ( [FReferenceCollector](API\Runtime\CoreUObject\UObject\FReferenceCollector) & Collector )


description:
Get the current presence transform
the presence mode transform

code: FTransform GetTransform()


description:
Get the VR device type represented by this presence mode. NAME_None for desktop or non vr presence mode.
the vr device type


description: Send events for this presence mode This will be called by the presence manager during tick.

code: void SendEvents ( [IConcertClientSession](API\Plugins\Concert\IConcertClientSession) & Session )


className: IConcertClientBasePresenceMode

description: 1) Add a presence mode class inherited fromIConcertClientBasePresenceModeto send events and cache state, if needed, for the current client. 2) Add a presence actor class to handle events and display the avatar for remote clients.

code: class IConcertClientBasePresenceMode


description: TConcertDataStoreResult::GetValue()

code: template<typename T> [TFuture](API\Runtime\Core\Async\TFuture)< [TConcertDataStoreResult](API\Plugins\ConcertSyncCore\TConcertDataStoreResult)< T > > CompareExchange ( const [FName](API\Runtime\Core\UObject\FName) & Key, const T & Expected, const T & Desired )


className: FChangeNotificationHandler

description: The function called back when the data store is updated by another client.

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const [FName](API\Runtime\Core\UObject\FName) &, const [FConcertDataStore_StoreValue](API\Plugins\ConcertSyncCore\FConcertDataStore_StoreValue) *)> FChangeNotificationHandler


description: TConcertDataStoreResult::GetValue()

code: template<typename T> [TFuture](API\Runtime\Core\Async\TFuture)< [TConcertDataStoreResult](API\Plugins\ConcertSyncCore\TConcertDataStoreResult)< T > > FetchAs ( const [FName](API\Runtime\Core\UObject\FName) & Key ) const


description: TConcertDataStoreResult::GetValue()

code: template<typename T> [TFuture](API\Runtime\Core\Async\TFuture)< [TConcertDataStoreResult](API\Plugins\ConcertSyncCore\TConcertDataStoreResult)< T > > FetchOrAdd ( const [FName](API\Runtime\Core\UObject\FName) & Key, const T & InitialValue )


code: template<typename T> TFuture< FConcertDataStoreResult > InternalCompareExchange &40; const FName & Key, const typename TConcertDataStoreType< T >::StructType & Expected, const typename TConcertDataStoreType< T >::StructType & Desired &41;


description: IConcertClientDataStore::CompareExchange()

code: [TFuture](API\Runtime\Core\Async\TFuture)< [FConcertDataStoreResult](API\Plugins\ConcertSyncCore\FConcertDataStoreResult) > InternalCompareExchange ( const [FName](API\Runtime\Core\UObject\FName) & Key, const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * Type, const [FName](API\Runtime\Core\UObject\FName) & TypeName, const void * Expected, const void * Desired )


description: IConcertClientDataStore::FetchAs()

code: [TFuture](API\Runtime\Core\Async\TFuture)< [FConcertDataStoreResult](API\Plugins\ConcertSyncCore\FConcertDataStoreResult) > InternalFetchAs ( const [FName](API\Runtime\Core\UObject\FName) & Key, const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * Type, const [FName](API\Runtime\Core\UObject\FName) & TypeName ) const


code: template<typename T> TFuture< FConcertDataStoreResult > InternalFetchOrAdd &40; const FName & Key, const typename TConcertDataStoreType< T >::StructType & InitialValue &41;


description: IConcertClientDataStore::FetchOrAdd()

code: [TFuture](API\Runtime\Core\Async\TFuture)< [FConcertDataStoreResult](API\Plugins\ConcertSyncCore\FConcertDataStoreResult) > InternalFetchOrAdd ( const [FName](API\Runtime\Core\UObject\FName) & Key, const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * Type, const [FName](API\Runtime\Core\UObject\FName) & TypeName, const void * Payload )


description: IConcertClientDataStore::RegisterChangeNotificationHandler()

code: void InternalRegisterChangeNotificationHandler ( const [FName](API\Runtime\Core\UObject\FName) & Key, const [FName](API\Runtime\Core\UObject\FName) & TypeName, const [FChangeNotificationHandler](API\Plugins\ConcertSyncClient\IConcertClientDataStore\FChangeNotificationHandler) & Handler, [EConcertDataStoreChangeNotificationOptions](API\Plugins\ConcertSyncClient\EConcertDataStoreChangeNotificat-) Options )


description: Unregisters the delegate corresponding to the specified key (if any) to stop receiving the key change notifications.

code: void InternalUnregisterChangeNotificationHandler ( const [FName](API\Runtime\Core\UObject\FName) & Key )


description: Registers(or replaces) a handler invoked every time another client successfully adds or updates the specified key. The server pushes a notification for the added/updated key to all clients except the one that performed the change.Bydefault, the data store immediately calls back the client if the key value is known. This is recommended to prevent callingFetchAs()andRegisterChangeNotificationHandler()in a non-safe order where a key/value could be missed if it appears between a failed fetch and the successful registration of a handler.Bydefault, the handler will be called even if the key type expected by the client doesn't match the stored type. In such case, the handler optional value is not set.

code: template<typename T> void RegisterChangeNotificationHandler ( const [FName](API\Runtime\Core\UObject\FName) & InKey, const [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const [FName](API\Runtime\Core\UObject\FName) &, [TOptional](API\Runtime\Core\IO\TOptional)< T >)> & Handler, [EConcertDataStoreChangeNotificationOptions](API\Plugins\ConcertSyncClient\EConcertDataStoreChangeNotificat-) Options )


description: Unregisters the function callback corresponding to the specified key (if any) to stop receiving the key change notifications.

code: void UnregisterChangeNotificationHander ( const [FName](API\Runtime\Core\UObject\FName) & Key )


description: Destructor.

code: virtual ~IConcertClientDataStore()


className: IConcertClientDataStore

code: class IConcertClientDataStore


code: FScopedIgnoreLocalDiscard &40; IConcertClientPackageBridge & InPackageBridge &41;


className: FScopedIgnoreLocalDiscard

description: Scoped struct to ignore a local discard

code: struct FScopedIgnoreLocalDiscard : private [TGuardValue< bool >](API\Runtime\Core\Templates\TGuardValue)


code: FScopedIgnoreLocalSave &40; IConcertClientPackageBridge & InPackageBridge &41;


className: FScopedIgnoreLocalSave

description: Scoped struct to ignore a local save

code: struct FScopedIgnoreLocalSave : private [TGuardValue< bool >](API\Runtime\Core\Templates\TGuardValue)


description: Exists to implementFScopedIgnoreLocalSave.

code: bool & GetIgnoreLocalSaveRef()


description: Exists to implementFScopedIgnoreLocalDiscard.

code: bool & GetIgnoreLocalDiscardRef()


description: Returns true if the package should be filtered from the local sandbox.

code: [EPackageFilterResult](API\Plugins\ConcertSyncClient\EPackageFilterResult) IsPackageFiltered ( const [FConcertPackageInfo](API\Plugins\ConcertSyncCore\FConcertPackageInfo) & PackageInfo ) const


description: Called when a local package is discarded.


description: Called when a local package event happens.


description: Register a package filter to exclude/include certain packagins from the session.

code: void RegisterPackageFilter ( [FName](API\Runtime\Core\UObject\FName) FilterName, [FPackageFilterDelegate](API\Plugins\ConcertSyncClient\FPackageFilterDelegate) FilterHandle )


description: Unregister package filter for handling package filtering.

code: void UnregisterPackageFilter ( [FName](API\Runtime\Core\UObject\FName) FilterName )


code: virtual ~IConcertClientPackageBridge()


className: IConcertClientPackageBridge

description: Bridge between the editor package events and Concert. Deals with converting package update events to Concert package data.

code: class IConcertClientPackageBridge


description:
Get the presence actor transform for the specified client endpoint id
the transform of the client or the identity transform if the client wasn't found.

code: FTransform GetPresenceTransform ( const [FGuid](API\Runtime\Core\Misc\FGuid) & EndpointId ) const


description:
Returns the path to theUWorldobject opened in the editor of the specified client endpoint. The information may be unavailable if the client was disconnected, the information hasn't replicated yet or the code was not compiled as part of the UE Editor. This function always returns the editor context world path, never the PIE/SIE context world path (which contains a UEDPIE_d_ decoration embedded) even if the user is in PIE or SIE. For example, the PIE/SIE context world path would look like '/Game/UEDPIE_10_FooMap.FooMap' while the editor context world returned by this function looks like '/Game/FooMap.FooMap'.
The path to the world being opened in the specified end point editor or an empty string if the information is not available.

code: [FString](API\Runtime\Core\Containers\FString) GetPresenceWorldPath ( const [FGuid](API\Runtime\Core\Misc\FGuid) & EndpointId, [EEditorPlayMode](API\Plugins\ConcertSyncClient\EEditorPlayMode) & OutEditorPlayMode ) const


description: Jump (teleport) to another presence

code: void InitiateJumpToPresence ( const [FGuid](API\Runtime\Core\Misc\FGuid) & InEndpointId, const FTransform & InTransformOffet )


description: Set whether presence is currently enabled and should be shown (unless hidden by other settings)

code: void SetPresenceEnabled ( const bool bIsEnabled )


description: Set the presence mode factory The factory creates the presence mode for the manager

code: void SetPresenceModeFactory ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IConcertClientPresenceModeFactory](API\Plugins\ConcertSyncClient\IConcertClientPresenceModeFactor-) > InFactory )


description: setting presence by name will persist through connection of client using this display name

code: void SetPresenceVisibility ( const [FString](API\Runtime\Core\Containers\FString) & InDisplayName, bool bVisibility, bool bPropagateToAll )


description: Set presence visibility of the specified client endpoint id

code: void SetPresenceVisibility ( const [FGuid](API\Runtime\Core\Misc\FGuid) & EndpointId, bool bVisibility, bool bPropagateToAll )


className: IConcertClientPresenceManager

code: class IConcertClientPresenceManager


description: Collects any reference toUObjectthe factory may have Called by the presence manager in its own AddReferencedObjects

code: void AddReferencedObjects ( [FReferenceCollector](API\Runtime\CoreUObject\UObject\FReferenceCollector) & Collector )


description: ShouldResetPresenceMode


description:
Indicate if the presence mode should be reset for recreation Called by the presence manager on end frame tick.
true if the current presence mode in the presence manager should be reset

code: bool ShouldResetPresenceMode() const


className: IConcertClientPresenceModeFactory

description: IConcertClientPresenceManager

code: class IConcertClientPresenceModeFactory


description: true if playback syncing across opened sequencer is enabled


description: true if the remote open option is enabled.


description: true if the remote close option is enabled.


description: true if unrelated timeline syncing across opened sequencer is enabled


description: Set the remote close option in Multi-User which closes Sequencer for this user when the sequence is closed by a remote user.

code: void SetSequencerRemoteClose ( bool bEnable )


description: Set the remote open option in Multi-User which opens Sequencer for other users when this option is enabled on both user machines.

code: void SetSequencerRemoteOpen ( bool bEnable )


description: Set the playback syncing option in Multi-User which syncs playback across user for opened sequencer.

code: void SetSequencerPlaybackSync ( bool bEnable )


description: Set the unrelated timeline syncing option in Multi-User which syncs time from any remote sequence.

code: void SetUnrelatedSequencerTimelineSync ( bool bEnable )


description: Apply a remote transaction event to this local instance.

code: void ApplyRemoteTransaction ( const [FConcertTransactionEventBase](API\Plugins\ConcertSyncCore\FConcertTransactionEventBase) & InEvent, const [FConcertSessionVersionInfo](API\Plugins\Concert\FConcertSessionVersionInfo) * InVersionInfo, const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & InPackagesToProcess, const [FConcertLocalIdentifierTable](API\Plugins\ConcertTransport\IdentifierTable\FConcertLocalIdentifierTable) * InLocalIdentifierTablePtr, const bool bIsSnapshot )


className: IConcertClientSequencerManager

description: Sequencer manager that is held by the client sync module that keeps track of open sequencer UIs, regardless of whether a session is open or not Events are registered to client sessions that will then operate on any tracked sequencer UIs

code: class IConcertClientSequencerManager


code: void ApplyRemoteTransaction ( const [FConcertTransactionEventBase](API\Plugins\ConcertSyncCore\FConcertTransactionEventBase) & InEvent, const [FConcertSessionVersionInfo](API\Plugins\Concert\FConcertSessionVersionInfo) * InVersionInfo, const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & InPackagesToProcess, const [FConcertLocalIdentifierTable](API\Plugins\ConcertTransport\IdentifierTable\FConcertLocalIdentifierTable) * InLocalIdentifierTablePtr, const bool bIsSnapshot, const class [FConcertSyncWorldRemapper](API\Plugins\ConcertSyncCore\FConcertSyncWorldRemapper) & ConcertSyncWorldRemapper )


description:
Can we currently apply a remote transaction event to this local instance?
True if we can apply a remote transaction, false otherwise.

code: bool CanApplyRemoteTransaction() const


code: FScopedIgnoreLocalTransaction &40; IConcertClientTransactionBridge & InTransactionBridge &41;


className: FScopedIgnoreLocalTransaction

description: Scoped struct to ignore a local transaction

code: struct FScopedIgnoreLocalTransaction : private [TGuardValue< bool >](API\Runtime\Core\Templates\TGuardValue)


description: Create a new instance of the concrete implementation of this class.


description: Exists to implementFScopedIgnoreLocalTransaction.

code: bool & GetIgnoreLocalTransactionsRef()


description: Notification of an application of a transaction. This will tell the user if the transaction originates as a snapshot or is a finalized snapshot message.


description: Callback when a conflict occurs on pending transactions.


description: This is called during end-frame processing.


description: Callback to register delegate for handling transaction events

code: void RegisterTransactionFilter ( [FName](API\Runtime\Core\UObject\FName) FilterName, [FTransactionFilterDelegate](API\Plugins\ConcertSyncClient\FTransactionFilterDelegate) FilterHandle )


description: This is set to true by default.

code: void SetIncludeEditorOnlyProperties ( const bool InIncludeEditorOnlyProperties )


description: This is set toUConcertSyncConfig::bIncludeAnnotationObjectChangesby default.

code: void SetIncludeAnnotationObjectChanges ( const bool InIncludeAnnotationObjectChanges )


description: This is set to true by default.

code: void SetIncludeNonPropertyObjectData ( const bool InIncludeNonPropertyObjectData )


code: void UnregisterTransactionFilter ( [FName](API\Runtime\Core\UObject\FName) FilterName )


className: IConcertClientTransactionBridge

description: Bridge between the editor transaction system and Concert. Deals with converting local ongoing transactions to Concert transaction data, and applying remote Concert transaction data onto this local instance.

code: class IConcertClientTransactionBridge


description: This delegate allows user to defer the finalization of a package updates. This is for situtations where multiple client nodes need finalize their package updates together. The delegate function should return true when workspace synchronization is allowed and it will be called on OnEndFrame() of the tick loop.

code: void AddWorkspaceCanProcessPackagesDelegate ( [FName](API\Runtime\Core\UObject\FName) InDelegateName, [FCanProcessPendingPackages](API\Plugins\ConcertSyncClient\FCanProcessPendingPackages) Delegate )


description: This delegate allows user to defer the finalization of a sync workspace. This is for situtations where multiple client nodes need to be finalized at the same point in time. The delegate function should return true when workspace synchronization is allowed and it will be called on OnEndFrame() of the tick loop.

code: void AddWorkspaceFinalizeDelegate ( [FName](API\Runtime\Core\UObject\FName) InDelegateName, [FCanFinalizeWorkspaceDelegate](API\Plugins\ConcertSyncClient\FCanFinalizeWorkspaceDelegate) InDelegate )


description:
passing an invalid client id will return true if all resources are unlocked
true if all resources in ResourceNames are locked by ClientId

code: bool AreResourcesLockedBy ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > ResourceNames, const [FGuid](API\Runtime\Core\Misc\FGuid) & ClientId )


description:
If only the meta data is required, consider usingFindTransactionEvent()as it is more efficient.
A future containing the event, if found. If bMetaDataOnly is false and the event was partially synced (because it was superseded by another one) the function will perform an asynchronous server request to get the transaction data.

code: [TFuture](API\Runtime\Core\Async\TFuture)< [TOptional](API\Runtime\Core\IO\TOptional)< [FConcertSyncTransactionEvent](API\Plugins\ConcertSyncCore\FConcertSyncTransactionEvent) > > FindOrRequestTransactionEvent ( const int64 TransactionEventId, const bool bMetaDataOnly )


description:
Lookup the specified package event.
Whether the package event meta data was found.

code: bool FindPackageEvent ( const int64 PackageEventId, [FConcertSyncPackageEventMetaData](API\Plugins\ConcertSyncCore\FConcertSyncPackageEventMetaData) & OutPackageEvent ) const


description: FindOrRequestTransactionEvent()ifthe full transaction data is required.

code: bool FindTransactionEvent ( const int64 TransactionEventId, [FConcertSyncTransactionEvent](API\Plugins\ConcertSyncCore\FConcertSyncTransactionEvent) & OutTransactionEvent, const bool bMetaDataOnly ) const


description:
Gather assets changes that happened on the workspace in this session.
a list of package names that were modified during the session.

code: [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > GatherSessionChanges ( bool IgnorePersisted )


description: Get Activities from the session.

code: void GetActivities ( const int64 FirstActivityIdToFetch, const int64 MaxNumActivities, [TMap](API\Runtime\Core\Containers\TMap)< [FGuid](API\Runtime\Core\Misc\FGuid), [FConcertClientInfo](API\Plugins\Concert\FConcertClientInfo) > & OutEndpointClientInfoMap, [TArray](API\Runtime\Core\Containers\TArray)< [FConcertSessionActivity](API\Plugins\ConcertSyncCore\FConcertSessionActivity) > & OutActivities ) const


description: the key/value store shared by all clients.


description: Get the ID of the last activity in the session.

code: int64 GetLastActivityId() const


description: a valid client id of the owner of this resource lock or an invalid id if unlocked

code: [FGuid](API\Runtime\Core\Misc\FGuid) GetResourceLockId ( const [FName](API\Runtime\Core\UObject\FName) InResourceName ) const


description: Get the associated session.

code: [IConcertClientSession](API\Plugins\Concert\IConcertClientSession) & GetSession() const


description:
Returns the full path to the package if it is a valid package session change.
the full path to the package if it is valid.

code: [TOptional](API\Runtime\Core\IO\TOptional)< [FString](API\Runtime\Core\Containers\FString) > GetValidPackageSessionPath ( [FName](API\Runtime\Core\UObject\FName) PackageName ) const


description: the client id this workspace uses to lock resources.


description:
Indicate if an asset package is supported for live transactions.
true if we support live transactions for objects inside the package

code: bool HasLiveTransactionSupport ( class [UPackage](API\Runtime\CoreUObject\UObject\UPackage) * InPackage ) const


description:
Tell if a workspace contains session changes.
True if the session contains any changes.

code: bool HasSessionChanges() const


description: Returns true if the specified asset has unsaved modifications from any other client than the one corresponding to this workspace client and possibly returns more information about those other clients.

code: bool IsAssetModifiedByOtherClients ( const [FName](API\Runtime\Core\UObject\FName) & AssetName, int32 * OutOtherClientsWithModifNum, [TArray](API\Runtime\Core\Containers\TArray)< [FConcertClientInfo](API\Plugins\Concert\FConcertClientInfo) > * OutOtherClientsWithModifInfo, int32 OtherClientsWithModifMaxFetchNum ) const


description: Returns true if the current named package is being reloaded by the package manager.

code: bool IsReloadingPackage ( [FName](API\Runtime\Core\UObject\FName) PackageName ) const


description:
Passing force will always assign the lock to the given endpoint, even if currently locked by another.
True if the resource was locked (or already locked by the given endpoint), false otherwise.

code: [TFuture](API\Runtime\Core\Async\TFuture)< [FConcertResourceLockResponse](API\Plugins\ConcertSyncCore\FConcertResourceLockResponse) > LockResources ( [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > InResourceName )


description: the delegate called every time an activity is added to or updated in the session.


description: The delegate called after a workspace has been completely synced and finalized. All transactions are posted and packages have been loaded.


description: the delegate called every time the workspace is synced. This is when the server has indicated that all activities have been sent and ready to be finalized in the current workspace.


description: Persist the session changes from the package list and prepare it for source control submission

code: [FPersistResult](API\Plugins\ConcertSyncClient\FPersistResult) PersistSessionChanges ( [FPersistParameters](API\Plugins\ConcertSyncClient\FPersistParameters) InParam )


description: Remove the attached named delegate for workspace finalization.

code: void RemoveWorkspaceFinalizeDelegate ( [FName](API\Runtime\Core\UObject\FName) InDelegateName )


description: Remove the attached named delegate for package synchronization.

code: void RemoveWorkspaceCanProcessPackagesDelegate ( [FName](API\Runtime\Core\UObject\FName) InDelegateName )


description: This was implemented to prevent multi-users transactions from being restored by disaster recovery in case of a crash during as multi-user session.

code: void SetIgnoreOnRestoreFlagForEmittedActivities ( bool bIgnore )


description:
Indicate if package dirty event should be ignored for a package
true if dirty event should be ignored for said package.

code: bool ShouldIgnorePackageDirtyEvent ( class [UPackage](API\Runtime\CoreUObject\UObject\UPackage) * InPackage ) const


description:
Passing force will always clear, even if currently locked by another endpoint.
True if the resource was unlocked, false otherwise.

code: [TFuture](API\Runtime\Core\Async\TFuture)< [FConcertResourceLockResponse](API\Plugins\ConcertSyncCore\FConcertResourceLockResponse) > UnlockResources ( [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > InResourceName )


className: IConcertClientWorkspace

code: class IConcertClientWorkspace


description: Get the current client


description: Get the current package bridge for this client.

code: [IConcertClientPackageBridge](API\Plugins\ConcertSyncClient\IConcertClientPackageBridge) * GetPackageBridge() const


description: that pointer shouldn't be stored and always accessed through this client.


description: Queries the list of opaque actions that could be performed on the specified client session, like turning the client presence visibily on/off in the map. The actions are usually mapped to buttons and are a way to provide extra functionalities while keeping the implementation hidden.

code: void GetSessionClientActions ( const [FConcertSessionClientInfo](API\Plugins\Concert\FConcertSessionClientInfo) & InClientInfo, [TArray](API\Runtime\Core\Containers\TArray)< [FConcertActionDefinition](API\Plugins\ConcertSyncClient\FConcertActionDefinition) > & OutActions ) const


description: Get the current transaction bridge for this client


description: Get the current session client workspace, if any.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IConcertClientWorkspace](API\Plugins\ConcertSyncClient\IConcertClientWorkspace) > GetWorkspace() const


description: Get the delegate called just after the workspace gets deleted.


description: Get the delegate called just before the workspace gets created.


description: Get the delegate called on every workspace shutdown.


description: Get the delegate called on every workspace startup.


description: Persist all session changes and prepare the files for source control submission.

code: void PersistAllSessionChanges()


description: Set the file sharing service, enabling the server to work with large files. The client and the server must use compatible sharing services. The service must be set prior establishing a connection.

code: void SetFileSharingService ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IConcertFileSharingService](API\Plugins\ConcertSyncCore\IConcertFileSharingService) > InFileSharingService )


description: Persist specific packages

code: void PersistSpecificChanges ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > Packages )


description: Stop this Concert Sync Client

code: void Shutdown()


code: virtual ~IConcertSyncClient()


className: IConcertSyncClient

description: Interface for a Concert Sync Client.

code: class IConcertSyncClient


description:
Create a sync client that will perform a certain role (eg, MultiUser, DisasterRecovery, etc)
The client

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IConcertSyncClient](API\Plugins\ConcertSyncClient\IConcertSyncClient) > CreateClient ( const [FString](API\Runtime\Core\Containers\FString) & InRole )


description:
Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed

code: static [IConcertSyncClientModule](API\Plugins\ConcertSyncClient\IConcertSyncClientModule) & Get()


description: Returns the list of active clients.

code: [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IConcertSyncClient](API\Plugins\ConcertSyncClient\IConcertSyncClient) > > GetClients() const


description: Find a concert sync client.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IConcertSyncClient](API\Plugins\ConcertSyncClient\IConcertSyncClient) > GetClient ( const [FString](API\Runtime\Core\Containers\FString) & InRole ) const


description: Get the bridge between the editor package system and Concert.


description: Get the bridge between the editor transaction system and Concert.


description:
Checks to see if this module is loaded and ready. It is only valid to callGet()during shutdown ifIsAvailable()returns true.
True if the module is loaded and ready to use

code: static bool IsAvailable()


description: Delegate invoked when a new concert sync client is created.


description: Start this Concert Sync Client using the given config

code: void Startup ( const [UConcertClientConfig](API\Plugins\ConcertClient\UConcertClientConfig) * InClientConfig, const [EConcertSyncSessionFlags](API\Plugins\ConcertSyncCore\EConcertSyncSessionFlags) InSessionFlags )


description:
Parse command line client settings and apply them
The client settings, modified or not by the command line

code: [UConcertClientConfig](API\Plugins\ConcertClient\UConcertClientConfig) * ParseClientSettings ( const TCHAR * CommandLine )


className: IConcertSyncClientModule

description: Interface for the Concert Sync Client module.

code: class IConcertSyncClientModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


className: operator&=

code: [EConcertDataStoreChangeNotificationOptions](API\Plugins\ConcertSyncClient\EConcertDataStoreChangeNotificat-) & operator&= ( [EConcertDataStoreChangeNotificationOptions](API\Plugins\ConcertSyncClient\EConcertDataStoreChangeNotificat-) & Lhs, [EConcertDataStoreChangeNotificationOptions](API\Plugins\ConcertSyncClient\EConcertDataStoreChangeNotificat-) Rhs )


className: operator^=

code: [EConcertDataStoreChangeNotificationOptions](API\Plugins\ConcertSyncClient\EConcertDataStoreChangeNotificat-) & operator^= ( [EConcertDataStoreChangeNotificationOptions](API\Plugins\ConcertSyncClient\EConcertDataStoreChangeNotificat-) & Lhs, [EConcertDataStoreChangeNotificationOptions](API\Plugins\ConcertSyncClient\EConcertDataStoreChangeNotificat-) Rhs )


className: operator!

code: constexpr bool operator! ( [EConcertDataStoreChangeNotificationOptions](API\Plugins\ConcertSyncClient\EConcertDataStoreChangeNotificat-) E )


module: ConcertSyncCore

code: namespace ActivitySummaryUtil { void ActivitySummaryUtil::DebugPrintExportedObject ( const [FConcertExportedObject](API\Plugins\ConcertSyncCore\FConcertExportedObject) & Object ) }


code: namespace ActivitySummaryUtil { void ActivitySummaryUtil::DebugPrintExportedObject ( const [FString](API\Runtime\Core\Containers\FString) & Pathname, const [FConcertExportedObject](API\Plugins\ConcertSyncCore\FConcertExportedObject) * Objects ) }


code: namespace ActivitySummaryUtil { void ActivitySummaryUtil::DebugPrintExportedObjects ( const [FString::ElementType](API\Runtime\Core\Containers\FString\ElementType) * Title, const [TArray](API\Runtime\Core\Containers\TArray)< TPair< const [FString](API\Runtime\Core\Containers\FString) *, const [FConcertExportedObject](API\Plugins\ConcertSyncCore\FConcertExportedObject) * >> & Objects ) }


code: namespace ActivitySummaryUtil { void ActivitySummaryUtil::DebugPrintExportedObjects ( const [FString::ElementType](API\Runtime\Core\Containers\FString\ElementType) * Title, const [TArray](API\Runtime\Core\Containers\TArray)< TPair< [FString](API\Runtime\Core\Containers\FString), const [FConcertExportedObject](API\Plugins\ConcertSyncCore\FConcertExportedObject) * >> & Objects ) }


code: namespace ActivitySummaryUtil { [FName](API\Runtime\Core\UObject\FName) ActivitySummaryUtil::GetObjectDisplayName ( const [FString](API\Runtime\Core\Containers\FString) & ObjectPathName ) }


code: namespace ActivitySummaryUtil { [FText](API\Runtime\Core\Internationalization\FText) ActivitySummaryUtil::ToRichTextBold ( const [FText](API\Runtime\Core\Internationalization\FText) & InArgs, bool bToRichText ) }


code: namespace ActivitySummaryUtil { [FName](API\Runtime\Core\UObject\FName) ActivitySummaryUtil::GetObjectDisplayName ( const [FString](API\Runtime\Core\Containers\FString) & OuterPathName, const [FName](API\Runtime\Core\UObject\FName) & ObjectName ) }


code: namespace ActivitySummaryUtil { [FText](API\Runtime\Core\Internationalization\FText) ActivitySummaryUtil::ToRichTextBold ( const [FString](API\Runtime\Core\Containers\FString) & InArgs, bool bToRichText ) }


code: namespace ActivitySummaryUtil { [FText](API\Runtime\Core\Internationalization\FText) ActivitySummaryUtil::ToRichTextBold ( const [FName](API\Runtime\Core\UObject\FName) & InArgs, bool bToRichText ) }


description:
Check to see whether the transaction event with the given ID passes the given filter.
True if the transaction event passes the filter, false otherwise.

code: namespace ConcertSyncSessionDatabaseFilterUtil { bool ConcertSyncSessionDatabaseFilterUtil::TransactionEventPassesFilter ( const int64 InTransactionEventId, const [FConcertSessionFilter](API\Plugins\Concert\FConcertSessionFilter) & InSessionFilter, const [FConcertSyncSessionDatabase](API\Plugins\ConcertSyncCore\FConcertSyncSessionDatabase) & InDatabase ) }


description:
Check to see whether the package event with the given ID passes the given filter.
True if the package event passes the filter, false otherwise.

code: namespace ConcertSyncSessionDatabaseFilterUtil { bool ConcertSyncSessionDatabaseFilterUtil::PackageEventPassesFilter ( const int64 InPackageEventId, const [FConcertSessionFilter](API\Plugins\Concert\FConcertSessionFilter) & InSessionFilter, const [FConcertSyncSessionDatabase](API\Plugins\ConcertSyncCore\FConcertSyncSessionDatabase) & InDatabase ) }


className: EBreakBehavior

code: enum EBreakBehavior { Break, Continue, }


className: EConcertDataStoreResultCode

description: Response codes for Concert data store operations.

code: enum EConcertDataStoreResultCode { Added, Fetched, Exchanged, NotFound, TypeMismatch, UnexpectedError, }


className: EConcertMovieScenePlayerStatus

description: Enum for the current Sequencer player status, should matchEMovieScenePlayerStatus::TypeDefined here to not have a dependency on the MovieScene module.

code: enum EConcertMovieScenePlayerStatus { Stopped, Playing, Scrubbing, Jumping, Stepping, Paused, MAX, }


className: EConcertPackageUpdateType

code: enum EConcertPackageUpdateType { Dummy, Added, Saved, Renamed, Deleted, Count, }


className: EConcertResourceLockType

code: enum EConcertResourceLockType { None, Lock, Unlock, }


className: EConcertPlaySessionEventType

code: enum EConcertPlaySessionEventType { None, BeginPlay, SwitchPlay, EndPlay, }


className: EConcertSequencerPreloadStatus

code: enum EConcertSequencerPreloadStatus { Pending, Succeeded, Failed, }


className: EConcertSyncActivityEventType

description: Types of activity events

code: enum EConcertSyncActivityEventType { None = 0, Connection, Lock, Transaction, Package, }


className: EConcertSyncActivityFlags

code: enum EConcertSyncActivityFlags { None = 0, Muted = 1 << 0, }


className: EConcertSyncConnectionEventType

description: Types of connection events

code: enum EConcertSyncConnectionEventType { Connected = 0, Disconnected, }


className: EConcertSyncLockEventType

description: Types of lock events

code: enum EConcertSyncLockEventType { Locked = 0, Unlocked, }


className: EConcertSyncSessionFlags

code: enum EConcertSyncSessionFlags { None = 0, EnableLiveSync = 1<<0, EnableConnectionHistory = 1<<1, EnableLocking = 1<<2, EnableTransactions = 1<<3, EnablePackages = 1<<4, EnableSequencer = 1<<5, EnablePresence = 1<<6, EnableFileSharing = 1<<7, ShouldDiscardTransactionsOnPackageUnload = 1<<8, ShouldSendTransactionSnapshots = 1<<9, ShouldSendPackagePristineState = 1<<10, ShouldSendPackageAutoSaves = 1<<11, ShouldUsePackageSandbox = 1<<12, Default_MultiUserSession = EnableLiveSync | EnableConnectionHistory | EnableLocking | EnableTransactions | EnablePackages | EnableSequencer | EnablePresence | ShouldSendTransactionSnapshots | ShouldUsePackageSandbox, Default_DisasterRecoverySession = EnableTransactions | EnablePackages | EnableFileSharing | ShouldDiscardTransactionsOnPackageUnload | ShouldSendPackagePristineState | ShouldSendPackageAutoSaves, }


description: Type of transaction summaries

code: enum EConcertSyncTransactionActivitySummaryType { Added, Updated, Renamed, Deleted, }


className: EPresenceModeType

code: enum EPresenceModeType { Desktop, VRMode, }


className: ETransactionFilterResult

code: enum ETransactionFilterResult { IncludeObject, ExcludeObject, ExcludeTransaction, UseDefault, }


className: FConcertBaseSendPackageParams

code: struct FConcertBaseSendPackageParams

PackageInfo

type: constFConcertP...

description: General information about the package

RemoteEndpointId

type: FGuid

description: The remote endpoint that is interacting with this package.

TransmissionId

description: Identifies begin and finish send events so you can map them to each other.


className: FConcertBeginSendPackageDelegate

code: typedef TMulticastDelegate_OneParam< void, const [FConcertBeginSendPackageParams](API\Plugins\ConcertSyncCore\FConcertBeginSendPackageParams) & > FConcertBeginSendPackageDelegate


className: FConcertBeginSendPackageParams

PackageNumBytes

description: The size of the package data to be received


code: FConcertClientPresenceDataUpdateEvent()


className: FConcertClientPresenceDataUpdateEvent

Orientation

type: FQuat

Position

type: FVector

PresenceType

type: EPresenceModeTy...

WorldPath

type: FName

description: The non-PIE/SIE world path.


className: FConcertClientPresenceEventBase


className: FConcertClientPresenceInVREvent


code: FConcertClientVRPresenceUpdateEvent()


className: FConcertClientVRPresenceUpdateEvent

Lasers

type: FConcertLaserDa...


className: EUpdatePolicy

description: Defines how the store updates an existing value.

code: enum EUpdatePolicy { Overwrite, Replace, }


description:
Searches the store for the specified key, if not found, adds a new key/value pair, otherwise, if the stored value type matches the initial value type, fetches the stored value. The store always sets the value version to 1 when the value is added.
The operation result. The possible result codes are:

code: [FConcertDataStoreResult](API\Plugins\ConcertSyncCore\FConcertDataStoreResult) FetchOrAdd ( const [FName](API\Runtime\Core\UObject\FName) & Key, const [FName](API\Runtime\Core\UObject\FName) & TypeName, const [FConcertSessionSerializedPayload](API\Plugins\Concert\FConcertSessionSerializedPayload) & SerializedValue )


description: The example in the class documentation.

code: [FConcertDataStoreResult](API\Plugins\ConcertSyncCore\FConcertDataStoreResult) Fetch ( const [FName](API\Runtime\Core\UObject\FName) & Key, const [FName](API\Runtime\Core\UObject\FName) & TypeName ) const


description: Returns the number of key/value pairs currently stored.

code: int32 GetSize() const


description: Returns the version of the specified key if found.

code: [TOptional](API\Runtime\Core\IO\TOptional)< uint32 > GetVersion ( const [FName](API\Runtime\Core\UObject\FName) & Key ) const


description: The example in the class documentation.

code: [FConcertDataStoreResult](API\Plugins\ConcertSyncCore\FConcertDataStoreResult) Store ( const [FName](API\Runtime\Core\UObject\FName) & Key, const [FName](API\Runtime\Core\UObject\FName) & TypeName, const [FConcertSessionSerializedPayload](API\Plugins\Concert\FConcertSessionSerializedPayload) & SerializedValue, const [TOptional](API\Runtime\Core\IO\TOptional)< uint32 > & Version )


description: Visits all the key/value currently stored.

code: void Visit ( const [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(const [FName](API\Runtime\Core\UObject\FName) &, const [FConcertDataStore_StoreValue](API\Plugins\ConcertSyncCore\FConcertDataStore_StoreValue) &)> & Visitor ) const


description: Construct the store.

code: FConcertDataStore ( [EUpdatePolicy](API\Plugins\ConcertSyncCore\FConcertDataStore\EUpdatePolicy) InUpdatePolicy )


className: FConcertDataStore

description: How to read a value from the store.templateTOptionalMyClass::Fetch(constFName&Key){FConcertDataStoreResultResult=DataStore.Fetch(Key,TConcertDataStoreType::GetFName());if(Result.Code==EConcertDataStoreResultCode::Fetched){returnResult.Value->DeserializeUnchecked();}returnTOptional();}

code: class FConcertDataStore


description: Constructs a result containing theEConcertDataStoreResultCode::UnexpectedErrorcode and no value.

code: FConcertDataStoreResult()


description: Construct a result containing the specified error code and no value.

code: FConcertDataStoreResult ( [EConcertDataStoreResultCode](API\Plugins\ConcertSyncCore\EConcertDataStoreResultCode) InErrorCode )


description: Construct a result containing the specified code (added, fetched, exchanged) and its corresponding value.

code: FConcertDataStoreResult ( [EConcertDataStoreResultCode](API\Plugins\ConcertSyncCore\EConcertDataStoreResultCode) InCode, [FConcertDataStoreValueConstPtr](API\Plugins\ConcertSyncCore\FConcertDataStoreValueConstPtr) InValue )


className: FConcertDataStoreResult

description: Contains the result of a Concert data store operation. This class, as opposed toFConcertDataStore_Response, contains a shared pointer on the value to manage the lifetime of a value in the multi-versions client cache.

code: class FConcertDataStoreResult

Code

type: EConcertDataSto...

description: The operation result code.

Value

type: FConcertDataSto...

description: The value returned to the caller unless an error occurred.


className: FConcertDataStoreValueConstPtr

description: Thread safe shared pointer to a constFConcertDataStore_StoreValue.

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FConcertDataStore_StoreValue](API\Plugins\ConcertSyncCore\FConcertDataStore_StoreValue), ESPMode::ThreadSafe > FConcertDataStoreValueConstPtr


className: FConcertDataStoreValuePtr

description: Thread safe shared pointer to aFConcertDataStore_StoreValue.

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FConcertDataStore_StoreValue](API\Plugins\ConcertSyncCore\FConcertDataStore_StoreValue), ESPMode::ThreadSafe > FConcertDataStoreValuePtr


className: FConcertDataStoreValueConstRef

description: Thread safe shared reference to a constFConcertDataStore_StoreValue.

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FConcertDataStore_StoreValue](API\Plugins\ConcertSyncCore\FConcertDataStore_StoreValue), ESPMode::ThreadSafe > FConcertDataStoreValueConstRef


className: FConcertDataStoreValueRef

description: Thread safe shared reference to aFConcertDataStore_StoreValue.

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FConcertDataStore_StoreValue](API\Plugins\ConcertSyncCore\FConcertDataStore_StoreValue), ESPMode::ThreadSafe > FConcertDataStoreValueRef


description: IConcertClientDataStore::CompareExchange()methods.

Desired

type: FConcertSession...

description: The desired value to store.

Expected

description: The expected value if 'ExpectedVersion' is zero.

ExpectedVersion

description: The expected version of the value.


description: FConcertDataStore_StoreValue::DeserializeUnchecked().

code: operator double() const


code: operator float() const


description: IConcertClientDataStore::FetchOrAdd()methods.

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertDataStore_FetchOrAddRequest : public [FConcertDataStore_Request](API\Plugins\ConcertSyncCore\FConcertDataStore_Request)

SerializedValue

description: The property value to add if it doesn't already exist, in its serialized form.


description: A USTRUCT() wrapper struct, used by the implementation, to serialize/deserialize floating point values passed to the Concert data store API.

Value

type: double


code: operator bool() const


code: operator int16() const


code: operator int32() const


code: operator int64() const


code: operator int8() const


code: operator uint16() const


code: operator uint32() const


code: operator uint64() const


code: operator uint8() const


description: A USTRUCT() wrapper struct, used by the implementation, to serialize/deserialize integers (of any type) or bool values passed to the Concert data store API.

description: The stored value.


description: The event message sent by the server to the client to perform the initial replication, sending all currently stored key/value pairs to a new session client(s) or to notify any further changes, pushing an updated key/value pair to all clients except the one who performed the change.

Values

type: TArray<FConcer...

description: The initial values or the values that recently changed.


Key

description: The property name.

Value

description: The property value.


Key

description: The name of the value to add/fetch/compare exchange.

TypeName

description: The type name of the value USTRUCT to compare and exchange as returned byTConcertDataStoreType::GetFName().


description: The response to aFConcertDataStore_FetchOrAddRequestorFConcertDataStore_CompareExchangeRequestrequests, sent from the server to the client.

ResultCode

description: The result code to the request. Possible values depends on the request.

Value

description: Contains the stored value if the ResponseCode ==EConcertDataStoreResultCode::Fetched, otherwise, it is left empty.


description: DeserializeFConcertDataStore_StoreValue::SerializedValuefield into type T, without type checking.

code: template<typename T> T DeserializeUnchecked() const


description: A value and its meta-data as stored by a Concert data store and transported between a client and a server.

SerializedValue

description: Contains the value in its serialized and compact form.

TypeName

description: The data type name as returned byTConcertDataStoreType::GetFName().

Version

description: The value version number set by the server.


description: FConcertDataStore_StoreValue::DeserializeUnchecked().

code: operator FName() const


code: operator FString() const


description: A USTRUCT() wrapper struct, used by the implementation, to serialize/deserializeFNameandFStringpassed to the Concert data store API.

Value

type: FString


className: FConcertDataStore_Text::operator FText

code: operator FText() const


description: A USTRUCT() wrapper struct, used by the implementation, to serialize/deserializeFTextpassed to the Concert data store API.

type: FText


className: FConcertExportedObject

ObjectData

type: FConcertSeriali...

ObjectId

type: FConcertObjectI...

SerializedAnnotationData

type: TArray< uint8 >


description:
This function ignores the current cached file state, so will re-cache the file even if it has already been cached.
True if the file was cached, false otherwise.

code: bool CacheFile ( const [FString](API\Runtime\Core\Containers\FString) & InFilename )


description:
Find the given file, and get its data.
True if the file was found, false otherwise.

code: bool FindFile ( const [FString](API\Runtime\Core\Containers\FString) & InFilename, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutFileData ) const


description:
Find or cache the given file, and get its data.
True if the file was found or cached, false otherwise.

code: bool FindOrCacheFile ( const [FString](API\Runtime\Core\Containers\FString) & InFilename, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutFileData )


description:
Is the given file cached?
True if the file is cached, false otherwise.

code: bool HasCachedFile ( const [FString](API\Runtime\Core\Containers\FString) & InFilename ) const


code: [FConcertFileCache](API\Plugins\ConcertSyncCore\FConcertFileCache) & operator= ( const [FConcertFileCache](API\Plugins\ConcertSyncCore\FConcertFileCache) & )


description:
Save the given file and add it to the cache.
True if the file was cached, false otherwise.

code: bool SaveAndCacheFile ( const [FString](API\Runtime\Core\Containers\FString) & InFilename, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > && InFileData )


description: Uncache the given file.

code: void UncacheFile ( const [FString](API\Runtime\Core\Containers\FString) & InFilename )


description: Non-copyable.

code: FConcertFileCache ( const [FConcertFileCache](API\Plugins\ConcertSyncCore\FConcertFileCache) & )


code: FConcertFileCache ( const int32 InMinimumNumberOfFilesToCache, const uint64 InMaximumNumberOfBytesToCache )


className: FConcertFileCache

description: Will automatically re-cache files if they are changed on disk (via a timestamp change), and un-cache files that are deleted from disk.

code: class FConcertFileCache


className: FConcertFinishSendPackageDelegate

code: typedef TMulticastDelegate_OneParam< void, const [FConcertFinishSendPackageParams](API\Plugins\ConcertSyncCore\FConcertFinishSendPackageParams) & > FConcertFinishSendPackageDelegate


className: FConcertFinishSendPackageParams

MessageId

description: The ID of the message that causes the package to be acknowledged.


className: FConcertIgnoreActivityStateChangedEvent

description: This can be used to record and monitor session activities for inspection purpose, for example allowing disaster recovery to record what happens in a multi-user session without restoring such activities in case of crash (because they occurred in a transient sandbox).

bIgnore

type: bool


code: FConcertLaserData ( FVector Start, FVector End )


className: FConcertLaserData


description: Consumes a file corresponding to the unique file ID, if available. The file is deleted from the service storage when the shared pointer goes out of scope.

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FArchive](API\Runtime\Core\Serialization\FArchive) > CreateReader ( const [FString](API\Runtime\Core\Containers\FString) & InFileId )


description: Copies the specified file in the service storage and return a unique ID required to consume it back. The stored file expires in 1 hour.

code: virtual bool Publish ( const [FString](API\Runtime\Core\Containers\FString) & Pathname, [FString](API\Runtime\Core\Containers\FString) & OutFileId )


description: Copies the content of the archive in the service storage and return a unique ID required to consume it back. The stored file expires in 1 hour.

code: virtual bool Publish ( [FArchive](API\Runtime\Core\Serialization\FArchive) & SrcAr, int64 Size, [FString](API\Runtime\Core\Containers\FString) & OutFileId )


description: The service uses the Engine intermediate directory to share the files. The files are automatically deleted after consumption. In case of crash the temporary shared files are deleted on next reboot if no other client/server on the machine are not running.

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


className: FConcertLocalFileSharingService

description: This is mainly designed for the recovery system.

code: class FConcertLocalFileSharingService : public [IConcertFileSharingService](API\Plugins\ConcertSyncCore\IConcertFileSharingService)


code: FConcertObjectId ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * InObject )


code: FConcertObjectId ( const [FTransactionObjectId](API\Runtime\CoreUObject\Misc\FTransactionObjectId) & InObjectId, const uint32 InObjectFlags )


code: FConcertObjectId ( const [FName](API\Runtime\Core\UObject\FName) InObjectClassPathName, const [FName](API\Runtime\Core\UObject\FName) InObjectPackageName, const [FName](API\Runtime\Core\UObject\FName) InObjectName, const [FName](API\Runtime\Core\UObject\FName) InObjectOuterPathName, const [FName](API\Runtime\Core\UObject\FName) InObjectExternalPackageName, const uint32 InObjectFlags )


className: FConcertObjectId


description: Whether the package data can safely be embedded in 'PackageData' without overflow (ex 3GB overflows int32 type). Not necessarily reasonable, but safe.

code: static bool CanEmbedPackageDataAsByteArray ( uint64 PackageDataSize )


description: The maximum package data size that can be safely embedded in 'PackageData'. (Not necessarily reasonable, but safe).

code: static constexpr uint64 GetMaxPackageDataSizeEmbeddableAsByteArray()


description: Whether some package data is embedded or linked.

code: bool HasPackageData() const


description: Whether the package data should be embedded in 'PackageData'. Larger packages could still be embedded as byte array if file sharing is not enabled.

code: static bool ShouldEmbedPackageDataAsByteArray ( uint64 PackageDataSize )


className: FConcertPackage

FileId

description: A link to a file containing the data if the package size was too large to be directly embedded.

Info

type: FConcertPackage...

description: Contains information about the package event such as the package name, the event type, if this was triggered by an auto-save, etc.

PackageData

type: FConcertByteArr...

description: Contains the package data, unless the package size was too large (according to the hard limit or a configuration).


className: FConcertPackageDataStream

description: Used to stream the package data.

code: struct FConcertPackageDataStream

DataAr

type: FArchive*

description: The package data, positioned to read the first byte of package data, not necessarily at zero, some unrelated data can be store before.

DataBlob

type: constTArray< u...

description: An array of bytes containing the package data if the data was already available in memory, null otherwise.

DataSize

description: The size of the package data.


className: FConcertPackageInfo

AssetClass

description: The class of the asset contained in this package.

bAutoSave

description: Was this update caused by an auto-save?

bPreSave

description: Was this update caused by a pre-save?

NewPackageName

type: FName

description: The new name of the package (if PackageUpdateType ==EConcertPackageUpdateType::Renamed)

PackageFileExtension

description: The extension of the package file on disk (eg, .umap or .uasset)

PackageName

description: The name of the package

PackageUpdateType

type: EConcertPackage...

description: What kind of package update is this?

TransactionEventIdAtSave

description: What was the max transaction event ID when this update was made? (to discard older transactions that applied to this package)


className: FConcertPackageRejectedEvent


className: FConcertPackageTransmissionStartEvent

description: Sent to let the receiver know something is coming. For now only sent from client to server.

TransmissionId

type: FGuid


className: FConcertPackageUpdateEvent

Package

type: FConcertPackage


className: FConcertPlaySessionEvent

EventType

type: EConcertPlaySes...


className: FConcertRejectSendPackageDelegate

code: typedef TMulticastDelegate_OneParam< void, const [FConcertRejectSendPackageParams](API\Plugins\ConcertSyncCore\FConcertRejectSendPackageParams) & > FConcertRejectSendPackageDelegate


className: FConcertRejectSendPackageParams


className: FConcertResourceLockEvent

LockType

type: EConcertResourc...

ResourceNames

type: TArray<FName>


className: FConcertResourceLockRequest


className: FConcertResourceLockResponse

FailedResources

type: TMap<FName,FG...


className: FConcertSequencerCloseEvent

description: Event that signals a Sequencer just been closed.

SequenceObjectPath

type: FString

description: The full path name to the root sequence of the sequencer that just closed.


className: FConcertSequencerOpenEvent

description: Event that signals a Sequencer just been opened.

description: The full path name to the root sequence of the sequencer that just opened.

TakeData

description: In the case that the SequenceObjectPath points to a take preset, we capture the preset data into a payload that can be applied to take that we are going to open.


className: FConcertSequencerPreloadAssetStatusMap

description: Can be sent as an event by clients to indicate loading success/failure result of attempting to preload one or more sequence assets.

Sequences

type: TMap<FTopLevel...


description: Clear all clients' references to a specified asset.

code: void Remove ( const [FTopLevelAssetPath](API\Runtime\CoreUObject\UObject\FTopLevelAssetPath) & Sequence )


description: Merge (add or replace) statuses for a specified client into this object.

code: void UpdateFrom ( const [FGuid](API\Runtime\Core\Misc\FGuid) & Client, const [FConcertSequencerPreloadAssetStatusMap](API\Plugins\ConcertSyncCore\FConcertSequencerPreloadAssetSta-) & Updates )


className: FConcertSequencerPreloadClientStatusMap

description: Sent as an event by server with preload status of one or more clients.

ClientEndpoints

type: TMap<FGuid,FC...


className: FConcertSequencerPreloadRequest

description: Can also be received from the server in response to changes to the active set, or as an initial snapshot of the complete set when joining a session.

bShouldBePreloaded

description: True if being added to the preload set, false if being removed.

SequenceObjectPaths

type: TArray<FTopLev...

description: The list of full paths to affected sequences.


className: FConcertSequencerState

bLoopMode

type: bool

description: Indicate if we are currently looping

PlaybackRange

type: FFrameNumberRan...

PlaybackSpeed

type: float

description: The current playback speed

PlayerStatus

type: EConcertMovieSc...

description: The current status of the sequencer player

SequenceObjectPath

description: The full path name to the root sequence that is open on the sequencer

Time

type: FQualifiedFrame...

description: The time that the sequence is at


className: FConcertSequencerStateEvent

description: Event that signals a sequencer UI has changed the current state

State

type: FConcertSequenc...

description: The new state that the sequence is at


className: FConcertSequencerStateSyncEvent

description: Event that represent the current open sequencer states to a newly connected client

SequencerStates

type: TArray<FConcer...


className: FConcertSequencerTimeAdjustmentEvent

description: An event that represents a time changes on the sequencer. This can happen via take recorder which will shift the active takeifStart At Timecode is enabled.

PlaybackStartFrame

type: FFrameNumber


className: FConcertSerializedObjectData

NewExternalPackageName

type: FName

SerializedData

type: TArray< uint8 >


className: FConcertSerializedPropertyData


className: FConcertServerLogging


code: FConcertSessionActivity()


code: FConcertSessionActivity ( [FConcertSyncActivity](API\Plugins\ConcertSyncCore\FConcertSyncActivity) && InActivity, [FStructOnScope](API\Runtime\CoreUObject\UObject\FStructOnScope) && InActivitySummary, [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FConcertSessionSerializedPayload](API\Plugins\Concert\FConcertSessionSerializedPayload) > OptionalEventPayload )


code: FConcertSessionActivity ( const [FConcertSyncActivity](API\Plugins\ConcertSyncCore\FConcertSyncActivity) & InActivity, const [FStructOnScope](API\Runtime\CoreUObject\UObject\FStructOnScope) & InActivitySummary, [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FConcertSessionSerializedPayload](API\Plugins\Concert\FConcertSessionSerializedPayload) > OptionalEventPayload )


className: FConcertSessionActivity

code: struct FConcertSessionActivity

Activity

type: FConcertSyncAct...

description: The generic activity part.

ActivitySummary

type: TStructOnScope<...

description: Contains the activity summary to display as text.

EventPayload

type: TUniquePtr<FCo...

description: The activity event payload usable for activity inspection.


className: FConcertSyncActivity

description: Data for an activity entry in a Concert Sync Session

ActivityId

description: The ID of the activity

bIgnored

description: True if this activity is included for tracking purposes only, and can be ignored when migrating a database

EndpointId

type: FGuid

description: The ID of the endpoint that produced the activity

EventId

description: The ID of the event associated with this activity (

EventSummary

type: FConcertSession...

description: The minimal summary of the event associated with this activity (

EventTime

type: FDateTime

description: The time at which the activity was produced (UTC)

EventType

type: EConcertSyncAct...

description: The type of this activity

Flags

description: Additional information about this activity


code: virtual [FText](API\Runtime\Core\Internationalization\FText) CreateDisplayText ( const bool InUseRichText ) const


code: virtual [FText](API\Runtime\Core\Internationalization\FText) CreateDisplayTextForUser ( const [FText](API\Runtime\Core\Internationalization\FText) InUserDisplayName, const bool InUseRichText ) const


description: Get the display text of the activity summary.

code: [FText](API\Runtime\Core\Internationalization\FText) ToDisplayText ( const [FText](API\Runtime\Core\Internationalization\FText) InUserDisplayName, const bool InUseRichText ) const


className: FConcertSyncActivitySummary

description: Base summary for an activity entry in a Concert Sync Session


code: virtual ~FConcertSyncActivitySummary()


code: FConcertSyncConnectionActivity()


className: FConcertSyncConnectionActivity

description: Data for a connection activity entry in a Concert Sync Session

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertSyncConnectionActivity : public [FConcertSyncActivity](API\Plugins\ConcertSyncCore\FConcertSyncActivity)

EventData

type: FConcertSyncCon...

description: The connection event data associated with this activity


description: Create this summary from an connection event

code: static [FConcertSyncConnectionActivitySummary](API\Plugins\ConcertSyncCore\FConcertSyncConnectionActivitySu-) CreateSummaryForEvent ( const [FConcertSyncConnectionEvent](API\Plugins\ConcertSyncCore\FConcertSyncConnectionEvent) & InEvent )


className: FConcertSyncConnectionActivitySummary

description: Summary for a connection activity entry in a Concert Sync Session

ConnectionEventType

type: EConcertSyncCon...

description: The type of connection event we summarize


className: FConcertSyncConnectionEvent

description: Data for a connection event in a Concert Sync Session

description: The type of this connection event


className: FConcertSyncEncounteredMissingObject

code: typedef TBaseDelegate_OneParam< void, const FStringView > FConcertSyncEncounteredMissingObject


className: FConcertSyncEndpointData

description: Data for an endpoint in a Concert Sync Session

ClientInfo

type: FConcertClientI...

description: The information about the Concert client connected through this endpoint


className: FConcertSyncEndpointIdAndData

description: ID and data pair for an endpoint in a Concert Sync Session

EndpointData

type: FConcertSyncEnd...

description: The data for the endpoint

EndpointId

description: The ID of the endpoint


className: FConcertSyncEventRequest

description: Request to sync an event that was partially synced on the client but for which the full data is required for inspection.FConcertSyncEventResponseis the corresponding response.

EventId

description: The ID of the event to sync.

EventType

description: The type of event to sync. Only Package and Transaction event types are supported.


className: FConcertSyncEventResponse

description: Response to aFConcertSyncEventRequestrequest.

Event

description: The payload contains the event corresponding to the requested event type like FConcertSyncTransactionEvent/FConcertSyncPackageEvent or an empty payload if the request failed.


code: FConcertSyncLockActivity()


className: FConcertSyncLockActivity

description: Data for a lock activity entry in a Concert Sync Session

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertSyncLockActivity : public [FConcertSyncActivity](API\Plugins\ConcertSyncCore\FConcertSyncActivity)

EventData

type: FConcertSyncLoc...

description: The lock event data associated with this activity


description: Create this summary from a lock event

code: static [FConcertSyncLockActivitySummary](API\Plugins\ConcertSyncCore\FConcertSyncLockActivitySummary) CreateSummaryForEvent ( const [FConcertSyncLockEvent](API\Plugins\ConcertSyncCore\FConcertSyncLockEvent) & InEvent )


className: FConcertSyncLockActivitySummary

description: Summary for a lock activity entry in a Concert Sync Session

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertSyncLockActivitySummary : public [FConcertSyncActivitySummary](API\Plugins\ConcertSyncCore\FConcertSyncActivitySummary)

LockEventType

type: EConcertSyncLoc...

description: The type of lock event we summarize

NumResources

description: The total number of resources affected by the lock event we summarize

PrimaryPackageName

description: The primary package affected by the lock event we summarize

PrimaryResourceName

description: The primary resource affected by the lock event we summarize


className: FConcertSyncLockEvent

description: Data for a lock event in a Concert Sync Session

LockEventType

description: The type of this lock event

ResourceNames

type: TArray<FName>

description: The resources affected by this lock event


className: FConcertSyncObjectPathBelongsToWorld

code: typedef TBaseDelegate_OneParam< bool, const FStringView > FConcertSyncObjectPathBelongsToWorld


description: This is overridden for the specific Archive Types

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


code: virtual void OnObjectSerialized ( const [FSoftObjectPath](API\Runtime\CoreUObject\UObject\FSoftObjectPath) & Obj )


description:
This operator can be implemented by sub-classes that wish to serializeUObjectinstances.
This instance.

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [UObject](API\Runtime\CoreUObject\UObject\UObject) *& Value )


description:
Most of the time, FLazyObjectPtrs are serialized as UObject*, but some archives need to override this.
This instance.

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [FLazyObjectPtr](API\Runtime\CoreUObject\UObject\FLazyObjectPtr) & Value )


description:
Most of the time, FObjectPtrs are serialized as UObject*, but some archives need to override this.
This instance.

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [FObjectPtr](API\Runtime\CoreUObject\UObject\FObjectPtr) & Value )


description:
Most of the time,FSoftObjectPtrare serialized asUObject*, but some archives need to override this.
This instance.

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [FSoftObjectPtr](API\Runtime\CoreUObject\UObject\FSoftObjectPtr) & Value )


description:
Serializes soft object paths from or into this archive.
This instance.

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [FSoftObjectPath](API\Runtime\CoreUObject\UObject\FSoftObjectPath) & Value )


description:
This operator can be implemented by sub-classes that wish to serializeFWeakObjectPtrinstances.
This instance.

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [FWeakObjectPtr](API\Runtime\CoreUObject\UObject\FWeakObjectPtr) & Value )


code: void SerializeObject ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InObject )


code: void SetSerializeNestedObjects ( bool bInSerializeNestedObjects )


code: void SerializeProperty ( const [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProp, [UObject](API\Runtime\CoreUObject\UObject\UObject) * InObject )


code: FConcertSyncObjectReader ( const [FConcertLocalIdentifierTable](API\Plugins\ConcertTransport\IdentifierTable\FConcertLocalIdentifierTable) * InLocalIdentifierTable, [FConcertSyncWorldRemapper](API\Plugins\ConcertSyncCore\FConcertSyncWorldRemapper) InWorldRemapper, const [FConcertSessionVersionInfo](API\Plugins\Concert\FConcertSessionVersionInfo) * InVersionInfo, [UObject](API\Runtime\CoreUObject\UObject\UObject) * InObj, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InBytes )


code: FConcertSyncObjectReader ( const [FConcertLocalIdentifierTable](API\Plugins\ConcertTransport\IdentifierTable\FConcertLocalIdentifierTable) * InLocalIdentifierTable, [FConcertSyncWorldRemapper](API\Plugins\ConcertSyncCore\FConcertSyncWorldRemapper) InWorldRemapper, const [FConcertSessionVersionInfo](API\Plugins\Concert\FConcertSessionVersionInfo) * InVersionInfo, [UObject](API\Runtime\CoreUObject\UObject\UObject) * InObj, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InBytes, const [FConcertSyncEncounteredMissingObject](API\Plugins\ConcertSyncCore\FConcertSyncEncounteredMissingOb-) & InEncounteredMissingObjectDelegate )


className: FConcertSyncObjectReader

description: Archive for reading objects that have been received from another instance via Concert

code: class FConcertSyncObjectReader : public [FConcertIdentifierReader](API\Plugins\ConcertTransport\IdentifierTable\FConcertIdentifierReader)


code: virtual void OnObjectSerialized ( [FSoftObjectPath](API\Runtime\CoreUObject\UObject\FSoftObjectPath) & Obj )


code: void RewriteObject ( const [UClass](API\Runtime\CoreUObject\UObject\UClass) * InClass )


code: void RewriteProperty ( const [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProp )


code: FConcertSyncObjectRewriter ( const [FConcertLocalIdentifierTable](API\Plugins\ConcertTransport\IdentifierTable\FConcertLocalIdentifierTable) * InLocalIdentifierTable, [FConcertLocalIdentifierTable](API\Plugins\ConcertTransport\IdentifierTable\FConcertLocalIdentifierTable) * InRewriteIdentifierTable, const [FConcertSessionVersionInfo](API\Plugins\Concert\FConcertSessionVersionInfo) * InVersionInfo, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InBytes )


className: FShouldSkipPropertyFunc

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool(const [FProperty](API\Runtime\CoreUObject\UObject\FProperty) *)> FShouldSkipPropertyFunc


className: FConcertSyncObjectRewriter

description: Archive for rewriting identifiers (currently names) so that they belong to a different identifier table

code: class FConcertSyncObjectRewriter : public [FConcertIdentifierRewriter](API\Plugins\ConcertTransport\IdentifierTable\FConcertIdentifierRewriter)


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


code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [UObject](API\Runtime\CoreUObject\UObject\UObject) *& Value )


code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [FLazyObjectPtr](API\Runtime\CoreUObject\UObject\FLazyObjectPtr) & Value )


code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [FObjectPtr](API\Runtime\CoreUObject\UObject\FObjectPtr) & Value )


code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [FSoftObjectPtr](API\Runtime\CoreUObject\UObject\FSoftObjectPtr) & Value )


code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [FSoftObjectPath](API\Runtime\CoreUObject\UObject\FSoftObjectPath) & Value )


code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [FWeakObjectPtr](API\Runtime\CoreUObject\UObject\FWeakObjectPtr) & Value )


code: void SerializeObject ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * InObject, const [TArray](API\Runtime\Core\Containers\TArray)< const [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * > * InPropertiesToWrite, bool bAllowOuters )


code: void SerializeProperty ( const [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProp, const [UObject](API\Runtime\CoreUObject\UObject\UObject) * InObject )


description: Checks whether the archive wants to skip the property independent of the other flags

code: virtual bool ShouldSkipProperty ( const [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty ) const


code: void SetSerializeNestedObjects ( bool bInSerializeNestedObjects )


code: FConcertSyncObjectWriter ( [FConcertLocalIdentifierTable](API\Plugins\ConcertTransport\IdentifierTable\FConcertLocalIdentifierTable) * InLocalIdentifierTable, [UObject](API\Runtime\CoreUObject\UObject\UObject) * InObj, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutBytes, const bool InIncludeEditorOnlyData, const bool InSkipAssets )


code: FConcertSyncObjectWriter ( [FConcertLocalIdentifierTable](API\Plugins\ConcertTransport\IdentifierTable\FConcertLocalIdentifierTable) * InLocalIdentifierTable, [UObject](API\Runtime\CoreUObject\UObject\UObject) * InObj, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutBytes, const bool InIncludeEditorOnlyData, const bool InSkipAssets, const [FConcertSyncRemapObjectPath](API\Plugins\ConcertSyncCore\FConcertSyncRemapObjectPath) & InRemapDelegate )


className: FConcertSyncObjectWriter

description: Archive for writing objects in a way that they can be sent to another instance via Concert

code: class FConcertSyncObjectWriter : public [FConcertIdentifierWriter](API\Plugins\ConcertTransport\IdentifierTable\FConcertIdentifierWriter)


code: FConcertSyncPackageActivity()


className: FConcertSyncPackageActivity

description: Data for a package activity entry in a Concert Sync Session

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertSyncPackageActivity : public [FConcertSyncActivity](API\Plugins\ConcertSyncCore\FConcertSyncActivity)

EventData

type: FConcertSyncPac...

description: The package event data associated with this activity


code: virtual [FText](API\Runtime\Core\Internationalization\FText) CreateDisplayTextForUser ( const [FText](API\Runtime\Core\Internationalization\FText) InUserDisplayName, const bool InUseRichText ) const


code: virtual [FText](API\Runtime\Core\Internationalization\FText) CreateDisplayText ( const bool InUseRichText ) const


description: Create this summary from a package event

code: static [FConcertSyncPackageActivitySummary](API\Plugins\ConcertSyncCore\FConcertSyncPackageActivitySumma-) CreateSummaryForEvent ( const [FConcertPackageInfo](API\Plugins\ConcertSyncCore\FConcertPackageInfo) & InEvent )


className: FConcertSyncPackageActivitySummary

description: Summary for a package activity entry in a Concert Sync Session

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FConcertSyncPackageActivitySummary : public [FConcertSyncActivitySummary](API\Plugins\ConcertSyncCore\FConcertSyncActivitySummary)

bAutoSave

type: bool

description: Are we summarizing an auto-save update?

bPreSave

description: Are we summarizing a pre-save update?

NewPackageName

type: FName

description: The new package name for the event we summarize (if PackageUpdateType ==EConcertPackageUpdateType::Renamed)

PackageName

description: The package affected by the package event we summarize

PackageUpdateType

type: EConcertPackage...

description: The type of package update we summarize


className: FConcertSyncPackageEvent

description: Data for a package event in a Concert Sync Session

Package

type: FConcertPackage

description: The package data for this event

PackageRevision

description: The revision of this package within the session?


className: FConcertSyncPackageEventData

description: Contains a package event where the package data is represented by a stream because it can be very large (several GB)

code: struct FConcertSyncPackageEventData

MetaData

description: The package event meta data.

PackageDataStream

type: FConcertPackage...

description: The package data.


className: FConcertSyncRemapObjectPath

code: typedef TBaseDelegate_OneParam< void, [FString](API\Runtime\Core\Containers\FString) & > FConcertSyncRemapObjectPath


className: FConcertSyncPackageEventMetaData

description: Meta data for a package event in a Concert Sync Session.

PackageInfo

description: Contains information about the package event such as the package name, the event type, if this was triggered by an auto-save, etc.

PackageRevision

description: The revision of this package within the session.


description: GetConnectionEvent).

code: bool AddConnectionActivity ( const [FConcertSyncConnectionActivity](API\Plugins\ConcertSyncCore\FConcertSyncConnectionActivity) & InConnectionActivity, int64 & OutActivityId, int64 & OutConnectionEventId )


description:
These are use to fence live transactions without generating a full activity entry (eg, when saving packages locally on the client during a persist operation).
True if the package event was added, false otherwise.

code: bool AddDummyPackageEvent ( const [FName](API\Runtime\Core\UObject\FName) InPackageName, int64 & OutPackageEventId )


description: GetPackageEvent).

code: bool AddPackageActivity ( const [FConcertSyncActivity](API\Plugins\ConcertSyncCore\FConcertSyncActivity) & InPackageActivity, const [FConcertPackageInfo](API\Plugins\ConcertSyncCore\FConcertPackageInfo) & InPackageInfo, [FConcertPackageDataStream](API\Plugins\ConcertSyncCore\FConcertPackageDataStream) & InPackageDataStream, int64 & OutActivityId, int64 & OutPackageEventId )


description:
Add a package event ID for the head revision to the persist events in this database, if not already existing.
True if the persist event was added, false otherwise.

code: bool AddPersistEventForHeadRevision ( [FName](API\Runtime\Core\UObject\FName) InPackageName, int64 & OutPersistEventId )


description: GetTransactionEvent).

code: bool AddTransactionActivity ( const [FConcertSyncTransactionActivity](API\Plugins\ConcertSyncCore\FConcertSyncTransactionActivity) & InTransactionActivity, int64 & OutActivityId, int64 & OutTransactionEventId )


description: Close an open database file.

code: bool Close ( const bool InDeleteDatabase )


description:
Enumerate all the activities in this database of the given type.
True if the activities were enumerated without error, false otherwise.

code: bool EnumerateActivitiesForEventType ( const [EConcertSyncActivityEventType](API\Plugins\ConcertSyncCore\EConcertSyncActivityEventType) InEventType, [FIterateActivityFunc](API\Plugins\ConcertSyncCore\FIterateActivityFunc) InCallback ) const


description:
Enumerate all the activities in this database in the given range.
True if the activities were enumerated without error, false otherwise.

code: bool EnumerateActivitiesInRange ( const int64 InFirstActivityId, const int64 InMaxNumActivities, [FIterateActivityFunc](API\Plugins\ConcertSyncCore\FIterateActivityFunc) InCallback ) const


description:
Enumerate the IDs and event types of all the activities in this database.
True if the activities were enumerated without error, false otherwise.

code: bool EnumerateActivityIdsAndEventTypes ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool(int64, [EConcertSyncActivityEventType](API\Plugins\ConcertSyncCore\EConcertSyncActivityEventType))> InCallback ) const


description: GetLockEvent).

code: bool AddLockActivity ( const [FConcertSyncLockActivity](API\Plugins\ConcertSyncCore\FConcertSyncLockActivity) & InLockActivity, int64 & OutActivityId, int64 & OutLockEventId )


description:
Enumerate the IDs and event types of the activities in this database in the given range.
True if the activities were enumerated without error, false otherwise.

code: bool EnumerateActivityIdsAndEventTypesInRange ( const int64 InFirstActivityId, const int64 InMaxNumActivities, [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool(int64, [EConcertSyncActivityEventType](API\Plugins\ConcertSyncCore\EConcertSyncActivityEventType))> InCallback ) const


description:
Enumerate the IDs, event types and flags of the activities in this database in the given range.
True if the activities were enumerated without error, false otherwise.

code: bool EnumerateActivityIdsWithEventTypesAndFlagsInRange ( const int64 InFirstActivityId, const int64 InMaxNumActivities, [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool(int64, [EConcertSyncActivityEventType](API\Plugins\ConcertSyncCore\EConcertSyncActivityEventType), [EConcertSyncActivityFlags](API\Plugins\ConcertSyncCore\EConcertSyncActivityFlags))> InCallback ) const


description:
Enumerate the generic part of the activities in this database.
True if the activities were enumerated without error, false otherwise.

code: bool EnumerateActivities ( [FIterateActivityFunc](API\Plugins\ConcertSyncCore\FIterateActivityFunc) InCallback ) const


description:
Enumerate all the connection activities in this database.
True if the connection activities were enumerated without error, false otherwise.

code: bool EnumerateConnectionActivities ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool([FConcertSyncConnectionActivity](API\Plugins\ConcertSyncCore\FConcertSyncConnectionActivity) &&)> InCallback ) const


description:
Enumerate all the endpoint IDs in this database.
True if the endpoint IDs were enumerated without error, false otherwise.

code: bool EnumerateEndpointIds ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool([FGuid](API\Runtime\Core\Misc\FGuid))> InCallback ) const


description:
Enumerate all the endpoints in this database.
True if the endpoints were enumerated without error, false otherwise.

code: bool EnumerateEndpoints ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool([FConcertSyncEndpointIdAndData](API\Plugins\ConcertSyncCore\FConcertSyncEndpointIdAndData) &&)> InCallback ) const


description:
Enumerate the IDs of any live transaction events for the given package name.
True if the live transaction event IDs were enumerated without error, false otherwise.

code: bool EnumerateLiveTransactionEventIdsForPackage ( const [FName](API\Runtime\Core\UObject\FName) InPackageName, [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool(int64)> InCallback ) const


description:
Enumerate the head revision package data for all packages in this database.
True if the package data was enumerated without error, false otherwise.

code: bool EnumerateHeadRevisionPackageData ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool(const [FConcertPackageInfo](API\Plugins\ConcertSyncCore\FConcertPackageInfo) &, [FConcertPackageDataStream](API\Plugins\ConcertSyncCore\FConcertPackageDataStream) &)> InCallback ) const


description:
Enumerate the IDs of any live transaction events for the given package name ID.
True if the live transaction event IDs were enumerated without error, false otherwise.

code: bool EnumerateLiveTransactionEventIdsForPackage &40; const int64 InPackageNameId, TFunctionRef< bool(int64)> InCallback &41; const


description:
Enumerate all the package activities in this database.
True if the package activities were enumerated without error, false otherwise.

code: bool EnumeratePackageActivities ( [FIteratePackageActivityFunc](API\Plugins\ConcertSyncCore\FIteratePackageActivityFunc) InCallback ) const


description:
Enumerate all the lock activities in this database.
True if the lock activities were enumerated without error, false otherwise.

code: bool EnumerateLockActivities ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool([FConcertSyncLockActivity](API\Plugins\ConcertSyncCore\FConcertSyncLockActivity) &&)> InCallback ) const


description:
Enumerate the names of of any packages that have live transaction events.
True if the package names were enumerated without error, false otherwise.

code: bool EnumeratePackageNamesWithLiveTransactions ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool([FName](API\Runtime\Core\UObject\FName))> InCallback ) const


description:
Enumerate package names for packages with a head revision (at least one package event)
True if the package data was enumerated without error, false otherwise.

code: bool EnumeratePackageNamesWithHeadRevision ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool([FName](API\Runtime\Core\UObject\FName))> InCallback, bool IgnorePersisted ) const


description:
Enumerate all the transaction activities in this database.
True if the transaction activities were enumerated without error, false otherwise.

code: bool EnumerateTransactionActivities ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool([FConcertSyncTransactionActivity](API\Plugins\ConcertSyncCore\FConcertSyncTransactionActivity) &&)> InCallback ) const


description: Flush any ongoing asynchronous tasks.

code: void FlushAsynchronousTasks()


className: FProcessPackageRequest

code: typedef [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool(const [FConcertPackageInfo](API\Plugins\ConcertSyncCore\FConcertPackageInfo) &PackageInfo, const [FString](API\Runtime\Core\Containers\FString) &DataFilename)> FProcessPackageRequest


description:
Get the generic part of an activity from this database.
True if the activity was found, false otherwise.

code: bool GetActivity ( const int64 InActivityId, [FConcertSyncActivity](API\Plugins\ConcertSyncCore\FConcertSyncActivity) & OutActivity ) const


description:
Get the type of an activity in this database.
True if the activity was found, false otherwise.

code: bool GetActivityEventType ( const int64 InActivityId, [EConcertSyncActivityEventType](API\Plugins\ConcertSyncCore\EConcertSyncActivityEventType) & OutEventType ) const


description:
Get the generic part of an activity for an event in this database.
True if the activity was found, false otherwise.

code: bool GetActivityForEvent ( const int64 InEventId, const [EConcertSyncActivityEventType](API\Plugins\ConcertSyncCore\EConcertSyncActivityEventType) InEventType, [FConcertSyncActivity](API\Plugins\ConcertSyncCore\FConcertSyncActivity) & OutActivity ) const


description:
Get the maximum ID of the activities in this database.
True if the activity ID was resolved, false otherwise.

code: bool GetActivityMaxId ( int64 & OutActivityId ) const


description:
Get a connection activity for an event in this database.
True if the connection activity was found, false otherwise.

code: bool GetConnectionActivityForEvent ( const int64 InConnectionEventId, [FConcertSyncConnectionActivity](API\Plugins\ConcertSyncCore\FConcertSyncConnectionActivity) & OutConnectionActivity ) const


description:
Get a connection activity from this database.
True if the connection activity was found, false otherwise.

code: bool GetConnectionActivity ( const int64 InActivityId, [FConcertSyncConnectionActivity](API\Plugins\ConcertSyncCore\FConcertSyncConnectionActivity) & OutConnectionActivity ) const


description:
Get a connection event from this database.
True if the connection event was found, false otherwise.

code: bool GetConnectionEvent ( const int64 InConnectionEventId, [FConcertSyncConnectionEvent](API\Plugins\ConcertSyncCore\FConcertSyncConnectionEvent) & OutConnectionEvent ) const


description:
Get an endpoint from this database.
True if the endpoint was found, false otherwise.

code: bool GetEndpoint ( const [FGuid](API\Runtime\Core\Misc\FGuid) & InEndpointId, [FConcertSyncEndpointData](API\Plugins\ConcertSyncCore\FConcertSyncEndpointData) & OutEndpointData ) const


description: The returned filename will be an absolute pathname.


description: Get the last error reported by this database.


description:
Get the IDs of any live transaction events.
True if the live transaction event IDs were resolved, false otherwise.

code: bool GetLiveTransactionEventIds ( [TArray](API\Runtime\Core\Containers\TArray)< int64 > & OutTransactionEventIds ) const


description:
Get a lock activity from this database.
True if the lock activity was found, false otherwise.

code: bool GetLockActivity ( const int64 InActivityId, [FConcertSyncLockActivity](API\Plugins\ConcertSyncCore\FConcertSyncLockActivity) & OutLockActivity ) const


description:
Get the IDs of any live transaction events for the given package name.
True if the live transaction event IDs were resolved, false otherwise.

code: bool GetLiveTransactionEventIdsForPackage ( const [FName](API\Runtime\Core\UObject\FName) InPackageName, [TArray](API\Runtime\Core\Containers\TArray)< int64 > & OutTransactionEventIds ) const


description:
Get a lock activity for an event in this database.
True if the lock activity was found, false otherwise.

code: bool GetLockActivityForEvent ( const int64 InLockEventId, [FConcertSyncLockActivity](API\Plugins\ConcertSyncCore\FConcertSyncLockActivity) & OutLockActivity ) const


description:
Get a lock event from this database.
True if the lock event was found, false otherwise.

code: bool GetLockEvent ( const int64 InLockEventId, [FConcertSyncLockEvent](API\Plugins\ConcertSyncCore\FConcertSyncLockEvent) & OutLockEvent ) const


description:
The package data stream passed to the callback through the FConcertSycnPackageEventData is only valid during the callback.
True if the package activity was found, false otherwise.

code: bool GetPackageActivityForEvent ( const int64 InPackageEventId, [FIteratePackageActivityFunc](API\Plugins\ConcertSyncCore\FIteratePackageActivityFunc) PackageActivityFn ) const


code: bool GetPackageActivity ( const int64 InActivityId, [FConsumePackageActivityFunc](API\Plugins\ConcertSyncCore\FConsumePackageActivityFunc) PackageActivityFn ) const


description:
Get the data from this database for the given package name for the given revision.
True if package data could be found for the given revision, false otherwise.

code: bool GetPackageDataForRevision ( const [FName](API\Runtime\Core\UObject\FName) InPackageName, const [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(const [FConcertPackageInfo](API\Plugins\ConcertSyncCore\FConcertPackageInfo) &, [FConcertPackageDataStream](API\Plugins\ConcertSyncCore\FConcertPackageDataStream) &)> & InCallback, const int64 * InPackageRevision ) const


description:
Get a package event from this database.
True if the package event was found, false otherwise.

code: bool GetPackageEvent ( const int64 InPackageEventId, const [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void([FConcertSyncPackageEventData](API\Plugins\ConcertSyncCore\FConcertSyncPackageEventData) &)> & PackageEventFn ) const


description:
Get a package event meta data (omitting the package data itself) from this database.
True if the package event was found, false otherwise.

code: bool GetPackageEventMetaData ( const int64 InPackageEventId, int64 & OuptPackageRevision, [FConcertPackageInfo](API\Plugins\ConcertSyncCore\FConcertPackageInfo) & OutPackageInfo ) const


description:
Get Package Event Id from Package Name. The event id will be from the head revision of the package.
True if the package event was found, false otherwise

code: bool GetPackageHeadEventFromName ( const [FName](API\Runtime\Core\UObject\FName) InPackageName, int64 & OutPackageEventId )


code: bool GetPackageInfoForRevision ( const [FName](API\Runtime\Core\UObject\FName) InPackageName, [FConcertPackageInfo](API\Plugins\ConcertSyncCore\FConcertPackageInfo) & OutPackageInfo, const int64 * InPackageRevision ) const


description:
Get the head revision in this database for the given package name.
True if the head revision was resolved, false otherwise.

code: bool GetPackageHeadRevision ( const [FName](API\Runtime\Core\UObject\FName) InPackageName, int64 & OutRevision ) const


description:
Get a transaction activity for an event in this database.
True if the transaction activity was found, false otherwise.

code: bool GetTransactionActivityForEvent ( const int64 InTransactionEventId, [FConcertSyncTransactionActivity](API\Plugins\ConcertSyncCore\FConcertSyncTransactionActivity) & OutTransactionActivity ) const


description:
Get a transaction activity from this database.
True if the transaction activity was found, false otherwise.

code: bool GetTransactionActivity ( const int64 InActivityId, [FConcertSyncTransactionActivity](API\Plugins\ConcertSyncCore\FConcertSyncTransactionActivity) & OutTransactionActivity ) const


description:
Get a transaction event from this database.
True if the transaction event was found, false otherwise.

code: bool GetTransactionEvent ( const int64 InTransactionEventId, [FConcertSyncTransactionEvent](API\Plugins\ConcertSyncCore\FConcertSyncTransactionEvent) & OutTransactionEvent, const bool InMetaDataOnly ) const


description:
Get the maximum ID of the transaction events in this database.
True if the transaction event ID was resolved, false otherwise.

code: bool GetTransactionMaxEventId ( int64 & OutTransactionEventId ) const


description: Has all asynchronous package tasks completed.


description:
Gets the package size in bytes of a package
True if package data could be found for the given revision, false otherwise.

code: [TOptional](API\Runtime\Core\IO\TOptional)< int64 > GetPackageSizeForRevision ( const [FName](API\Runtime\Core\UObject\FName) InPackageName, const int64 * InPackageRevision ) const


description:
Check whether the given package event ID is currently for the head revision of the package in the event.
True if the package event ID was queried successfully, false otherwise.

code: bool IsHeadRevisionPackageEvent ( const int64 InPackageEventId, bool & OutIsHeadRevision ) const


description:
Check whether the given transaction event ID is currently for a live transaction event.
True if the transaction event ID was queried successfully, false otherwise.

code: bool IsLiveTransactionEvent ( const int64 InTransactionEventId, bool & OutIsLive ) const


description: Is this a valid database? (ie, has been successfully opened).

code: bool IsValid() const


description:
Open (or create) a database file.
True if the database was opened, false otherwise.

code: bool Open ( const [FString](API\Runtime\Core\Containers\FString) & InSessionPath )


code: bool Open ( const [FString](API\Runtime\Core\Containers\FString) & InSessionPath, const ESQLiteDatabaseOpenMode InOpenMode )


code: [FConcertSyncSessionDatabase](API\Plugins\ConcertSyncCore\FConcertSyncSessionDatabase) & operator= ( const [FConcertSyncSessionDatabase](API\Plugins\ConcertSyncCore\FConcertSyncSessionDatabase) & )


code: [FConcertSyncSessionDatabase](API\Plugins\ConcertSyncCore\FConcertSyncSessionDatabase) & operator= ( [FConcertSyncSessionDatabase](API\Plugins\ConcertSyncCore\FConcertSyncSessionDatabase) && )


description:
Get if a Package has any live transactions
True if query was resolved correctly, false otherwise.

code: bool PackageHasLiveTransactions ( const [FName](API\Runtime\Core\UObject\FName) InPackageName, bool & OutHasLiveTransaction ) const


description: Iterates the given range, calls UpdateCallback on each element, and commits the update.

code: bool SetActivities ( const [TSet](API\Runtime\Core\Containers\TSet)< int64 > & ActivityIds, [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void([FConcertSyncActivity](API\Plugins\ConcertSyncCore\FConcertSyncActivity) &)> UpdateCallback )


description: SetEndpoint).

code: bool SetConnectionActivity ( const [FConcertSyncConnectionActivity](API\Plugins\ConcertSyncCore\FConcertSyncConnectionActivity) & InConnectionActivity )


description:
Set an endpoint in this database, creating or replacing it.
True if the endpoint was set, false otherwise.

code: bool SetEndpoint ( const [FGuid](API\Runtime\Core\Misc\FGuid) & InEndpointId, const [FConcertSyncEndpointData](API\Plugins\ConcertSyncCore\FConcertSyncEndpointData) & InEndpointData )


description: SetEndpoint).

code: bool SetLockActivity ( const [FConcertSyncLockActivity](API\Plugins\ConcertSyncCore\FConcertSyncLockActivity) & InLockActivity )


description: SetEndpoint).

code: bool SetPackageActivity ( const [FConcertSyncActivity](API\Plugins\ConcertSyncCore\FConcertSyncActivity) & InPackageActivity, [FConcertSyncPackageEventData](API\Plugins\ConcertSyncCore\FConcertSyncPackageEventData) & InPackageActivityEvent, const bool bMetaDataOnly )


description: SetEndpoint).

code: bool SetTransactionActivity ( const [FConcertSyncTransactionActivity](API\Plugins\ConcertSyncCore\FConcertSyncTransactionActivity) & InTransactionActivity, const bool bMetaDataOnly )


description: Check Asynchronous Tasks Status

code: void UpdateAsynchronousTasks()


description:
The function is meant to be update a partially synced package event to store the corresponding package data.
True if the package was updated.

code: bool UpdatePackageEvent ( const int64 InPackageEventId, [FConcertSyncPackageEventData](API\Plugins\ConcertSyncCore\FConcertSyncPackageEventData) & PackageEvent )


description:
The function is meant to update a transaction event that was partially synced to store the corresponding transaction data.
True if the transaction was updated.

code: bool UpdateTransactionEvent ( const int64 InTransactionEventId, const [FConcertSyncTransactionEvent](API\Plugins\ConcertSyncCore\FConcertSyncTransactionEvent) & InTransactionEvent )


description: Defined here whereTUniquePtrcan see the definition ofFConcertFileCacheand FConcertSyncSessionDatabaseStatements as theTUniquePtrconstructor/destructor cannot work with a forward declared type

code: FConcertSyncSessionDatabase()


code: FConcertSyncSessionDatabase ( const [FConcertSyncSessionDatabase](API\Plugins\ConcertSyncCore\FConcertSyncSessionDatabase) & )


code: FConcertSyncSessionDatabase ( [FConcertSyncSessionDatabase](API\Plugins\ConcertSyncCore\FConcertSyncSessionDatabase) && )