C# Class Microsoft.Protocols.TestSuites.MS_ASCON.MS_ASCONAdapter

The class provides methods to verify data/operation format in MS-ASCON.

Show file Open project: OfficeDev/Interop-TestSuites

Public Methods

Method	Description
FolderSync ( FolderSyncRequest folderSyncRequest ) : FolderSyncResponse	Synchronizes the collection hierarchy
GetItemEstimate ( GetItemEstimateRequest getItemEstimateRequest ) : GetItemEstimateResponse	Gets an estimate of the number of items in a collection or folder on the server that have to be synchronized.
Initialize ( ITestSite testSite ) : void	Overrides IAdapter's Initialize() and sets default protocol short name of the testSite.
ItemOperations ( ItemOperationsRequest itemOperationsRequest ) : ItemOperationsResponse	Acts as a container for the Fetch element, the EmptyFolderContents element, and the Move element to provide batched online handling of these operations against the server.
MoveItems ( MoveItemsRequest moveItemsRequest ) : MoveItemsResponse	Moves an item or items from one folder on the server to another.
Search ( SearchRequest searchRequest, bool expectSuccess, int itemsCount ) : SearchStore	Find entries address book, mailbox, or document library.
SendMail ( SendMailRequest sendMailRequest ) : SendMailResponse	Sends MIME-formatted e-mail messages to the server.
SmartForward ( SmartForwardRequest smartForwardRequest ) : SmartForwardResponse	Forwards messages without retrieving the full, original message from the server.
SmartReply ( SmartReplyRequest smartReplyRequest ) : SmartReplyResponse	Replies to messages without retrieving the full, original message from the server.
SwitchUser ( string userName, string userPassword, string userDomain ) : void	Change the user authentication.
Sync ( SyncRequest syncRequest ) : SyncStore	Synchronizes changes in a collection between the client and the server.
SyncEmail ( SyncRequest syncRequest, string subject, bool isRetryNeeded ) : Sync	Find an email with specific subject.

Private Methods

Method	Description
VerifyCommonRequirements ( ) : void	This method is used to verify common requirements.
VerifyContainerDataType ( ) : void	This method is used to verify the container data type related requirements.
VerifyIntegerDataType ( ) : void	This method is used to verify the integer data type related requirements.
VerifyItemOperationsCommandResponse ( ItemOperationsResponse itemOperationsResponse ) : void	This method is used to verify requirements related to ItemOperations command.
VerifyStringDataType ( ) : void	This method is used to verify the string data type related requirements.
VerifySyncCommandResponse ( Sync syncResult ) : void	This method is used to verify requirements related to Sync command.
VerifyWBXMLCapture ( ) : void	Verify WBXML Capture for WBXML process.

Method Details

FolderSync() public method

Synchronizes the collection hierarchy

public FolderSync ( FolderSyncRequest folderSyncRequest ) : FolderSyncResponse
folderSyncRequest	FolderSyncRequest	A FolderSyncRequest object that contains the request information.
return	FolderSyncResponse

GetItemEstimate() public method

Gets an estimate of the number of items in a collection or folder on the server that have to be synchronized.

public GetItemEstimate ( GetItemEstimateRequest getItemEstimateRequest ) : GetItemEstimateResponse
getItemEstimateRequest	GetItemEstimateRequest	A GetItemEstimateRequest object that contains the request information.
return	Microsoft.Protocols.TestSuites.Common.Response.GetItemEstimateResponse

Initialize() public method

Overrides IAdapter's Initialize() and sets default protocol short name of the testSite.

public Initialize ( ITestSite testSite ) : void
testSite	ITestSite	Transfer ITestSite into adapter, make adapter can use ITestSite's function.
return	void

ItemOperations() public method

Acts as a container for the Fetch element, the EmptyFolderContents element, and the Move element to provide batched online handling of these operations against the server.

public ItemOperations ( ItemOperationsRequest itemOperationsRequest ) : ItemOperationsResponse
itemOperationsRequest	ItemOperationsRequest	An ItemOperationsRequest object that contains the request information.
return	Microsoft.Protocols.TestSuites.Common.Response.ItemOperationsResponse

MoveItems() public method

Moves an item or items from one folder on the server to another.

public MoveItems ( MoveItemsRequest moveItemsRequest ) : MoveItemsResponse
moveItemsRequest	MoveItemsRequest	A MoveItemsRequest object that contains the request information.
return	Microsoft.Protocols.TestSuites.Common.Response.MoveItemsResponse

Search() public method

Find entries address book, mailbox, or document library.

public Search ( SearchRequest searchRequest, bool expectSuccess, int itemsCount ) : SearchStore
searchRequest	SearchRequest	A SearchRequest object that contains the request information.
expectSuccess	bool	Whether the Search command is expected to be successful.
itemsCount	int	The count of the items expected to be found.
return	Microsoft.Protocols.TestSuites.Common.DataStructures.SearchStore

SendMail() public method

Sends MIME-formatted e-mail messages to the server.

public SendMail ( SendMailRequest sendMailRequest ) : SendMailResponse
sendMailRequest	SendMailRequest	A SendMailRequest object that contains the request information.
return	SendMailResponse

SmartForward() public method

Forwards messages without retrieving the full, original message from the server.

public SmartForward ( SmartForwardRequest smartForwardRequest ) : SmartForwardResponse
smartForwardRequest	SmartForwardRequest	A SmartForwardRequest object that contains the request information.
return	SmartForwardResponse

SmartReply() public method

Replies to messages without retrieving the full, original message from the server.

public SmartReply ( SmartReplyRequest smartReplyRequest ) : SmartReplyResponse
smartReplyRequest	SmartReplyRequest	A SmartReplyRequest object that contains the request information.
return	SmartReplyResponse

SwitchUser() public method

Change the user authentication.

public SwitchUser ( string userName, string userPassword, string userDomain ) : void
userName	string	The name of a user.
userPassword	string	The password of a user.
userDomain	string	The domain which the user belongs to.
return	void

Sync() public method

Synchronizes changes in a collection between the client and the server.

public Sync ( SyncRequest syncRequest ) : SyncStore
syncRequest	SyncRequest	A SyncRequest object that contains the request information.
return	Microsoft.Protocols.TestSuites.Common.DataStructures.SyncStore

SyncEmail() public method

Find an email with specific subject.

public SyncEmail ( SyncRequest syncRequest, string subject, bool isRetryNeeded ) : Sync
syncRequest	SyncRequest	A SyncRequest object that contains the request information.
subject	string	The subject of the email to find.
isRetryNeeded	bool	A boolean whether need retry.
return	Sync