Navigation
API > API/Developer > API/Developer/SourceControl
Inheritance Hierarchy
- TSharedFromThis< ISourceControlOperation, ESPMode::ThreadSafe >
- ISourceControlOperation
- FSourceControlOperationBase
- FCreateWorkspace
References
| Module | SourceControl |
| Header | /Engine/Source/Developer/SourceControl/Public/SourceControlOperations.h |
| Include | #include "SourceControlOperations.h" |
Syntax
class FCreateWorkspace : public FSourceControlOperationBase
Remarks
Operation used to create a new workspace if the source control system supports this functionality.
Variables
| Type | Name | Description | |
|---|---|---|---|
| TArray< FClientViewMapping > | ClientView | ||
| EType | Type | ||
| FString | WorkspaceDescription | ||
| FString | WorkspaceName | ||
| FString | WorkspaceRoot | ||
| FString | WorkspaceStream |
Constructors
| Type | Name | Description | |
|---|---|---|---|
FCreateWorkspace
(
FStringView WorkspaceName, |
Constructor |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | AddNativeClientViewMapping
(
FStringView DepotPath, |
Add a new mapping for the client spec in the native format of the current source control provider. | |
| void | Remove all currently set client-view mappings | ||
| const TArray< FClientViewMapping > | |||
| EType | GetType () |
||
| const FString & | |||
| const FString & | |||
| const FString & | |||
| const FString & | |||
| void | SetDescription
(
FStringView Desciption |
Set the description to be used by the workspace, if left unset then the default description will be used | |
| void | SetStream
(
FStringView Stream |
Set the stream to be used by the workspace, if left unset then a classic depot with ClientView will be used | |
| void | Set the type of workspace to be created. |
Overridden from ISourceControlOperation
| Type | Name | Description | |
|---|---|---|---|
| FText | Get the string to display when this operation is in progress | ||
| FName | GetName () |
Get the name of this operation, used as a unique identifier |
Enums
| Type | Name | Description | |
|---|---|---|---|
| EType |
Typedefs
| Name | Description |
|---|---|
| FClientViewMapping |