C# Class Microsoft.Protocols.TestSuites.MS_VIEWSS.MS_VIEWSSAdapter

The Adapter class of MS-VIEWSS

Inheritance: Microsoft.Protocols.TestTools.ManagedAdapterBase, IMS_VIEWSSAdapter

显示文件 Open project: OfficeDev/Interop-TestSuites

Private Properties

Property	Type	Description
CaptureTransportRelatedRequirements	void
IsErrorCodeHexadecimal	bool
IsServerRelativeUrl	bool
LoadCommonConfiguration	void
SetSoapVersion	void
ValidateAddViewResult	void
ValidateBriefViewDefinition	void
ValidateDeleteViewResult	void
ValidateFormats	void
ValidateGetViewCollectionResult	void
ValidateGetViewHtmlResult	void
ValidateGetViewResult	void
ValidateQuery	void
ValidateRowLimit	void
ValidateSOAPFaultDetails	void
ValidateUpdateViewHtml2Result	void
ValidateUpdateViewHtmlResult	void
ValidateUpdateViewResult	void
ValidateViewDefinition	void
ValidateViewFields	void

Public Methods

Method	Description
AddView ( string listName, string viewName, AddViewViewFields viewFields, AddViewQuery query, AddViewRowLimit rowLimit, string type, bool makeViewDefault ) : AddViewResponseAddViewResult	This operation is used to create a list view for the specified list.
DeleteView ( string listName, string viewName ) : void	This operation is used to delete the specified list view of the specified list.
GetView ( string listName, string viewName ) : GetViewResponseGetViewResult	This operation is used to obtain details of a specified list view of the specified list.
GetViewCollection ( string listName ) : GetViewCollectionResponseGetViewCollectionResult	This operation is used to retrieve the collection of list views of a specified list.
GetViewHtml ( string listName, string viewName ) : GetViewHtmlResponseGetViewHtmlResult	This operation is used to obtain details of a specified list view of the specified list, including display properties in CAML and HTML.
Initialize ( ITestSite testSite ) : void	Overrides IAdapter's Initialize method, to set default protocol short name of the testSite.
UpdateView ( string listName, string viewName, UpdateViewViewProperties viewProperties, UpdateViewQuery query, UpdateViewViewFields viewFields, UpdateViewAggregations aggregations, UpdateViewFormats formats, UpdateViewRowLimit rowLimit ) : UpdateViewResponseUpdateViewResult	This operation is used to update the specified list view, without the display properties.
UpdateViewHtml ( string listName, string viewName, UpdateViewHtmlViewProperties viewProperties, UpdateViewHtmlToolbar toolbar, UpdateViewHtmlViewHeader viewHeader, UpdateViewHtmlViewBody viewBody, UpdateViewHtmlViewFooter viewFooter, UpdateViewHtmlViewEmpty viewEmpty, UpdateViewHtmlRowLimitExceeded rowLimitExceeded, UpdateViewHtmlQuery query, UpdateViewHtmlViewFields viewFields, UpdateViewHtmlAggregations aggregations, UpdateViewHtmlFormats formats, UpdateViewHtmlRowLimit rowLimit ) : UpdateViewHtmlResponseUpdateViewHtmlResult	This operation is used to update a list view for a specified list, including display properties in CAML and HTML.
UpdateViewHtml2 ( string listName, string viewName, UpdateViewHtml2ViewProperties viewProperties, UpdateViewHtml2Toolbar toolbar, UpdateViewHtml2ViewHeader viewHeader, UpdateViewHtml2ViewBody viewBody, UpdateViewHtml2ViewFooter viewFooter, UpdateViewHtml2ViewEmpty viewEmpty, UpdateViewHtml2RowLimitExceeded rowLimitExceeded, UpdateViewHtml2Query query, UpdateViewHtml2ViewFields viewFields, UpdateViewHtml2Aggregations aggregations, UpdateViewHtml2Formats formats, UpdateViewHtml2RowLimit rowLimit, string openApplicationExtension ) : UpdateViewHtml2ResponseUpdateViewHtml2Result	This operation is used to obtain details of a specified list view of the specified list, including display properties in CAML and HTML.

Private Methods

Method	Description
CaptureTransportRelatedRequirements ( ) : void	Capture underlying transport protocol related requirements.
IsErrorCodeHexadecimal ( string errorcode ) : bool	Used to validate the schema of error code
IsServerRelativeUrl ( string url ) : bool	Used to judge whether a string is a server relative URL.
LoadCommonConfiguration ( ) : void	A method used to load Common Configuration
SetSoapVersion ( ) : void	Set the SOAP version according to the SoapVersion property.
ValidateAddViewResult ( AddViewResponseAddViewResult addViewResult ) : void	Used to validate the AddView result related requirements.
ValidateBriefViewDefinition ( BriefViewDefinition view ) : void	Used to validate the Brief View Definition related requirement.
ValidateDeleteViewResult ( ) : void	Used to validate the DeleteView result.
ValidateFormats ( ViewFormatDefinitions formats ) : void	Used to validate the Formats
ValidateGetViewCollectionResult ( GetViewCollectionResponseGetViewCollectionResult getViewCollectionResult ) : void	Used to validate the GetViewCollection result.
ValidateGetViewHtmlResult ( GetViewHtmlResponseGetViewHtmlResult getViewHtmlResult ) : void	Used to validate the GetViewHtml result.
ValidateGetViewResult ( GetViewResponseGetViewResult getViewResult ) : void	Used to validate the GetView result.
ValidateQuery ( CamlQueryRoot queryRoot ) : void	Used to validate the available query information related requirements.
ValidateRowLimit ( ) : void	Validate View's RowLimit element related requirements.
ValidateSOAPFaultDetails ( XmlNode detail ) : void	This method is used to capture requirements of SOAPFaultDetails complex type.
ValidateUpdateViewHtml2Result ( UpdateViewHtml2ResponseUpdateViewHtml2Result updateViewHtml2Result ) : void	Used to validate the UpdateViewHtml2 result.
ValidateUpdateViewHtmlResult ( UpdateViewHtmlResponseUpdateViewHtmlResult updateViewHtmlResult ) : void	Used to validate the UpdateViewHtml result.
ValidateUpdateViewResult ( UpdateViewResponseUpdateViewResult updateViewResult ) : void	Used to validate the UpdateView result.
ValidateViewDefinition ( ViewDefinition view ) : void	Used to validate the View Definition
ValidateViewFields ( ) : void	Validate View's Fields element related requirements.

Method Details

AddView() public method

This operation is used to create a list view for the specified list.

public AddView ( string listName, string viewName, AddViewViewFields viewFields, AddViewQuery query, AddViewRowLimit rowLimit, string type, bool makeViewDefault ) : AddViewResponseAddViewResult
listName	string	Specify a list on the server.
viewName	string	Specify a list view on the server.
viewFields	AddViewViewFields	Specify the fields included in a list view.
query	AddViewQuery	Include the information that affects how a list view displays the data.
rowLimit	AddViewRowLimit	Specify whether a list supports displaying items page-by-page, and the count of items a list view displays per page.
type	string	Specify the type of a list view.
makeViewDefault	bool	Specify whether to make the list view the default list view for the specified list.
return	AddViewResponseAddViewResult

DeleteView() public method

This operation is used to delete the specified list view of the specified list.

public DeleteView ( string listName, string viewName ) : void
listName	string	Specify a list on the server.
viewName	string	Specify a list view on the server.
return	void

GetView() public method

This operation is used to obtain details of a specified list view of the specified list.

public GetView ( string listName, string viewName ) : GetViewResponseGetViewResult
listName	string	Specify a list on the server.
viewName	string	Specify a list view on the server.
return	GetViewResponseGetViewResult

GetViewCollection() public method

This operation is used to retrieve the collection of list views of a specified list.

public GetViewCollection ( string listName ) : GetViewCollectionResponseGetViewCollectionResult
listName	string	Specify a list on the server.
return	GetViewCollectionResponseGetViewCollectionResult

GetViewHtml() public method

This operation is used to obtain details of a specified list view of the specified list, including display properties in CAML and HTML.

public GetViewHtml ( string listName, string viewName ) : GetViewHtmlResponseGetViewHtmlResult
listName	string	Specify a list on the server.
viewName	string	Specify a list view on the server.
return	GetViewHtmlResponseGetViewHtmlResult

Initialize() public method

Overrides IAdapter's Initialize method, to set default protocol short name of the testSite.

public Initialize ( ITestSite testSite ) : void
testSite	ITestSite	A parameter represents a ITestSite instance which is used to get/operate current test suite context.
return	void

UpdateView() public method

This operation is used to update the specified list view, without the display properties.

public UpdateView ( string listName, string viewName, UpdateViewViewProperties viewProperties, UpdateViewQuery query, UpdateViewViewFields viewFields, UpdateViewAggregations aggregations, UpdateViewFormats formats, UpdateViewRowLimit rowLimit ) : UpdateViewResponseUpdateViewResult
listName	string	Specify a list on the server.
viewName	string	Specify a list view on the server.
viewProperties	UpdateViewViewProperties	Specify the properties of a list view on the server.
query	UpdateViewQuery	Include the information that affects how a list view displays the data.
viewFields	UpdateViewViewFields	Specify the fields included in a list view.
aggregations	UpdateViewAggregations	The type of the aggregation.
formats	UpdateViewFormats	Specify the row and column formatting of a list view.
rowLimit	UpdateViewRowLimit	Specify whether a list supports displaying items page-by-page, and the count of items a list view displays per page.
return	UpdateViewResponseUpdateViewResult

UpdateViewHtml() public method

This operation is used to update a list view for a specified list, including display properties in CAML and HTML.

public UpdateViewHtml ( string listName, string viewName, UpdateViewHtmlViewProperties viewProperties, UpdateViewHtmlToolbar toolbar, UpdateViewHtmlViewHeader viewHeader, UpdateViewHtmlViewBody viewBody, UpdateViewHtmlViewFooter viewFooter, UpdateViewHtmlViewEmpty viewEmpty, UpdateViewHtmlRowLimitExceeded rowLimitExceeded, UpdateViewHtmlQuery query, UpdateViewHtmlViewFields viewFields, UpdateViewHtmlAggregations aggregations, UpdateViewHtmlFormats formats, UpdateViewHtmlRowLimit rowLimit ) : UpdateViewHtmlResponseUpdateViewHtmlResult
listName	string	Specify a list on the server.
viewName	string	Specify a list view on the server.
viewProperties	UpdateViewHtmlViewProperties	Specify the properties of a list view on the server.
toolbar	UpdateViewHtmlToolbar	Specify the rendering of the toolbar of a list.
viewHeader	UpdateViewHtmlViewHeader	Specify the rendering of the header, or the top of a list view page.
viewBody	UpdateViewHtmlViewBody	Specify the rendering of the main, or the middle portion of a list view page.
viewFooter	UpdateViewHtmlViewFooter	Specify the rendering of the footer, or the bottom of a list view page.
viewEmpty	UpdateViewHtmlViewEmpty	Specify the message to be displayed when no items are in a list view.
rowLimitExceeded	UpdateViewHtmlRowLimitExceeded	Specify rendering of additional items when the number of items exceeds the value.
query	UpdateViewHtmlQuery	Include the information that affects how a list view displays the data.
viewFields	UpdateViewHtmlViewFields	Specify the fields included in a list view.
aggregations	UpdateViewHtmlAggregations	The type of the aggregation.
formats	UpdateViewHtmlFormats	Specify the row and column formatting of a list view.
rowLimit	UpdateViewHtmlRowLimit	Specify whether a list supports displaying items page-by-page, and the count of items a list view displays per page.
return	UpdateViewHtmlResponseUpdateViewHtmlResult

UpdateViewHtml2() public method

This operation is used to obtain details of a specified list view of the specified list, including display properties in CAML and HTML.

public UpdateViewHtml2 ( string listName, string viewName, UpdateViewHtml2ViewProperties viewProperties, UpdateViewHtml2Toolbar toolbar, UpdateViewHtml2ViewHeader viewHeader, UpdateViewHtml2ViewBody viewBody, UpdateViewHtml2ViewFooter viewFooter, UpdateViewHtml2ViewEmpty viewEmpty, UpdateViewHtml2RowLimitExceeded rowLimitExceeded, UpdateViewHtml2Query query, UpdateViewHtml2ViewFields viewFields, UpdateViewHtml2Aggregations aggregations, UpdateViewHtml2Formats formats, UpdateViewHtml2RowLimit rowLimit, string openApplicationExtension ) : UpdateViewHtml2ResponseUpdateViewHtml2Result
listName	string	Specify a list on the server.
viewName	string	Specify a list view on the server.
viewProperties	UpdateViewHtml2ViewProperties	Specify the properties of a list view on the server.
toolbar	UpdateViewHtml2Toolbar	Specify the rendering of the toolbar of a list.
viewHeader	UpdateViewHtml2ViewHeader	Specify the rendering of the header, or the top of a list view page.
viewBody	UpdateViewHtml2ViewBody	Specify the rendering of the main, or the middle portion of a list view page.
viewFooter	UpdateViewHtml2ViewFooter	Specify the rendering of the footer, or the bottom of a list view page.
viewEmpty	UpdateViewHtml2ViewEmpty	Specify the message to be displayed when no items are in a list view.
rowLimitExceeded	UpdateViewHtml2RowLimitExceeded	Specify rendering of additional items when the number of items exceeds the value.
query	UpdateViewHtml2Query	Include the information that affects how a list view displays the data.
viewFields	UpdateViewHtml2ViewFields	Specify the fields included in a list view.
aggregations	UpdateViewHtml2Aggregations	The type of the aggregation.
formats	UpdateViewHtml2Formats	Specify the row and column formatting of a list view.
rowLimit	UpdateViewHtml2RowLimit	Specify whether a list supports displaying items page-by-page, and the count of items a list view displays per page.
openApplicationExtension	string	Specify what kind of application to use to edit the view.
return	UpdateViewHtml2ResponseUpdateViewHtml2Result