C# Class Microsoft.Protocols.TestSuites.MS_OUTSPS.MS_OUTSPSAdapter

This partial class is the container for the adapter capture code.

Inheritance: Microsoft.Protocols.TestTools.ManagedAdapterBase, IMS_OUTSPSAdapter

Show file Open project: OfficeDev/Interop-TestSuites

Public Methods

Method	Description
AddAttachment ( string listName, string listItemId, string fileName, byte attachment ) : string	The AddAttachment operation is used to add an attachment to the specified list item in the specified list.
AddDiscussionBoardItem ( string listName, byte message ) : AddDiscussionBoardItemResponseAddDiscussionBoardItemResult	AddDiscussionBoardItem operation is used to add new discussion items to a specified discussion board.
AddList ( string listName, string description, int templateId ) : AddListResponseAddListResult	Add a list in the current site based on the specified name, description, and list template identifier.
DeleteAttachment ( string listName, string listItemId, string url ) : void	The DeleteAttachment operation is used to remove the attachment from the specified list item in the specified list.
DeleteList ( string listName ) : void	The DeleteList operation is used to delete the specified list from the specified site.
GetAttachmentCollection ( string listName, string listItemId ) : GetAttachmentCollectionResponseGetAttachmentCollectionResult	The GetAttachmentCollection operation is used to retrieve information about all the lists on the current site.
GetList ( string listName ) : GetListResponseGetListResult	The GetList operation is used to retrieve properties and fields for a specified list.
GetListItemChanges ( string listName, CamlViewFields viewFields, string since, CamlContains contains ) : GetListItemChangesResponseGetListItemChangesResult	The GetListItemChanges operation is used to retrieve the list items that have been inserted or updated since the specified date and time and matching the specified filter criteria.
GetListItemChangesSinceToken ( string listName, string viewName, GetListItemChangesSinceTokenQuery query, CamlViewFields viewFields, string rowLimit, CamlQueryOptions queryOptions, string changeToken, CamlContains contains ) : GetListItemChangesSinceTokenResponseGetListItemChangesSinceTokenResult	The GetListItemChangesSinceToken operation is used to return changes made to a specified list after the event expressed by the change token, if specified, or to return all the list items in the list.
HTTPGET ( Uri requestResourceUrl, string translateHeaderValue ) : byte[]	This operation used to get resource data Over HTTP protocol directly.
HTTPPUT ( Uri requestResourceUrl, string ifmatchHeader, byte contentData ) : void	This operation used to put content data Over HTTP protocol directly.
Initialize ( ITestSite testSite ) : void	The Overridden Initialize method
UpdateList ( string listName, UpdateListListProperties listProperties, UpdateListFieldsRequest newFields, UpdateListFieldsRequest updateFields, UpdateListFieldsRequest deleteFields, string listVersion ) : UpdateListResponseUpdateListResult	A method used to update list properties and add, remove, or update fields.
UpdateListItems ( string listName, UpdateListItemsUpdates updates ) : UpdateListItemsResponseUpdateListItemsResult	The UpdateListItems operation is used to insert, update, and delete to specified list items in a list.

Private Methods

Method	Description
GetTargetServiceUrl ( ) : string	A method used to Get target service fully qualified URL, it indicates which site the test suite will run on.
SetSoapVersion ( ) : void	Set the SOAP version according to the SoapVersion property.
VerifyCommonSchemaOfListDefinition ( GetListResponseGetListResult responseOfGetList ) : void	A method used to verify the requirements for common schema definition of list.
VerifyGetListItemChangesSinceTokenResponse ( GetListItemChangesSinceTokenResponseGetListItemChangesSinceTokenResult responseOfGetGetListItemChangesSinceToken ) : void	A method used to verify response of GetGetListItemChangesSinceToken operation and capture related requirements.
VerifyTransportRequirement ( ) : void	A method used to capture transport related requirements according to the current transport protocol the test suite use.
VerifyTypeAndIdForFieldDefinition ( GetListResponseGetListResult responseOfGetList, string expectedFieldName, string expectedFieldId, string expectedFieldType ) : bool	A method used to verify field's id or field's type is equal to expected value.

Method Details

AddAttachment() public method

The AddAttachment operation is used to add an attachment to the specified list item in the specified list.

public AddAttachment ( string listName, string listItemId, string fileName, byte attachment ) : string
listName	string	The GUID or the list title of the list in which the list item to add attachment.
listItemId	string	The id of the list item in which the attachment will be added.
fileName	string	The name of the file being added as an attachment.
attachment	byte	Content of the attachment file (byte array).
return	string

AddDiscussionBoardItem() public method

AddDiscussionBoardItem operation is used to add new discussion items to a specified discussion board.

public AddDiscussionBoardItem ( string listName, byte message ) : AddDiscussionBoardItemResponseAddDiscussionBoardItemResult
listName	string	The name of the discussion board in which the new item will be added
message	byte	The message to be added to the discussion board. The message MUST be in MIME format and then Base64 encoded
return	AddDiscussionBoardItemResponseAddDiscussionBoardItemResult

AddList() public method

Add a list in the current site based on the specified name, description, and list template identifier.

public AddList ( string listName, string description, int templateId ) : AddListResponseAddListResult
listName	string	The title of the list which will be added.
description	string	Text which will be set as description of newly created list.
templateId	int	The template ID used to create this list.
return	Microsoft.Protocols.TestSuites.Common.AddListResponseAddListResult

DeleteAttachment() public method

The DeleteAttachment operation is used to remove the attachment from the specified list item in the specified list.

public DeleteAttachment ( string listName, string listItemId, string url ) : void
listName	string	The name of the list in which the list item to delete existing attachment.
listItemId	string	The id of the list item from which the attachment will be deleted.
url	string	Absolute URL of the attachment that should be deleted.
return	void

DeleteList() public method

The DeleteList operation is used to delete the specified list from the specified site.

public DeleteList ( string listName ) : void
listName	string	The name of the list which will be deleted
return	void

GetAttachmentCollection() public method

The GetAttachmentCollection operation is used to retrieve information about all the lists on the current site.

public GetAttachmentCollection ( string listName, string listItemId ) : GetAttachmentCollectionResponseGetAttachmentCollectionResult
listName	string	A parameter represents the list name or GUID for returning the result.
listItemId	string	A parameter represents the identifier of the content type which will be collected.
return	GetAttachmentCollectionResponseGetAttachmentCollectionResult

GetList() public method

The GetList operation is used to retrieve properties and fields for a specified list.

public GetList ( string listName ) : GetListResponseGetListResult
listName	string	The name of the list from which information will be got
return	Microsoft.Protocols.TestSuites.Common.GetListResponseGetListResult

GetListItemChanges() public method

The GetListItemChanges operation is used to retrieve the list items that have been inserted or updated since the specified date and time and matching the specified filter criteria.

public GetListItemChanges ( string listName, CamlViewFields viewFields, string since, CamlContains contains ) : GetListItemChangesResponseGetListItemChangesResult
listName	string	The name of the list from which the list item changes will be got
viewFields	Microsoft.Protocols.TestSuites.Common.CamlViewFields	Indicates which fields of the list item SHOULD be returned
since	string	The date and time to start retrieving changes in the list /// If the parameter is null, protocol server should return all list items /// If the date that is passed in is not in UTC format, protocol server will use protocol server's local time zone and convert it to UTC time
contains	Microsoft.Protocols.TestSuites.Common.CamlContains	Restricts the results returned by giving a specific value to be searched for in the specified list item field
return	GetListItemChangesResponseGetListItemChangesResult

GetListItemChangesSinceToken() public method

The GetListItemChangesSinceToken operation is used to return changes made to a specified list after the event expressed by the change token, if specified, or to return all the list items in the list.

public GetListItemChangesSinceToken ( string listName, string viewName, GetListItemChangesSinceTokenQuery query, CamlViewFields viewFields, string rowLimit, CamlQueryOptions queryOptions, string changeToken, CamlContains contains ) : GetListItemChangesSinceTokenResponseGetListItemChangesSinceTokenResult
listName	string	The name of the list from which version collection will be got
viewName	string	The GUID refers to a view of the list
query	GetListItemChangesSinceTokenQuery	The query to determine which records from the list are to be /// returned and the order in which they will be returned
viewFields	Microsoft.Protocols.TestSuites.Common.CamlViewFields	Specifies which fields of the list item will be returned
rowLimit	string	Indicate the maximum number of rows of data to return
queryOptions	Microsoft.Protocols.TestSuites.Common.CamlQueryOptions	Specifies various options for modifying the query
changeToken	string	Assigned a string comprising a token returned by a previous /// call to this operation.
contains	Microsoft.Protocols.TestSuites.Common.CamlContains	Specifies a value to search for
return	GetListItemChangesSinceTokenResponseGetListItemChangesSinceTokenResult

HTTPGET() public method

This operation used to get resource data Over HTTP protocol directly.

public HTTPGET ( Uri requestResourceUrl, string translateHeaderValue ) : byte[]
requestResourceUrl	System.Uri	A parameter represents the resource where get data over HTTP protocol.
translateHeaderValue	string	A parameter represents the translate header which is used in HTTP request.
return	byte[]

HTTPPUT() public method

This operation used to put content data Over HTTP protocol directly.

public HTTPPUT ( Uri requestResourceUrl, string ifmatchHeader, byte contentData ) : void
requestResourceUrl	System.Uri	A parameter represents the resource where put the data over HTTP protocol.
ifmatchHeader	string	>A parameter represents the IF-MATCH header which is used in HTTP request.
contentData	byte	>A parameter represents the content data which is put to the SUT.
return	void

Initialize() public method

The Overridden Initialize method

public Initialize ( ITestSite testSite ) : void
testSite	ITestSite	The ITestSite member of ManagedAdapterBase
return	void

UpdateList() public method

A method used to update list properties and add, remove, or update fields.

public UpdateList ( string listName, UpdateListListProperties listProperties, UpdateListFieldsRequest newFields, UpdateListFieldsRequest updateFields, UpdateListFieldsRequest deleteFields, string listVersion ) : UpdateListResponseUpdateListResult
listName	string	A parameter represents the name of the list which will be updated.
listProperties	Microsoft.Protocols.TestSuites.Common.UpdateListListProperties	A parameter represents the properties of the specified list.
newFields	Microsoft.Protocols.TestSuites.Common.UpdateListFieldsRequest	A parameter represents new fields which are added to the list.
updateFields	Microsoft.Protocols.TestSuites.Common.UpdateListFieldsRequest	A parameter represents the fields which are updated in the list.
deleteFields	Microsoft.Protocols.TestSuites.Common.UpdateListFieldsRequest	A parameter represents the fields which are deleted from the list.
listVersion	string	A parameter represents an integer format string that specifies the current version of the list.
return	Microsoft.Protocols.TestSuites.Common.UpdateListResponseUpdateListResult

UpdateListItems() public method

The UpdateListItems operation is used to insert, update, and delete to specified list items in a list.

public UpdateListItems ( string listName, UpdateListItemsUpdates updates ) : UpdateListItemsResponseUpdateListItemsResult
listName	string	The name of the list for which list items will be updated
updates	UpdateListItemsUpdates	Specifies the operations to perform on a list item
return	UpdateListItemsResponseUpdateListItemsResult