C# Class Microsoft.Protocols.TestSuites.MS_COPYS.MS_COPYSSUTControlAdapter

The implementation of the SUT control managed code adapter interface.
Inheritance: Microsoft.Protocols.TestTools.ManagedAdapterBase, IMS_COPYSSUTControlAdapter
Show file Open project: OfficeDev/Interop-TestSuites

Public Methods

Method Description
CheckOutFileByUser ( string fileUrl, string userName, string password, string domain ) : bool

A method used to check out a file by specified user credential.

DeleteFiles ( string fileUrls ) : bool

This method is used to remove the files.

Initialize ( ITestSite testSite ) : void

Initialize the adapter instance.

UndoCheckOutFileByUser ( string fileUrl, string userName, string password, string domain ) : bool

A method used to undo checkout for a file by specified user credential.

UploadTextFile ( string fileUrl ) : bool

This method is used to upload a file to the specified full file URL. The file's content will be random generated, and encoded with UTF8.

Private Methods

Method Description
DeleteSingleFile ( string singleFileUrl ) : void

This method is used to remove the file.

Method Details

CheckOutFileByUser() public method

A method used to check out a file by specified user credential.
public CheckOutFileByUser ( string fileUrl, string userName, string password, string domain ) : bool
fileUrl string A parameter represents the absolute URL of a file which will be check out by specified user.
userName string A parameter represents the user name which will undo checkout the file. The file must be stored in the destination SUT which is indicated by "SutComputerName" property in "SharePointCommonConfiguration.deployment.ptfconfig" file.
password string A parameter represents the password of the user.
domain string A parameter represents the domain of the user.
return bool

DeleteFiles() public method

This method is used to remove the files.
public DeleteFiles ( string fileUrls ) : bool
fileUrls string Specify the file URLs that will be removed. Each file URL is split by ";" symbol
return bool

Initialize() public method

Initialize the adapter instance.
public Initialize ( ITestSite testSite ) : void
testSite ITestSite A return value represents the ITestSite instance which contains the test context.
return void

UndoCheckOutFileByUser() public method

A method used to undo checkout for a file by specified user credential.
public UndoCheckOutFileByUser ( string fileUrl, string userName, string password, string domain ) : bool
fileUrl string A parameter represents the absolute URL of a file which will be undo checkout by specified user.
userName string A parameter represents the user name which will check out the file. The file must be stored in the destination SUT which is indicated by "SutComputerName" property in "SharePointCommonConfiguration.deployment.ptfconfig" file.
password string A parameter represents the password of the user.
domain string A parameter represents the domain of the user.
return bool

UploadTextFile() public method

This method is used to upload a file to the specified full file URL. The file's content will be random generated, and encoded with UTF8.
public UploadTextFile ( string fileUrl ) : bool
fileUrl string A parameter represents the absolute URL of a file, where the file will be uploaded.
return bool