C# Class Microsoft.Protocols.TestSuites.MS_WEBSS.MS_WEBSSAdapter

This class provides the methods to verify requirements.

Show file Open project: OfficeDev/Interop-TestSuites

Public Methods

Method	Description
CreateContentType ( string displayName, string parentType, AddOrUpdateFieldsDefinition newFields, CreateContentTypeContentTypeProperties contentTypeProperties ) : string	This operation is used to create a new content type on the context site
CustomizeCss ( string cssFile ) : void	This operation is used to enable customization of the specified cascading style sheet (CSS) for the context site.
DeleteContentType ( string contentTypeId ) : DeleteContentTypeResponseDeleteContentTypeResult	This operation is used to remove a given content type from the site.
GetActivatedFeatures ( ) : string	This operation is used to get a list of activated features on the site and on the parent site collection.
GetAllSubWebCollection ( ) : GetAllSubWebCollectionResponseGetAllSubWebCollectionResult	This operation is used to get a list of the titles and URLs of all sites in the site collection.
GetColumns ( ) : GetColumnsResponseGetColumnsResult	This operation is used to get the collection of column definitions for all the columns available on the context site.
GetContentType ( string contentTypeId ) : GetContentTypeResponseGetContentTypeResult	This operation is used to get the collection of column definitions for all the columns available on the context site.
GetContentTypes ( ) : GetContentTypesResponseGetContentTypesResult	This method retrieves all content types for a given context site.
GetCustomizedPageStatus ( string fileUrl ) : CustomizedPageStatus	This operation is used to get the customization status (also known as the ghosted status) of the specified page or file.
GetListTemplates ( ) : GetListTemplatesResponseGetListTemplatesResult	This operation is used to get the collection of list template definitions for the context site.
GetObjectIdFromUrl ( string objectUrl ) : GetObjectIdFromUrlResponseGetObjectIdFromUrlResult	This operation obtains properties of the object referenced by the specified URL.
GetWeb ( string webUrl ) : GetWebResponseGetWebResult	This operation is used to get the Title, URL, Description, Language, and theme properties of the specified site.
GetWebCollection ( ) : GetWebCollectionResponseGetWebCollectionResult	This operation is used to get the Title and URL properties of all immediate child sites of the context site.
Initialize ( ITestSite testSite ) : void	Overrides IAdapter's Initialize() and sets default protocol short name of the testSite.
InitializeService ( TransportProtocol transportType, SoapProtocolVersion soapVersion, UserAuthentication userAuthentication, string serverRelativeUrl ) : void	Initializes the services of MS-WEBSS with the specified transport type, soap version and user authentication provided by the test case.
InitializeService ( UserAuthentication userAuthentication ) : void	Initialize the services of WEBSS with the specified transport type, soap version and user authentication provided by the test case.
RemoveContentTypeXmlDocument ( string contentTypeId, string documentUri ) : RemoveContentTypeXmlDocumentResponseRemoveContentTypeXmlDocumentResult	This operation is used to remove an XML document in the XML document collection of a site content type.
RevertAllFileContentStreams ( ) : void	This operation is used to revert all pages within the context site to their original states.
RevertCss ( string cssFile ) : void	This operation is used to revert the customizations of the context site defined by the given CSS file and return those customizations to the default style.
RevertFileContentStream ( string fileUrl ) : void	This operation is used to revert the specified page within the context site to its original state.
UpdateColumns ( UpdateColumnsMethod newFields, UpdateColumnsMethod1 updateFields, UpdateColumnsMethod2 deleteFields ) : UpdateColumnsResponseUpdateColumnsResult	This operation is used to perform the following operation on the context site and all child sites within its hierarchy Adding one or more specified new columns Updating one or more specified existing columns Deleting one or more specified existing columns
UpdateContentType ( string contentTypeId, UpdateContentTypeContentTypeProperties contentTypeProperties, AddOrUpdateFieldsDefinition newFields, AddOrUpdateFieldsDefinition updateFields, DeleteFieldsDefinition deleteFields ) : UpdateContentTypeResponseUpdateContentTypeResult	This operation is used to update a content type on the context site.
UpdateContentTypeXmlDocument ( string contentTypeId, XmlElement newDocument ) : UpdateContentTypeXmlDocumentResponseUpdateContentTypeXmlDocumentResult	This operation is used to add or update an XML document in the XML Document collection of a site content type.
WebUrlFromPageUrl ( string pageUrl ) : string	This operation is used to get the URL of the parent site of the specified URL.

Private Methods

Method	Description
CaptureTransportRelatedRequirements ( ) : void	Capture underlying transport protocol related requirements.
HasElement ( XmlElement xmlElement, string elementName ) : bool	Verify if elementName is existed in the specified XmlElement..
ValidateCreateContentType ( ) : void	Capture CreateContentType related requirements.
ValidateCustomizeCss ( ) : void
ValidateDeleteContentType ( ) : void	Capture DeleteContentType related requirements.
ValidateDetail ( XmlNode detail ) : void	This method is used to capture requirements of detail complex type.
ValidateGetActivatedFeatures ( ) : void	This method is used to capture requirements of GetActivatedFeatures operation.
ValidateGetAllSubWebCollection ( GetAllSubWebCollectionResponseGetAllSubWebCollectionResult getAllSubWebCollectionResult ) : void	This method is used to capture requirements of GetAllSubWebCollection operation.
ValidateGetContentTypes ( ) : void	Capture GetContentTypes related requirements.
ValidateGetCustomizedPageStatus ( CustomizedPageStatus customizedPageStatus ) : void	Capture GetCustomizedPageStatus operation related requirements.
ValidateGetListTemplates ( ) : void	Capture GetListTemplates operation related requirements.
ValidateGetObjectIdFromUrl ( GetObjectIdFromUrlResponseGetObjectIdFromUrlResult getObjectIdFromUrlResult ) : void	Capture GetObjectIdFromUrl operation related requirements.
ValidateGetWeb ( GetWebResponseGetWebResult getWebResult ) : void	This method is used to capture requirements of GetWeb operation.
ValidateGetWebCollection ( ) : void	Capture GetWebCollection operation related requirements.
ValidateRemoveContentTypeXmlDocument ( ) : void	Capture RemoveContentTypeXmlDocument related requirements.
ValidateRevertAllFileContentStreams ( ) : void	Capture RevertAllFileContentStreams operation related requirements.
ValidateRevertCss ( ) : void	This method is used to capture requirements of RevertCss operation.
ValidateRevertFileContentStream ( ) : void	Capture RevertFileContentStreams operation related requirements.
ValidateUpdateColumns ( ) : void	Capture UpdateColumns operation related requirements.
ValidateUpdateContentType ( ) : void	Capture UpdateContentType related requirements.
ValidateUpdateContentTypeXmlDocument ( ) : void	Capture UpdateContentTypeXmlDocument related requirements.
ValidateWebDefinition ( WebDefinition web ) : void	This method is used to capture requirements of WebDefinition complex type.
ValidateWebDefinitionForSubWebCollection ( ) : void	This method is used to capture requirements of WebDefinition complex type For Sub Web Collection.
ValidateWebDefinitionForSubWebCollection ( WebDefinition web ) : void	This method is used to capture requirements of WebDefinition complex type For Sub Web Collection.
ValidateWebUrlFromPageUrl ( ) : void	Capture WebUrlFromPageUrl operation related requirements.

Method Details

CreateContentType() public method

This operation is used to create a new content type on the context site

public CreateContentType ( string displayName, string parentType, AddOrUpdateFieldsDefinition newFields, CreateContentTypeContentTypeProperties contentTypeProperties ) : string
displayName	string	displayName means the XML encoded name of content type to be created.
parentType	string	parentType is used to indicate the ID of a content type from which the content type to be created will inherit.
newFields	Microsoft.Protocols.TestSuites.Common.AddOrUpdateFieldsDefinition	newFields is the container for a list of existing fields to be included in the content type.
contentTypeProperties	CreateContentTypeContentTypeProperties	contentTypeProperties is the container for properties to set on the content type.
return	string

CustomizeCss() public method

This operation is used to enable customization of the specified cascading style sheet (CSS) for the context site.

public CustomizeCss ( string cssFile ) : void
cssFile	string	cssFile specifies the name of one of the CSS files that resides in the default, central location on the server.
return	void

DeleteContentType() public method

This operation is used to remove a given content type from the site.

public DeleteContentType ( string contentTypeId ) : DeleteContentTypeResponseDeleteContentTypeResult
contentTypeId	string	contentTypeId is the content type ID of the content type that is to be removed from the site.
return	DeleteContentTypeResponseDeleteContentTypeResult

GetActivatedFeatures() public method

This operation is used to get a list of activated features on the site and on the parent site collection.

public GetActivatedFeatures ( ) : string
return	string

GetAllSubWebCollection() public method

This operation is used to get a list of the titles and URLs of all sites in the site collection.

public GetAllSubWebCollection ( ) : GetAllSubWebCollectionResponseGetAllSubWebCollectionResult
return	GetAllSubWebCollectionResponseGetAllSubWebCollectionResult

GetColumns() public method

This operation is used to get the collection of column definitions for all the columns available on the context site.

public GetColumns ( ) : GetColumnsResponseGetColumnsResult
return	GetColumnsResponseGetColumnsResult

GetContentType() public method

This operation is used to get the collection of column definitions for all the columns available on the context site.

public GetContentType ( string contentTypeId ) : GetContentTypeResponseGetContentTypeResult
contentTypeId	string	contentTypeId is the ID of the content type to be returned.
return	GetContentTypeResponseGetContentTypeResult

GetContentTypes() public method

This method retrieves all content types for a given context site.

public GetContentTypes ( ) : GetContentTypesResponseGetContentTypesResult
return	GetContentTypesResponseGetContentTypesResult

GetCustomizedPageStatus() public method

This operation is used to get the customization status (also known as the ghosted status) of the specified page or file.

public GetCustomizedPageStatus ( string fileUrl ) : CustomizedPageStatus
fileUrl	string	fileUrl is the URL of a page or file on the protocol server.
return	CustomizedPageStatus

GetListTemplates() public method

This operation is used to get the collection of list template definitions for the context site.

public GetListTemplates ( ) : GetListTemplatesResponseGetListTemplatesResult
return	GetListTemplatesResponseGetListTemplatesResult

GetObjectIdFromUrl() public method

This operation obtains properties of the object referenced by the specified URL.

public GetObjectIdFromUrl ( string objectUrl ) : GetObjectIdFromUrlResponseGetObjectIdFromUrlResult
objectUrl	string	The URL of the object to retrieve information.
return	GetObjectIdFromUrlResponseGetObjectIdFromUrlResult

GetWeb() public method

This operation is used to get the Title, URL, Description, Language, and theme properties of the specified site.

public GetWeb ( string webUrl ) : GetWebResponseGetWebResult
webUrl	string	WebUrl is a string that contains the absolute URL of the site.
return	GetWebResponseGetWebResult

GetWebCollection() public method

This operation is used to get the Title and URL properties of all immediate child sites of the context site.

public GetWebCollection ( ) : GetWebCollectionResponseGetWebCollectionResult
return	GetWebCollectionResponseGetWebCollectionResult

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 use ITestSite's function.
return	void

InitializeService() public method

Initializes the services of MS-WEBSS with the specified transport type, soap version and user authentication provided by the test case.

public InitializeService ( TransportProtocol transportType, SoapProtocolVersion soapVersion, UserAuthentication userAuthentication, string serverRelativeUrl ) : void
transportType	TransportProtocol	The type of the connection
soapVersion	SoapProtocolVersion	The soap version of the protocol message
userAuthentication	UserAuthentication	a user authenticated
serverRelativeUrl	string	a Server related URL
return	void

InitializeService() public method

Initialize the services of WEBSS with the specified transport type, soap version and user authentication provided by the test case.

public InitializeService ( UserAuthentication userAuthentication ) : void
userAuthentication	UserAuthentication	a user authenticated
return	void

RemoveContentTypeXmlDocument() public method

This operation is used to remove an XML document in the XML document collection of a site content type.

public RemoveContentTypeXmlDocument ( string contentTypeId, string documentUri ) : RemoveContentTypeXmlDocumentResponseRemoveContentTypeXmlDocumentResult
contentTypeId	string	contentTypeID is the content type ID of the site content type to be modified
documentUri	string	documentUri is the namespace URI of the XML document of the site content type to remove
return	RemoveContentTypeXmlDocumentResponseRemoveContentTypeXmlDocumentResult

RevertAllFileContentStreams() public method

This operation is used to revert all pages within the context site to their original states.

public RevertAllFileContentStreams ( ) : void
return	void

RevertCss() public method

This operation is used to revert the customizations of the context site defined by the given CSS file and return those customizations to the default style.

public RevertCss ( string cssFile ) : void
cssFile	string	cssFile specifies the name of one of the CSS files that resides in the default.
return	void

RevertFileContentStream() public method

This operation is used to revert the specified page within the context site to its original state.

public RevertFileContentStream ( string fileUrl ) : void
fileUrl	string	fileUrl is a string that contains the URL of the page.
return	void

UpdateColumns() public method

This operation is used to perform the following operation on the context site and all child sites within its hierarchy

Adding one or more specified new columns
Updating one or more specified existing columns
Deleting one or more specified existing columns

public UpdateColumns ( UpdateColumnsMethod newFields, UpdateColumnsMethod1 updateFields, UpdateColumnsMethod2 deleteFields ) : UpdateColumnsResponseUpdateColumnsResult
newFields	UpdateColumnsMethod	newFields is an XML element that represents the collection of columns to be added to the context site and all child sites within its hierarchy.
updateFields	UpdateColumnsMethod1	updateFields is an XML element that represents the collection of columns to be updated on the context site and all child sites within its hierarchy
deleteFields	UpdateColumnsMethod2	deleteFields is an XML element that represents the collection of columns to be deleted from the context site and all child sites within its hierarchy
return	UpdateColumnsResponseUpdateColumnsResult

UpdateContentType() public method

This operation is used to update a content type on the context site.

public UpdateContentType ( string contentTypeId, UpdateContentTypeContentTypeProperties contentTypeProperties, AddOrUpdateFieldsDefinition newFields, AddOrUpdateFieldsDefinition updateFields, DeleteFieldsDefinition deleteFields ) : UpdateContentTypeResponseUpdateContentTypeResult
contentTypeId	string	contentTypeID is the ID of the content type to be updated.
contentTypeProperties	UpdateContentTypeContentTypeProperties	properties is the container for properties to set on the content type.
newFields	Microsoft.Protocols.TestSuites.Common.AddOrUpdateFieldsDefinition	newFields is the container for a list of existing fields to be included in the content type.
updateFields	Microsoft.Protocols.TestSuites.Common.AddOrUpdateFieldsDefinition	updateFields is the container for a list of fields to be updated on the content type.
deleteFields	Microsoft.Protocols.TestSuites.Common.DeleteFieldsDefinition	deleteFields is the container for a list of fields to be updated on the content type.
return	UpdateContentTypeResponseUpdateContentTypeResult

UpdateContentTypeXmlDocument() public method

This operation is used to add or update an XML document in the XML Document collection of a site content type.

public UpdateContentTypeXmlDocument ( string contentTypeId, XmlElement newDocument ) : UpdateContentTypeXmlDocumentResponseUpdateContentTypeXmlDocumentResult
contentTypeId	string	contentTypeID is the content type ID of the site content type to be modified.
newDocument	System.Xml.XmlElement	newDocument is the XML document to be added to the site content type XML document collection.
return	UpdateContentTypeXmlDocumentResponseUpdateContentTypeXmlDocumentResult

WebUrlFromPageUrl() public method

This operation is used to get the URL of the parent site of the specified URL.

public WebUrlFromPageUrl ( string pageUrl ) : string
pageUrl	string	PageUrl is a URL use to get its parent page URL.
return	string