ISourceControlProvider

Interface to talking with source control providers.

Unreal Engine C++ API Reference > Developer > SourceControl

Inheritance Hierarchy

References

   
Module SourceControl
Header /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h
Include #include "ISourceControlProvider.h"

Syntax

class ISourceControlProvider : public [IModularFeature](API\Runtime\Core\Features\IModularFeature)  

Remarks

Interface to talking with source control providers.

Destructors

Type Name Description
  ~ISourceControlProvider () Virtual destructor

Functions

Type Name Description
bool AllowsDiffAgainstDepot () Whether the provider allow a diff between a changed file and the depot
bool CanCancelOperation ( const FSourceControlOperationRef& ... ) Check to see if we can cancel an operation.
void CancelOperation ( const FSourceControlOperationRef& ... ) Attempt to cancel an operation in progress.
bool CanExecuteOperation ( const FSourceControlOperationRef& ... ) Check to see if we can execute an operation.
void Close () Shut down source control provider.
TUniquePtr< ... Create ( const FStringView& OwnerName, const FSourceControlInitSettings& ... ) Creates a new instance of the source control provider type.
ECommandResu... Execute ( const FSourceControlOperationRef& ..., const EConcurrency::Type InConcurre..., const FSourceControlOperationComple... ) Helper overload for operation execution, see Execute().
ECommandResu... Execute ( const FSourceControlOperationRef& ..., const FString& InFile, const EConcurrency::Type InConcurre..., const FSourceControlOperationComple... ) Helper overload for operation execution, see Execute().
ECommandResu... Execute ( const FSourceControlOperationRef& ..., const TArray< UPackage* >& In..., const EConcurrency::Type InConcurre..., const FSourceControlOperationComple... ) Helper overload for operation execution, see Execute().
ECommandResu... Execute ( const FSourceControlOperationRef& ..., FSourceControlChangelistPtr InChang..., const EConcurrency::Type InConcurre..., const FSourceControlOperationComple... ) Helper overload for operation execution, see Execute().
ECommandResu... Execute ( const FSourceControlOperationRef& ..., FSourceControlChangelistPtr InChang..., const TArray< FString >& InFiles, EConcurrency::Type InConcurrency, const FSourceControlOperationComple... ) Attempt to execute an operation on the passed-in files (if any are required).
ECommandResu... Execute ( const FSourceControlOperationRef& ..., const TArray< FString >& InFiles, EConcurrency::Type InConcurrency, const FSourceControlOperationComple... ) Helper overload for operation execution, see Execute().
ECommandResu... Execute ( const FSourceControlOperationRef& ..., const UPackage* InPackage, const EConcurrency::Type InConcurre..., const FSourceControlOperationComple... ) Helper overload for operation execution, see Execute().
TArray< FSou... GetCachedStateByPredicate ( TFunctionRef< bool(const FSourceCon... ) Get all cached source control state objects for which the supplied predicate returns true
TArray< FSou... GetChangelists ( EStateCacheUsage::Type InStateCache... ) Returns the list of available changelists if the underlying source control supports the 'changelist' concept.
TSharedPtr< ... GetLabel ( const FString& InLabelName ) Get a label matching the passed-in name.
TArray< TSha... GetLabels ( const FString& InMatchingSpec ) Get an array of labels matching the passed-in spec.
const FName ... GetName () Get the source control provider name
TOptional< i... GetNumLocalChanges () Returns the number of changes in the local workspace NOTE: This concept is currently only implemented for the Skein source control provider.
ECommandResu... GetState ( const TArray< UPackage* >& In..., TArray< FSourceControlStateRef >& ..., EStateCacheUsage::Type InStateCache... ) Helper overload for state retrieval, see GetState().
FSourceContr... GetState ( const FString& InFile, EStateCacheUsage::Type InStateCache... ) Helper overload for state retrieval, see GetState().
FSourceContr... GetState ( const UPackage* InPackage, EStateCacheUsage::Type InStateCache... ) Helper overload for state retrieval, see GetState().
FSourceContr... GetState ( const FSourceControlChangelistRef&..., EStateCacheUsage::Type InStateCache... ) Helper overload for state retrieval, see GetState().
ECommandResu... GetState ( const TArray< FSourceControlChangel..., TArray< FSourceControlChangelistSta..., EStateCacheUsage::Type InStateCache... ) Get the state of each of the passed-in changelists.
ECommandResu... GetState ( const TArray< FString >& InFiles, TArray< FSourceControlStateRef >& ..., EStateCacheUsage::Type InStateCache... ) Get the state of each of the passed-in files.
int32 GetStateBranchIndex ( const FString& BranchName ) Gets the state index of the specified branch, higher index branches are generally closer to releases
TMap< EStatu... GetStatus () Get the source control status as a series of key value pairs
FText GetStatusText () Get the source control status as plain, human-readable text
void Init ( bool bForceConnection ) Initialize source control provider.
TOptional< b... IsAtLatestRevision () Whether the current source control client is at the latest version
bool IsAvailable () Quick check if source control is available for use (server-based providers can use this to return whether the server is available or not)
bool IsEnabled () Quick check if source control is enabled.
ECommandResu... Login ( const FString& InPassword, EConcurrency::Type InConcurrency, const FSourceControlOperationComple... ) Login to the source control server (if any).
TSharedRef< ... MakeSettingsWidget () Create a settings widget for display in the login window.
bool QueryStateBranchConfig ( const FString& ConfigSrc, const FString& ConfigDest ) Queries branch configuration from source control
FDelegateHan... RegisterSourceControlStateChanged_Handle ( const FSourceControlStateChanged::F... ) Register a delegate to be called when source control state(s) change
void RegisterStateBranches ( const TArray< FString >& BranchNam..., const FString& ContentRoot ) Register branches to query for state in addition to the current branch
ECommandResu... SwitchWorkspace ( FStringView NewWorkspaceName, FSourceControlResultInfo& OutResul..., FString* OutOldWorkspaceName ) Used to switch the provider from one workspace to another.
void Tick () Called every update.
bool TryToDownloadFileFromBackgroundThread ( const TSharedRef< class FDownloadFi..., const FString& InFile ) Executes the FDownloadFile operation, but unlike the Execute method this can be called from a background thread, this works because FDownloadFile is thread safe and it does not change the state of source control.
bool TryToDownloadFileFromBackgroundThread ( const TSharedRef< class FDownloadFi..., const TArray< FString >& InFiles ) Executes the FDownloadFile operation, but unlike the Execute method this can be called from a background thread, this works because FDownloadFile is thread safe and it does not change the state of source control.
void UnregisterSourceControlStateChanged_Handle ( FDelegateHandle Handle ) Unregister a delegate to be called when source control state(s) change
bool UsesChangelists () Whether the provider uses changelists to identify commits/revisions
bool UsesCheckout () Whether the provider uses the checkout workflow
bool UsesFileRevisions () Whether the provider uses individual file revisions
bool UsesLocalReadOnlyState () Whether the provider uses local read-only state to signal whether a file is editable.
bool UsesSnapshots () Whether the provider uses snapshots
bool UsesUncontrolledChangelists () Whether the provider supports uncontrolled changelists to allow work offline

Enums

Type Name Description
Public enum EStatus  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library