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

Inheritance: Microsoft.Protocols.TestTools.TestClassBase

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

Protected Methods

Method	Description
CheckWhetherSupportMAPIHTTP ( ) : void	Check whether support MS-OXCMAPIHTTP transport.
CreateBookmark ( uint tableHandle ) : RopCreateBookmarkResponse	Marks the current cursor position in a table.
ExpandRow ( uint tableHandle, ushort maxRowCount, ulong categoryId ) : RopExpandRowResponse	This ROP expands a categorized row, see [MS-OXCTABL] section 2.2.2.17.
FindRow ( uint tableHandle, byte restrictionData ) : RopFindRowResponse	Moves the cursor to a row in a table that matches specific search criteria.
GetContentsTable ( uint tableHandle, uint &contentTableHandle, bool disableNotification ) : RopGetContentsTableResponse	Gets the content table of a container.
GetPropertiesSpecific ( uint objHandle, PropertyTag propertyTags ) : RopGetPropertiesSpecificResponse	This ROP gets specific properties of a message.
NotificationInitialize ( ) : void	Notification initialize.
OpenFolder ( ulong folderId, uint &tableHandle ) : RopOpenFolderResponse	Opens an existing folder in a mailbox.
OpenMessage ( uint folderHandle, ulong folderId, ulong messageId, uint &messageHandle ) : RopOpenMessageResponse	Open a message in the folder
QueryColumnsAll ( uint tableHandle ) : RopQueryColumnsAllResponse	Gets a list of columns in a table.
QueryPosition ( uint tableHandle ) : RopQueryPositionResponse	Gets the cursor position.
QueryRows ( uint tableHandle, ushort rowCount ) : RopQueryRowsResponse	Retrieves rows from a table.
ResetTable ( uint tableHandle ) : RopResetTableResponse	Resets a table to its original state, see [MS-OXCTABL] section 2.2.2.16.
RestrictTable ( uint tableHandle, byte restriction ) : RopRestrictResponse	Call the RopRestrict ROP ([MS-OXCROPS] section 2.2.5.3) to establish a restriction on a table.
SeekRow ( uint tableHandle, int rowCount ) : RopSeekRowResponse	Moves the cursor to a specific position in a table.
SeekRowBookmark ( uint tableHandle, byte bookmark, int rowCount ) : RopSeekRowBookmarkResponse	Moves the cursor to a location specified relative to a user-defined bookmark.
SeekRowFractional ( uint tableHandle, uint numerator, uint denominator ) : RopSeekRowFractionalResponse	Moves the cursor to an approximate position in a table.
SetColumns ( uint tableHandle, PropertyTag propertyTags ) : RopSetColumnsResponse	Sets the properties visible on a table.
TestCleanup ( ) : void	Overrides TestClassBase's TestCleanup().
TestInitialize ( ) : void	Overrides TestClassBase's TestInitialize().
TriggerNewMailEvent ( ) : void	Trigger new mail event on server.
TriggerObjectCopiedEvent ( ) : void	Trigger object copied event.
TriggerObjectCreatedEvent ( ) : ulong	Trigger an object create event.
TriggerObjectDeletedEvent ( ) : void	Trigger object deleted event.
TriggerObjectMessageMoveEvent ( ) : void	Trigger object move message event.
TriggerObjectModifiedEvent ( ) : void	Trigger object modified event.
TriggerObjectMovedFolderEvent ( ) : void	Trigger object moved folder event.
TriggerSearchCompletedEvent ( ) : void	Trigger search completed event.
TriggerTableChangedEvent ( ) : void	Trigger table row changed event.
TriggerTableRowAddedEvent ( ) : ulong	Trigger table row added event.
TriggerTableRowDeletedEvent ( ) : void	Trigger table row deleted event.
TriggerTableRowModifiedEvent ( ) : void	Trigger table row modified event.

Private Methods

Method	Description
CleanUpFolder ( ulong folderId ) : void	Delete all message and subfolder of specified folder
CreateFolder ( uint parentFolderHandle, string name, uint &newFolderHandle, FolderType folderType ) : RopCreateFolderResponse	Create a new folder on the server
CreateMessage ( ulong folderId, uint &messageHandle ) : void	Create a new message in the folder
CreateSampleRecipientColumnsAndRecipientRows ( PropertyTag &recipientColumns, ModifyRecipientRow &recipientRows ) : void	This method creates Sample RecipientColumns and Sample RecipientRows.
DeleteFolder ( ulong folderId, uint parentFolderHandle ) : void	Delete a folder in the mailbox
DeleteMessage ( uint folderHandle, ulong messageId ) : void	Delete specified message in the folder
HardDeleteMessagesAndSubfolders ( uint folderHandle ) : void	Hard delete all messages and subfolder in specified folder
ModifyRecipients ( uint messageHandle, PropertyTag recipientColumns, ModifyRecipientRow recipientRows ) : void	Modify the recipients on the message
MoveCopyMessage ( uint fromFolderHandle, uint toFolderHandle, ulong messageId, bool wantCopy ) : RopMoveCopyMessagesResponse	Move or copy a message on the server
MoveFolder ( ulong folderId, string newFolderName, uint sourceFolderHandle, uint destFolderHandle ) : RopMoveFolderResponse	Move the folder into another folder
ReleaseHandle ( uint handle ) : void	Release the handle resource.
SaveMessage ( uint messageHandle ) : RopSaveChangesMessageResponse	Save the changes made on the message
SetSearchCriteria ( uint searchFolderHandle, ulong folderIds, byte restrictionData ) : RopSetSearchCriteriaResponse	Sets the search criteria on a search folder
SubmitMessage ( uint messageHandle ) : void	Submit the message
SwitchRPCContextToReceiver ( ) : void	In order to get the notification from the server, need create event in one RPC connection context and get the event notification from the other RPC connection context. This method only used to change the RPC Context from the sender RPC connection context to the receiver RPC connection context. When use MAPIHTTP as transport the connection context won't be changed.
SwitchRPCContextToSender ( ) : void	In order to get the notification from the server, need create event in one RPC connection context and get the event notification from the other RPC connection context. This method only used to change the RPC Context from the receiver RPC connection context to the sender RPC connection context. When use MAPIHTTP as transport the connection context won't be changed.

Method Details

CheckWhetherSupportMAPIHTTP() protected method

Check whether support MS-OXCMAPIHTTP transport.

protected CheckWhetherSupportMAPIHTTP ( ) : void
return	void

CreateBookmark() protected method

Marks the current cursor position in a table.

protected CreateBookmark ( uint tableHandle ) : RopCreateBookmarkResponse
tableHandle	uint	Represents the table handle for this operation.
return	RopCreateBookmarkResponse

ExpandRow() protected method

This ROP expands a categorized row, see [MS-OXCTABL] section 2.2.2.17.

protected ExpandRow ( uint tableHandle, ushort maxRowCount, ulong categoryId ) : RopExpandRowResponse
tableHandle	uint	Represents the table handle for this operation.
maxRowCount	ushort	Maximum number of expanded rows to return data for.
categoryId	ulong	specifies the category to be expanded
return	Microsoft.Protocols.TestSuites.Common.RopExpandRowResponse

FindRow() protected method

Moves the cursor to a row in a table that matches specific search criteria.

protected FindRow ( uint tableHandle, byte restrictionData ) : RopFindRowResponse
tableHandle	uint	Represents the table handle for this operation.
restrictionData	byte	The restriction specifies the filter for this operation.
return	Microsoft.Protocols.TestSuites.Common.RopFindRowResponse

GetContentsTable() protected method

Gets the content table of a container.

protected GetContentsTable ( uint tableHandle, uint &contentTableHandle, bool disableNotification ) : RopGetContentsTableResponse
tableHandle	uint	Represents the table handle for this operation.
contentTableHandle	uint	Content Table Handle.
disableNotification	bool	Set to true if want to disable table notification
return	Microsoft.Protocols.TestSuites.Common.RopGetContentsTableResponse

GetPropertiesSpecific() protected method

This ROP gets specific properties of a message.

protected GetPropertiesSpecific ( uint objHandle, PropertyTag propertyTags ) : RopGetPropertiesSpecificResponse
objHandle	uint	This index specifies the location in the Server object handle table where the handle for the input Server object is stored.
propertyTags	Microsoft.Protocols.TestSuites.Common.PropertyTag	This field specifies the properties requested.
return	Microsoft.Protocols.TestSuites.Common.RopGetPropertiesSpecificResponse

NotificationInitialize() protected method

Notification initialize.

protected NotificationInitialize ( ) : void
return	void

OpenFolder() protected method

Opens an existing folder in a mailbox.

protected OpenFolder ( ulong folderId, uint &tableHandle ) : RopOpenFolderResponse
folderId	ulong	The Id of the folder which want to open.
tableHandle	uint	Return the table handle that will be used in other operation.
return	Microsoft.Protocols.TestSuites.Common.RopOpenFolderResponse

OpenMessage() protected method

Open a message in the folder

protected OpenMessage ( uint folderHandle, ulong folderId, ulong messageId, uint &messageHandle ) : RopOpenMessageResponse
folderHandle	uint	The folder handle
folderId	ulong	The folder ID
messageId	ulong	The message ID
messageHandle	uint	The message handle
return	Microsoft.Protocols.TestSuites.Common.RopOpenMessageResponse

QueryColumnsAll() protected method

Gets a list of columns in a table.

protected QueryColumnsAll ( uint tableHandle ) : RopQueryColumnsAllResponse
tableHandle	uint	Represents the table handle for this operation.
return	Microsoft.Protocols.TestSuites.Common.RopQueryColumnsAllResponse

QueryPosition() protected method

Gets the cursor position.

protected QueryPosition ( uint tableHandle ) : RopQueryPositionResponse
tableHandle	uint	Represents the table handle for this operation.
return	Microsoft.Protocols.TestSuites.Common.RopQueryPositionResponse

QueryRows() protected method

Retrieves rows from a table.

protected QueryRows ( uint tableHandle, ushort rowCount ) : RopQueryRowsResponse
tableHandle	uint	Represents the table handle for this operation.
rowCount	ushort	Specifies the number of requested rows.
return	Microsoft.Protocols.TestSuites.Common.RopQueryRowsResponse

ResetTable() protected method

Resets a table to its original state, see [MS-OXCTABL] section 2.2.2.16.

protected ResetTable ( uint tableHandle ) : RopResetTableResponse
tableHandle	uint	Represents the table handle for this operation.
return	Microsoft.Protocols.TestSuites.Common.RopResetTableResponse

RestrictTable() protected method

Call the RopRestrict ROP ([MS-OXCROPS] section 2.2.5.3) to establish a restriction on a table.

protected RestrictTable ( uint tableHandle, byte restriction ) : RopRestrictResponse
tableHandle	uint	The table handle for this operation.
restriction	byte	The restriction data
return	Microsoft.Protocols.TestSuites.Common.RopRestrictResponse

SeekRow() protected method

Moves the cursor to a specific position in a table.

protected SeekRow ( uint tableHandle, int rowCount ) : RopSeekRowResponse
tableHandle	uint	Represents the table handle for this operation.
rowCount	int	Specifies the direction and the number of rows to seek.
return	Microsoft.Protocols.TestSuites.Common.RopSeekRowResponse

SeekRowBookmark() protected method

Moves the cursor to a location specified relative to a user-defined bookmark.

protected SeekRowBookmark ( uint tableHandle, byte bookmark, int rowCount ) : RopSeekRowBookmarkResponse
tableHandle	uint	Represents the table handle for this operation.
bookmark	byte	Specifies the origin for the seek operation.
rowCount	int	Specifies the direction and the number of rows to seek.
return	Microsoft.Protocols.TestSuites.Common.RopSeekRowBookmarkResponse

SeekRowFractional() protected method

Moves the cursor to an approximate position in a table.

protected SeekRowFractional ( uint tableHandle, uint numerator, uint denominator ) : RopSeekRowFractionalResponse
tableHandle	uint	Represents the table handle for this operation.
numerator	uint	Represents the numerator of the fraction identifying the table position to seek to.
denominator	uint	Represents the denominator of the fraction identifying the table position to seek to.
return	Microsoft.Protocols.TestSuites.Common.RopSeekRowFractionalResponse

SetColumns() protected method

Sets the properties visible on a table.

protected SetColumns ( uint tableHandle, PropertyTag propertyTags ) : RopSetColumnsResponse
tableHandle	uint	Represents the table handle for this operation.
propertyTags	Microsoft.Protocols.TestSuites.Common.PropertyTag	Specifies the property values that are visible in table rows.
return	Microsoft.Protocols.TestSuites.Common.RopSetColumnsResponse

TestCleanup() protected method

Overrides TestClassBase's TestCleanup().

protected TestCleanup ( ) : void
return	void

TestInitialize() protected method

Overrides TestClassBase's TestInitialize().

protected TestInitialize ( ) : void
return	void

TriggerNewMailEvent() protected method

Trigger new mail event on server.

protected TriggerNewMailEvent ( ) : void
return	void

TriggerObjectCopiedEvent() protected method

Trigger object copied event.

protected TriggerObjectCopiedEvent ( ) : void
return	void

TriggerObjectCreatedEvent() protected method

Trigger an object create event.

protected TriggerObjectCreatedEvent ( ) : ulong
return	ulong

TriggerObjectDeletedEvent() protected method

Trigger object deleted event.

protected TriggerObjectDeletedEvent ( ) : void
return	void

TriggerObjectMessageMoveEvent() protected method

Trigger object move message event.

protected TriggerObjectMessageMoveEvent ( ) : void
return	void

TriggerObjectModifiedEvent() protected method

Trigger object modified event.

protected TriggerObjectModifiedEvent ( ) : void
return	void

TriggerObjectMovedFolderEvent() protected method

Trigger object moved folder event.

protected TriggerObjectMovedFolderEvent ( ) : void
return	void

TriggerSearchCompletedEvent() protected method

Trigger search completed event.

protected TriggerSearchCompletedEvent ( ) : void
return	void

TriggerTableChangedEvent() protected method

Trigger table row changed event.

protected TriggerTableChangedEvent ( ) : void
return	void

TriggerTableRowAddedEvent() protected method

Trigger table row added event.

protected TriggerTableRowAddedEvent ( ) : ulong
return	ulong

TriggerTableRowDeletedEvent() protected method

Trigger table row deleted event.

protected TriggerTableRowDeletedEvent ( ) : void
return	void

TriggerTableRowModifiedEvent() protected method

Trigger table row modified event.

protected TriggerTableRowModifiedEvent ( ) : void
return	void