IConcertClientWorkspace

Windows
MacOS
Linux

References

Module

ConcertSyncClient

Header

/Engine/Plugins/Developer/Concert/ConcertSync/ConcertSyncClient/Source/ConcertSyncClient/Public/IConcertClientWorkspace.h

Include

#include "IConcertClientWorkspace.h"

Syntax

class IConcertClientWorkspace

Functions

Name Description

Public function

void

 

AddWorkspaceFinalizeDelegate

(
    FName InDelegateName,
    FCanFinalizeWorkspaceDelegate InDel...
)

This delegate allows user to defer the finalization of a sync workspace.

Public function

bool

 

AreResourcesLockedBy

(
    TArrayView< const FName > ResourceN...,
    const FGuid& ClientId
)

Verify if resources are locked by a particular client

Public function

TFuture< TOp...

 

FindOrRequestTransactionEvent

(
    const int64 TransactionEventId,
    const bool bMetaDataOnly
)

Lookup the specified transaction events.

Public function Const

bool

 

FindPackageEvent

(
    const int64 PackageEventId,
    FConcertSyncPackageEventMetaData& ...
)

Lookup the specified package event.

Public function Const

bool

 

FindTransactionEvent

(
    const int64 TransactionEventId,
    FConcertSyncTransactionEvent& OutT...,
    const bool bMetaDataOnly
)

Lookup the specified transaction event.

Public function

TArray< FNam...

 

GatherSessionChanges

(
    bool IgnorePersisted
)

Gather assets changes that happened on the workspace in this session.

Public function Const

void

 

GetActivities

(
    const int64 FirstActivityIdToFetch,
    const int64 MaxNumActivities,
    TMap< FGuid, FConcertClientInfo >&...,
    TArray< FConcertClientSessionActivi...
)

Get Activities from the session.

Public function

IConcertClie...

 

GetDataStore()

Public function Const

int64

 

GetLastActivityId()

Get the ID of the last activity in the session.

Public function Const

FGuid

 

GetResourceLockId

(
    const FName InResourceName
)

Public function Const

IConcertClie...

 

GetSession()

Get the associated session.

Public function Const

FGuid

 

GetWorkspaceLockId()

Public function Const

bool

 

HasLiveTransactionSupport

(
    UPackage* InPackage
)

Indicate if an asset package is supported for live transactions.

Public function Const

bool

 

HasSessionChanges()

Tell if a workspace contains session changes.

Public function Const

bool

 

IsAssetModifiedByOtherClients

(
    const FName& AssetName,
    int32* OutOtherClientsWithModi...,
    TArray< FConcertClientInfo >* ...,
    int32 OtherClientsWithModifMaxFetch...
)

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.

Public function

TFuture< FCo...

 

LockResources

(
    TArray< FName > InResourceName
)

Attempt to lock the given resource.

Public function

FOnActivityA...

 

OnActivityAddedOrUpdated()

Public function

FOnWorkspace...

 

OnWorkspaceSynchronized()

Public function

bool

 

PersistSessionChanges

(
    TArrayView< const FName > InPackage...,
    ISourceControlProvider* Source...,
    TArray< FText >* OutFailureRea...
)

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

Public function

void

 

RemoveWorkspaceFinalizeDelegate

(
    FName InDelegateName
)

Remove the attached named delegate for workspace finalization.

Public function

void

 

SetIgnoreOnRestoreFlagForEmittedActivities

(
    bool bIgnore
)

Controls whether the activities emitted to the server through this workspace are marked as 'ignored on restore'.

Public function Const

bool

 

ShouldIgnorePackageDirtyEvent

(
    UPackage* InPackage
)

Indicate if package dirty event should be ignored for a package

Public function

TFuture< FCo...

 

UnlockResources

(
    TArray< FName > InResourceName
)

Attempt to unlock the given resource.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss