IVcsProvider interface

No description yet.

public interface IVcsProvider

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Derived: ICloudVCSVcsProvider, ISVNVcsProvider

Methods

Method	Returns	Description
AddFiles	string
AddRegisteredDesignVault	IVcsDesignVault
BrowseRepository	bool
CanCreateDesignVault	bool
CheckOut	int
CheckRepository	bool
ClearRegisteredDesignVaults	void
Commit	string
CreateDesignVault	IVcsDesignVault
CreateProject	IVcsProject
CreateRepository	int
CreateRepositorySilently	bool
Delete	string
DeleteInRepository	string
DesignVaultForFolder	IVcsDesignVault
Download	int
Export	string
GetAutoConnect	bool
GetName	string
GetOptionPage	IOptionsPage
GetRegisteredDesignVault	IVcsDesignVault
GetValid	bool
Import	string
IsUnderVersionControl	bool
ListRepository	IVcsFileNames
LoadDesignVaultsFromIni	void
Move	string
RegisteredDesignVaultCount	int
ReloadOptions	void
RepositoryPathExists	bool
Resolve	int
Revert	string
SaveOptions	void
SelectModule	bool
ShallowCheckOut	int
Update	int

AddFiles

No description yet.

string AddFiles(string argRepositoryAddress, string argLocalDirectory, string argComment, IVcsFileNames argLocalFilePaths, bool argCommit);
string AddFiles(string argRepositoryAddress, string argLocalDirectory, string argComment, object argLocalFilePaths, bool argCommit);

Parameter	Type	Passing
argRepositoryAddress	string	value
argLocalDirectory	string	value
argComment	string	value
argLocalFilePaths	IVcsFileNames	value
argCommit	bool	value

Returns: string

The first overload is an extension method of IVcsProviderHelper (using DXP;) with typed parameters; the second is declared by the interface.

AddRegisteredDesignVault

No description yet.

IVcsDesignVault AddRegisteredDesignVault();

Returns: IVcsDesignVault

Extension method of IVcsProviderHelper (using DXP;).

BrowseRepository

No description yet.

bool BrowseRepository(ref string argRepositoryAddress);

Parameter	Type	Passing
argRepositoryAddress	string	ref

Returns: bool

CanCreateDesignVault

No description yet.

bool CanCreateDesignVault();

Returns: bool

CheckOut

No description yet.

int CheckOut(string argRepositoryAddress, string argPath, string argLocalDirectory);

Parameter	Type	Passing
argRepositoryAddress	string	value
argPath	string	value
argLocalDirectory	string	value

Returns: int

CheckRepository

No description yet.

bool CheckRepository(ref string argRepositoryAddress);

Parameter	Type	Passing
argRepositoryAddress	string	ref

Returns: bool

ClearRegisteredDesignVaults

No description yet.

void ClearRegisteredDesignVaults();

Returns: nothing (void)

Commit

No description yet.

string Commit(string argRepositoryAddress, string argLocalDirectory, string argComment, IVcsFileNames argFileNames);
string Commit(string argRepositoryAddress, string argLocalDirectory, string argComment, object argFileNames);

Parameter	Type	Passing
argRepositoryAddress	string	value
argLocalDirectory	string	value
argComment	string	value
argFileNames	IVcsFileNames	value

Returns: string

The first overload is an extension method of IVcsProviderHelper (using DXP;) with typed parameters; the second is declared by the interface.

CreateDesignVault

No description yet.

IVcsDesignVault CreateDesignVault();

Returns: IVcsDesignVault

Extension method of IVcsProviderHelper (using DXP;).

CreateProject

No description yet.

IVcsProject CreateProject();

Returns: IVcsProject

Extension method of IVcsProviderHelper (using DXP;).

CreateRepository

No description yet.

int CreateRepository(ref string argRepositoryAddress);

Parameter	Type	Passing
argRepositoryAddress	string	ref

Returns: int

CreateRepositorySilently

No description yet.

bool CreateRepositorySilently(ref string argRepositoryAddress, bool argData);

Parameter	Type	Passing
argRepositoryAddress	string	ref
argData	bool	value

Returns: bool

Delete

No description yet.

string Delete(string argRepositoryAddress, IVcsFileNames argLocalPaths);
string Delete(string argRepositoryAddress, object argLocalPaths);

Parameter	Type	Passing
argRepositoryAddress	string	value
argLocalPaths	IVcsFileNames	value

Returns: string

The first overload is an extension method of IVcsProviderHelper (using DXP;) with typed parameters; the second is declared by the interface.

DeleteInRepository

No description yet.

string DeleteInRepository(string argRepositoryAddress, string argComment, IVcsFileNames argRepositoryPaths);
string DeleteInRepository(string argRepositoryAddress, string argComment, object argRepositoryPaths);

Parameter	Type	Passing
argRepositoryAddress	string	value
argComment	string	value
argRepositoryPaths	IVcsFileNames	value

Returns: string

The first overload is an extension method of IVcsProviderHelper (using DXP;) with typed parameters; the second is declared by the interface.

DesignVaultForFolder

No description yet.

IVcsDesignVault DesignVaultForFolder(string argDirectory);

Parameter	Type	Passing
argDirectory	string	value

Returns: IVcsDesignVault

Extension method of IVcsProviderHelper (using DXP;).

Download

No description yet.

int Download(string argRepositoryAddress, string argFileName, string argLocalDirectory);

Parameter	Type	Passing
argRepositoryAddress	string	value
argFileName	string	value
argLocalDirectory	string	value

Returns: int

Export

No description yet.

string Export(string argRepositoryAddress, string argPath, string argLocalDirectory);

Parameter	Type	Passing
argRepositoryAddress	string	value
argPath	string	value
argLocalDirectory	string	value

Returns: string

GetAutoConnect

No description yet.

bool GetAutoConnect();

Returns: bool

GetName

No description yet.

string GetName();

Returns: string

GetOptionPage

No description yet.

IOptionsPage GetOptionPage();

Returns: IOptionsPage

Extension method of IVcsProviderHelper (using DXP;).

GetRegisteredDesignVault

No description yet.

IVcsDesignVault GetRegisteredDesignVault(int argI);

Parameter	Type	Passing
argI	int	value

Returns: IVcsDesignVault

Extension method of IVcsProviderHelper (using DXP;).

GetValid

No description yet.

bool GetValid();

Returns: bool

Import

No description yet.

string Import(string argRepositoryAddress, string argPath, string argLocalDirectory, string argComment);

Parameter	Type	Passing
argRepositoryAddress	string	value
argPath	string	value
argLocalDirectory	string	value
argComment	string	value

Returns: string

IsUnderVersionControl

No description yet.

bool IsUnderVersionControl(string argDirectory);

Parameter	Type	Passing
argDirectory	string	value

Returns: bool

ListRepository

No description yet.

IVcsFileNames ListRepository(string argRepositoryAddress, string argPath, bool argRecursive);

Parameter	Type	Passing
argRepositoryAddress	string	value
argPath	string	value
argRecursive	bool	value

Returns: IVcsFileNames

Extension method of IVcsProviderHelper (using DXP;).

LoadDesignVaultsFromIni

No description yet.

void LoadDesignVaultsFromIni(IOptionsReader argReader, string argSectionName);
void LoadDesignVaultsFromIni(object argReader, string argSectionName);

Parameter	Type	Passing
argReader	IOptionsReader	value
argSectionName	string	value

Returns: nothing (void)

The first overload is an extension method of IVcsProviderHelper (using DXP;) with typed parameters; the second is declared by the interface.

Move

No description yet.

string Move(string argRepositoryAddress, string argSrcPath, string argDestPath);

Parameter	Type	Passing
argRepositoryAddress	string	value
argSrcPath	string	value
argDestPath	string	value

Returns: string

RegisteredDesignVaultCount

No description yet.

int RegisteredDesignVaultCount();

Returns: int

ReloadOptions

No description yet.

void ReloadOptions();

Returns: nothing (void)

RepositoryPathExists

No description yet.

bool RepositoryPathExists(string argRepositoryAddress, string argPath);

Parameter	Type	Passing
argRepositoryAddress	string	value
argPath	string	value

Returns: bool

Resolve

No description yet.

int Resolve(string argLocalDirectory, IVcsFileNames argFileNames);
int Resolve(string argLocalDirectory, object argFileNames);

Parameter	Type	Passing
argLocalDirectory	string	value
argFileNames	IVcsFileNames	value

Returns: int

The first overload is an extension method of IVcsProviderHelper (using DXP;) with typed parameters; the second is declared by the interface.

Revert

No description yet.

string Revert(string argRepositoryAddress, IVcsFileNames argLocalPaths);
string Revert(string argRepositoryAddress, object argLocalPaths);

Parameter	Type	Passing
argRepositoryAddress	string	value
argLocalPaths	IVcsFileNames	value

Returns: string

The first overload is an extension method of IVcsProviderHelper (using DXP;) with typed parameters; the second is declared by the interface.

SaveOptions

No description yet.

void SaveOptions();

Returns: nothing (void)

SelectModule

No description yet.

bool SelectModule(string argAuxProject, ref string argModule);

Parameter	Type	Passing
argAuxProject	string	value
argModule	string	ref

Returns: bool

ShallowCheckOut

No description yet.

int ShallowCheckOut(string argRepositoryAddress, string argPath, string argLocalDirectory);

Parameter	Type	Passing
argRepositoryAddress	string	value
argPath	string	value
argLocalDirectory	string	value

Returns: int

Update

No description yet.

int Update(string argRepositoryAddress, string argLocalDirectory);

Parameter	Type	Passing
argRepositoryAddress	string	value
argLocalDirectory	string	value

Returns: int

Returned by

IVcsBasedProjectCommands.GetVcsProvider, IVcsDesignVault.GetProvider, IVcsManager.GetProviderByType