C# Class Microsoft.Protocols.TestSuites.MS_ASCAL.TestSuiteBase

The base class of scenario class.

Inheritance: Microsoft.Protocols.TestTools.TestClassBase

ファイルを表示 Open project: OfficeDev/Interop-TestSuites

Public Methods

Method	Description
AddCalendarWithMultipleCalendarType ( string type ) : Microsoft.Protocols.TestSuites.Common.DataStructures.SyncStore	A method that send out string command request that contains multiple CalendarType elements in Recurrence.
AddSyncCalendar ( object>.Dictionary items ) : Microsoft.Protocols.TestSuites.Common.DataStructures.SyncStore	Add a calendar to server, and if add is success then sync CalendarFolder.
CreateCalendarRecurrence ( byte recurrenceType, int occurrences, int interval ) : Recurrence	Create a Request.Recurrence instance with child elements.
CreateDefaultCalendar ( ) : object>.Dictionary	Create a Calendar instance with 'Subject', 'OrganizerName', 'OrganizerEmail', 'Location' 'TimeZone', 'Body' and 'UID' elements.
CreateRecurrenceIncludingCalendarType ( Request recurrenceInstance, byte calendarType ) : Recurrence	Create a Request.Recurrence instance including specified CalendarType element value.
DeleteAllItems ( string collectionId ) : void	Delete all items from the specified collection
DeleteItemsInFolder ( Collection createdItemsCollection ) : void	Delete all the items in a folder.
GetChangeItem ( string collectionId, string calendarSubject ) : Microsoft.Protocols.TestSuites.Common.DataStructures.Sync	Get the specified email item from the sync change response
InitializeSync ( string collectionId, Request supported ) : Microsoft.Protocols.TestSuites.Common.DataStructures.SyncStore	Initialize the sync with server
SyncChanges ( string collectionId ) : Microsoft.Protocols.TestSuites.Common.DataStructures.SyncStore	Sync changes between client and server
UpdateCalendarProperty ( string serverId, string collectionId, string syncKey, object>.Dictionary items ) : Microsoft.Protocols.TestSuites.Common.DataStructures.SyncStore	Call sync command to update properties of an existing calendar item.

Protected Methods

Method	Description
MeetingResponse ( byte userResponse, string collectionId, string serverId, string instanceId ) : bool	Call MeetingResponse command to respond the meeting request
RecordCaseRelativeItems ( string userName, string folderCollectionId ) : void	Record the user name, folder collectionId and subjects the current test case impacts.
SendMimeMeeting ( Microsoft.Protocols.TestSuites.Common.DataStructures.Calendar calendarItem, string subjectName, string organizerEmailAddress, string attendeeEmailAddress, string method, string replyMethod ) : void	Using mail with mime content to send a meeting request or cancel request
SwitchUser ( UserInformation userInformation, bool isFolderSyncNeeded ) : void	This method is used to change user to call ActiveSync commands and resynchronize the folder collection hierarchy.
TestCleanup ( ) : void	Clean up the test Case
TestInitialize ( ) : void	Initialize the test Case

Private Methods

Method	Description
InitializePropertiesValue ( ) : void	Initialize properties value.

Method Details

AddCalendarWithMultipleCalendarType() public method

A method that send out string command request that contains multiple CalendarType elements in Recurrence.

public AddCalendarWithMultipleCalendarType ( string type ) : Microsoft.Protocols.TestSuites.Common.DataStructures.SyncStore
type	string	value of Type element in Recurrence.
return	Microsoft.Protocols.TestSuites.Common.DataStructures.SyncStore

AddSyncCalendar() public method

Add a calendar to server, and if add is success then sync CalendarFolder.

public AddSyncCalendar ( object>.Dictionary items ) : Microsoft.Protocols.TestSuites.Common.DataStructures.SyncStore
items	object>.Dictionary	The dictionary store calendar item's element name and element value
return	Microsoft.Protocols.TestSuites.Common.DataStructures.SyncStore

CreateCalendarRecurrence() public method

Create a Request.Recurrence instance with child elements.

public CreateCalendarRecurrence ( byte recurrenceType, int occurrences, int interval ) : Recurrence
recurrenceType	byte	The recurrence type
occurrences	int	The value of Occurrences element.
interval	int	The value of Interval element.
return	Microsoft.Protocols.TestSuites.Common.Request.Recurrence

CreateDefaultCalendar() public method

Create a Calendar instance with 'Subject', 'OrganizerName', 'OrganizerEmail', 'Location' 'TimeZone', 'Body' and 'UID' elements.

public CreateDefaultCalendar ( ) : object>.Dictionary
return	object>.Dictionary

CreateRecurrenceIncludingCalendarType() public method

Create a Request.Recurrence instance including specified CalendarType element value.

public CreateRecurrenceIncludingCalendarType ( Request recurrenceInstance, byte calendarType ) : Recurrence
recurrenceInstance	Microsoft.Protocols.TestSuites.Common.Request	The recurrence instance
calendarType	byte	The calendarType value
return	Microsoft.Protocols.TestSuites.Common.Request.Recurrence

DeleteAllItems() public method

Delete all items from the specified collection

public DeleteAllItems ( string collectionId ) : void
collectionId	string	The specified collection id
return	void

DeleteItemsInFolder() public method

Delete all the items in a folder.

public DeleteItemsInFolder ( Collection createdItemsCollection ) : void
createdItemsCollection	Collection	The collection of items which should be deleted.
return	void

GetChangeItem() public method

Get the specified email item from the sync change response

public GetChangeItem ( string collectionId, string calendarSubject ) : Microsoft.Protocols.TestSuites.Common.DataStructures.Sync
collectionId	string	The email folder server id.
calendarSubject	string	The subject value of calendar.
return	Microsoft.Protocols.TestSuites.Common.DataStructures.Sync

InitializeSync() public method

Initialize the sync with server

public InitializeSync ( string collectionId, Request supported ) : Microsoft.Protocols.TestSuites.Common.DataStructures.SyncStore
collectionId	string	Specify the folder collection Id which needs to be synced.
supported	Microsoft.Protocols.TestSuites.Common.Request	Specifies which contact and calendar elements in a Sync request are managed by the client and therefore not ghosted.
return	Microsoft.Protocols.TestSuites.Common.DataStructures.SyncStore

MeetingResponse() protected method

Call MeetingResponse command to respond the meeting request

protected MeetingResponse ( byte userResponse, string collectionId, string serverId, string instanceId ) : bool
userResponse	byte	The value indicates whether the meeting is being accepted, tentatively accepted, or declined
collectionId	string	Specify the server id of mailbox
serverId	string	Specify a unique identifier that was assigned by the server for a mailItem
instanceId	string	Specify the start time of the appointment or meeting instance to be modified. The format of the instanceId value /// is a string in dateTime ([MS-ASDTYPE] section 2.3) format with the punctuation separators, for example, 2010-04-08T18:16:00.000Z
return	bool

RecordCaseRelativeItems() protected method

Record the user name, folder collectionId and subjects the current test case impacts.

protected RecordCaseRelativeItems ( string userName, string folderCollectionId ) : void
userName	string	The user that current test case used.
folderCollectionId	string	The collectionId of folders that the current test case impacts.
return	void

SendMimeMeeting() protected method

Using mail with mime content to send a meeting request or cancel request

protected SendMimeMeeting ( Microsoft.Protocols.TestSuites.Common.DataStructures.Calendar calendarItem, string subjectName, string organizerEmailAddress, string attendeeEmailAddress, string method, string replyMethod ) : void
calendarItem	Microsoft.Protocols.TestSuites.Common.DataStructures.Calendar	Calendar information
subjectName	string	The subject name of meeting request mail
organizerEmailAddress	string	The organizer email address
attendeeEmailAddress	string	The attendee email address
method	string	Specify normal appointments from meeting requests, responses, and cancellations, it can be set to 'REQUEST', 'REPLY', or 'CANCEL'
replyMethod	string	Specify REPLY method, it can be set to 'ACCEPTED', 'TENTATIVE', or 'DECLINED'
return	void

SwitchUser() protected method

This method is used to change user to call ActiveSync commands and resynchronize the folder collection hierarchy.

protected SwitchUser ( UserInformation userInformation, bool isFolderSyncNeeded ) : void
userInformation	UserInformation	The information of the user that will switch to.
isFolderSyncNeeded	bool	A boolean value indicates whether needs to synchronize the folder hierarchy.
return	void

SyncChanges() public method

Sync changes between client and server

public SyncChanges ( string collectionId ) : Microsoft.Protocols.TestSuites.Common.DataStructures.SyncStore
collectionId	string	Specify the folder collection Id which needs to be synced.
return	Microsoft.Protocols.TestSuites.Common.DataStructures.SyncStore

TestCleanup() protected method

Clean up the test Case

protected TestCleanup ( ) : void
return	void

TestInitialize() protected method

Initialize the test Case

protected TestInitialize ( ) : void
return	void

UpdateCalendarProperty() public method

Call sync command to update properties of an existing calendar item.

public UpdateCalendarProperty ( string serverId, string collectionId, string syncKey, object>.Dictionary items ) : Microsoft.Protocols.TestSuites.Common.DataStructures.SyncStore
serverId	string	Server Id of the calendar item.
collectionId	string	Collection Id of the folder that calendar item is contained in.
syncKey	string	Sync key value.
items	object>.Dictionary	The dictionary store calendar item's element name and element value, which will be changed.
return	Microsoft.Protocols.TestSuites.Common.DataStructures.SyncStore