Open 3D Engine AzToolsFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Types | Public Member Functions | Static Public Attributes | List of all members
AzToolsFramework::SourceControlCommands Class Referenceabstract

#include <SourceControlAPI.h>

Inherits AZ::EBusTraits.

Public Types

typedef AZStd::recursive_mutex MutexType
 

Public Member Functions

virtual void GetFileInfo (const char *fullFilePath, const SourceControlResponseCallback &respCallback)=0
 Get information on the file state.
 
virtual void GetBulkFileInfo (const AZStd::unordered_set< AZStd::string > &fullFilePaths, const SourceControlResponseCallbackBulk &respCallback)=0
 Get information on the file state for multiple files. Path(s) may contain wildcards.
 
virtual void RequestEdit (const char *fullFilePath, bool allowMultiCheckout, const SourceControlResponseCallback &respCallback)=0
 Attempt to make a file ready for editing.
 
virtual void RequestEditBulk (const AZStd::unordered_set< AZStd::string > &fullFilePaths, bool allowMultiCheckout, const SourceControlResponseCallbackBulk &respCallback)=0
 Attempt to make a set of files ready for editing.
 
virtual void RequestDelete (const char *fullFilePath, const SourceControlResponseCallback &respCallback)=0
 Attempt to delete a file.
 
virtual void RequestDeleteExtended (const char *fullFilePath, bool skipReadOnly, const SourceControlResponseCallback &respCallback)=0
 
virtual void RequestDeleteBulk (const char *fullFilePath, const SourceControlResponseCallbackBulk &respCallback)=0
 Attempt to delete multiple files. Path may contain wildcards.
 
virtual void RequestDeleteBulkExtended (const char *fullFilePath, bool skipReadOnly, const SourceControlResponseCallbackBulk &respCallback)=0
 
virtual void RequestRevert (const char *fullFilePath, const SourceControlResponseCallback &respCallback)=0
 Attempt to revert a file.
 
virtual void RequestLatest (const char *fullFilePath, const SourceControlResponseCallback &respCallback)=0
 Attempt to get latest revision of a file.
 
virtual void RequestRename (const char *sourcePathFull, const char *destPathFull, const SourceControlResponseCallback &respCallback)=0
 Attempt to rename or move a file.
 
virtual void RequestRenameExtended (const char *sourcePathFull, const char *destPathFull, bool skipReadOnly, const SourceControlResponseCallback &respCallback)=0
 
virtual void RequestRenameBulk (const char *sourcePathFull, const char *destPathFull, const SourceControlResponseCallbackBulk &respCallback)=0
 Attempt to rename or move multiple files. Path may contain wildcards.
 
virtual void RequestRenameBulkExtended (const char *sourcePathFull, const char *destPathFull, bool skipReadOnly, const SourceControlResponseCallbackBulk &respCallback)=0
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single
 

Detailed Description

SourceControlCommands This bus handles messages relating to source control commands source control commands are ASYNCHRONOUS do not block the main thread waiting for a response, it is not okay you will not get a message delivered unless you tick the tickbus anyway!

Member Function Documentation

◆ RequestDeleteBulkExtended()

virtual void AzToolsFramework::SourceControlCommands::RequestDeleteBulkExtended ( const char *  fullFilePath,
bool  skipReadOnly,
const SourceControlResponseCallbackBulk &  respCallback 
)
pure virtual

Attempt to delete multiple files. Path may contain wildcards

Parameters
skipReadOnlyIf source control is disabled and we're using the local file component, this will skip changes to files which are readonly

◆ RequestDeleteExtended()

virtual void AzToolsFramework::SourceControlCommands::RequestDeleteExtended ( const char *  fullFilePath,
bool  skipReadOnly,
const SourceControlResponseCallback &  respCallback 
)
pure virtual

Attempt to delete a file

Parameters
skipReadOnlyIf source control is disabled and we're using the local file component, this will skip changes to files which are readonly

◆ RequestRenameBulkExtended()

virtual void AzToolsFramework::SourceControlCommands::RequestRenameBulkExtended ( const char *  sourcePathFull,
const char *  destPathFull,
bool  skipReadOnly,
const SourceControlResponseCallbackBulk &  respCallback 
)
pure virtual

Attempt to rename or move multiple files. Path may contain wildcards

Parameters
skipReadOnlyIf source control is disabled and we're using the local file component, this will skip changes to files which are readonly

◆ RequestRenameExtended()

virtual void AzToolsFramework::SourceControlCommands::RequestRenameExtended ( const char *  sourcePathFull,
const char *  destPathFull,
bool  skipReadOnly,
const SourceControlResponseCallback &  respCallback 
)
pure virtual

Attempt to rename or move a file

Parameters
skipReadOnlyIf source control is disabled and we're using the local file component, this will skip changes to files which are readonly
The documentation for this class was generated from the following file: