Class
CloudStorageProjectOpener

Definition

Namespace:ArtOfTest.WebAii.Design.Repository

Assembly:ArtOfTest.WebAii.Design.dll

Syntax:

cs-api-definition
public class CloudStorageProjectOpener : ICloudStorageProjectOpener

Inheritance: objectCloudStorageProjectOpener

Implements: ICloudStorageProjectOpener

Constructors

CloudStorageProjectOpener(string, IFileReaderWriterSync, IRepositoryDataBus)

Optional parameters only exist for the purpose of unit testing

Declaration

cs-api-definition
public CloudStorageProjectOpener(string defaultProjectPath, IFileReaderWriterSync fileReaderWriter = null, IRepositoryDataBus dataBus = null)

Parameters

defaultProjectPath

string

fileReaderWriter

IFileReaderWriterSync

dataBus

IRepositoryDataBus

Properties

ConnectionStatus

Returns if the user is entitled to access Cloud Storage

Declaration

cs-api-definition
public string ConnectionStatus { get; }

Property Value

string

Implements ICloudStorageProjectOpener.ConnectionStatus

IsCredentialsChanged

Signals when credentials have been changed and a new LicenseSession is required

Declaration

cs-api-definition
public bool IsCredentialsChanged { get; set; }

Property Value

bool

Implements ICloudStorageProjectOpener.IsCredentialsChanged

LicenseSession

Manages connecting to the user account service to get a storage token

Declaration

cs-api-definition
public ICloudLicenseSession LicenseSession { get; set; }

Property Value

ICloudLicenseSession

Implements ICloudStorageProjectOpener.LicenseSession

Methods

GetLocalProjectPath(string)

Builds the full local disk path of the given project

Declaration

cs-api-definition
public string GetLocalProjectPath(string projectName)

Parameters

projectName

string

Returns

string

Implements ICloudStorageProjectOpener.GetLocalProjectPath(string)

SaveProjectAndTestLocallyAsync(IStorageDocument<ProjectNameTransport>, Guid, string)

Writes out the project and specific test to the project's local disk location.

Declaration

cs-api-definition
public Task<bool> SaveProjectAndTestLocallyAsync(IStorageDocument<ProjectNameTransport> projectNameDocument, Guid testId, string path)

Parameters

projectNameDocument

IStorageDocument<ProjectNameTransport>

testId

Guid

path

string

Returns

Task<bool>

Implements ICloudStorageProjectOpener.SaveProjectAndTestLocallyAsync(IStorageDocument<ProjectNameTransport>, Guid, string)

SaveProjectLocallyAsync(IStorageDocument<ProjectNameTransport>, string)

Writes out the project settings and attachments to the project's local disk location.

Declaration

cs-api-definition
public Task<Project> SaveProjectLocallyAsync(IStorageDocument<ProjectNameTransport> projectNameDocument, string path)

Parameters

projectNameDocument

IStorageDocument<ProjectNameTransport>

path

string

Returns

Task<Project>

Implements ICloudStorageProjectOpener.SaveProjectLocallyAsync(IStorageDocument<ProjectNameTransport>, string)

SaveProjectWithTestListsAndTestsLocallyAsync(IStorageDocument<ProjectNameTransport>, string, bool)

Writes out the project settings and attachments, test lists and tests to the project's local disk location.

Declaration

cs-api-definition
public Task<Project> SaveProjectWithTestListsAndTestsLocallyAsync(IStorageDocument<ProjectNameTransport> projectNameDocument, string path, bool skipLoadTests = false)

Parameters

projectNameDocument

IStorageDocument<ProjectNameTransport>

path

string

skipLoadTests

bool

Returns

Task<Project>

Implements ICloudStorageProjectOpener.SaveProjectWithTestListsAndTestsLocallyAsync(IStorageDocument<ProjectNameTransport>, string, bool)

SaveTestByPathLocallyAsync(string, string)

Writes out only the specific test to the project's local disk location without redownloading a project.

Declaration

cs-api-definition
public Task SaveTestByPathLocallyAsync(string projectPath, string relativeTestPath)

Parameters

projectPath

string

relativeTestPath

string

Taken from a coded Test call to ExecuteTest; most likely absolute.

Returns

Task

Implements ICloudStorageProjectOpener.SaveTestByPathLocallyAsync(string, string)

SaveTestLocallyAsync(Guid, string)

Writes out only the specific test to the project's local disk location without redownloading a project.

Declaration

cs-api-definition
public Task SaveTestLocallyAsync(Guid testId, string projectPath)

Parameters

testId

Guid

projectPath

string

Returns

Task

Implements ICloudStorageProjectOpener.SaveTestLocallyAsync(Guid, string)