C# Class Microsoft.Protocols.TestSuites.MS_SITESS.MS_SITESSAdapter

Adapter class of MS-SITESS.

Inheritance: Microsoft.Protocols.TestTools.ManagedAdapterBase, IMS_SITESSAdapter

Show file Open project: OfficeDev/Interop-TestSuites

Public Methods

Method	Description
CreateWeb ( string url, string title, string description, string templateName, uint language, bool languageSpecified, uint locale, bool localeSpecified, uint collationLocale, bool collationLocaleSpecified, bool uniquePermissions, bool uniquePermissionsSpecified, bool anonymous, bool anonymousSpecified, bool presence, bool presenceSpecified ) : CreateWebResponseCreateWebResult	This operation is used to create a new subsite of the current site
DeleteWeb ( string url ) : void	Delete an existing subsite of the current site.
ExportSolution ( string solutionFileName, string title, string description, bool fullReuseExportMode, bool includeWebContent ) : string	This operation is used to export the content related to a site to the solution gallery.
ExportWeb ( string jobName, string webUrl, string dataPath, bool includeSubwebs, bool includeUserSecurity, bool overWrite, int cabSize ) : int	This operation is used to export the content related to a site into one or more content migration package files.
ExportWorkflowTemplate ( string solutionFileName, string title, string description, string workflowTemplateName, string destinationListUrl ) : string	This operation is used to export a workflow template as a site solution to the specified document library.
GetSite ( string siteUrl ) : string	This operation is used to retrieve information about the site collection.
GetSiteTemplates ( uint lcid, Template &templateList ) : uint	This operation is used to retrieve information about the collection of available site templates.
GetUpdatedFormDigest ( ) : string	This operation is used to request renewal of an expired security validation, also known as a message digest.
GetUpdatedFormDigestInformation ( string url ) : FormDigestInformation	This operation is used to request renewal of an expired security validation token, also known as a message digest, and the new security validation token’s expiration time.
ImportWeb ( string jobName, string webUrl, string dataFiles, string logPath, bool includeUserSecurity, bool overWrite ) : int	This operation is used to import a site from one or more content migration package files to a specified URL.
Initialize ( ITestSite testSite ) : void	Overrides IAdapter's Initialize(),to set testSite.DefaultProtocolDocShortName.
InitializeWebService ( UserAuthenticationOption userAuthentication ) : void	This operation is used to initialize sites service with authority information.
IsScriptSafeUrl ( string urls ) : bool[]	This operation is used to validate whether the specified URLs are valid script safe URLs for the current site.

Private Methods

Method	Description
SetLoginUser ( UserAuthenticationOption userAuthentication ) : void	Select associated user account to login the server according to different user authentications.
ValidArrayOfStringComplexType ( ) : void	A method used to validate the ArrayOfString complex type.
VerifyCommonReqs ( ) : void	Verify whether the transport used by this test suite is HTTP or HTTPS, and the soap version is soap 1.1 or soap 1.2.
VerifyCreateWeb ( CreateWebResponseCreateWebResult createWebResult ) : void	Verify CreateWeb related requirements.
VerifyDeleteWeb ( ) : void	Verify VerifyDeleteWeb related requirements.
VerifyExportSolution ( string exportSolutionResultURL ) : void	Verify ExportSolution related requirements.
VerifyExportWeb ( int exportWebResult ) : void	Verify ExportWeb related requirements.
VerifyExportWorkflowTemplate ( string exportWorkflowTemplateResult ) : void	Verify ExportWorkflowTemplate related requirements.
VerifyGetSite ( string getSiteResult ) : void	Verify GetSite related requirements.
VerifyGetSiteTemplates ( Template templateList ) : void	Verify GetSiteTemplates related requirements.
VerifyGetUpdatedFormDigest ( string getUpdateFormDigestResult ) : void	Verify GetUpdatedFormDigest related requirements.
VerifyGetUpdatedFormDigestInformation ( FormDigestInformation getUpdatedFormDigestInfoResult ) : void	Verify GetUpdatedFormDigest related requirements.
VerifyImportWeb ( int importWebResult ) : void	Verify ImportWeb related requirements.
VerifyIsScriptSafeUrl ( Boolean isScriptSafeUrlResult ) : void	Verify IsScriptSafeUrl related requirements.

Method Details

CreateWeb() public method

This operation is used to create a new subsite of the current site

public CreateWeb ( string url, string title, string description, string templateName, uint language, bool languageSpecified, uint locale, bool localeSpecified, uint collationLocale, bool collationLocaleSpecified, bool uniquePermissions, bool uniquePermissionsSpecified, bool anonymous, bool anonymousSpecified, bool presence, bool presenceSpecified ) : CreateWebResponseCreateWebResult
url	string	The site-relative URL of the subsite to be created.
title	string	The display name of the subsite to be created.
description	string	Description of the subsite to be created.
templateName	string	The name of an available site template to be used for the subsite to be created.
language	uint	An LCID that specifies the language of the user interface of the subsite to be created.
languageSpecified	bool	Whether language specified
locale	uint	An LCID that specifies the display format for numbers, dates, times, and currencies in the subsite to be created.
localeSpecified	bool	Whether locale specified.
collationLocale	uint	An LCID that specifies the collation order to use in the subsite to be created.
collationLocaleSpecified	bool	Whether collationLocale specified.
uniquePermissions	bool	Specifies whether the subsite to be created uses its own set of permissions or parent site.
uniquePermissionsSpecified	bool	Whether uniquePermissions specified.
anonymous	bool	Whether the anonymous authentication is to be allowed for the subsite to be created.
anonymousSpecified	bool	Whether anonymous specified.
presence	bool	Whether the online presence information is to be enabled for the subsite to be created.
presenceSpecified	bool	Whether presence specified.
return	CreateWebResponseCreateWebResult

DeleteWeb() public method

Delete an existing subsite of the current site.

public DeleteWeb ( string url ) : void
url	string	The site-relative URL of the subsite to be deleted.
return	void

ExportSolution() public method

This operation is used to export the content related to a site to the solution gallery.

public ExportSolution ( string solutionFileName, string title, string description, bool fullReuseExportMode, bool includeWebContent ) : string
solutionFileName	string	The name of the solution file that will be created.
title	string	The name of the solution.
description	string	Detailed information that describes the solution.
fullReuseExportMode	bool	Specify the scope of data that needs to be exported.
includeWebContent	bool	Specify whether the solution needs to include the contents of all lists and document libraries in the site.
return	string

ExportWeb() public method

This operation is used to export the content related to a site into one or more content migration package files.

public ExportWeb ( string jobName, string webUrl, string dataPath, bool includeSubwebs, bool includeUserSecurity, bool overWrite, int cabSize ) : int
jobName	string	Specifies the operation.
webUrl	string	The URL of the site to export.
dataPath	string	The full path of the location on the server where the content migration package file(s) are saved.
includeSubwebs	bool	Specifies whether to include the subsite.
includeUserSecurity	bool	Specifies whether to include access control list (ACL), security group and membership group information.
overWrite	bool	Specifies whether to overwrite the content migration package file(s) if they exist.
cabSize	int	Indicates the suggested size in megabytes for the content migration package file(s).
return	int

ExportWorkflowTemplate() public method

This operation is used to export a workflow template as a site solution to the specified document library.

public ExportWorkflowTemplate ( string solutionFileName, string title, string description, string workflowTemplateName, string destinationListUrl ) : string
solutionFileName	string	The name of the solution file that will be created.
title	string	The name of the solution.
description	string	Detailed information that describes the solution.
workflowTemplateName	string	The name of the workflow template that is to be exported.
destinationListUrl	string	The server-relative URL of the document library in which the solution file needs to be created.
return	string

GetSite() public method

This operation is used to retrieve information about the site collection.

public GetSite ( string siteUrl ) : string
siteUrl	string	Specifies the absolute URL (Uniform Resource Locator) of a site collection or of a location within a site collection.
return	string

GetSiteTemplates() public method

This operation is used to retrieve information about the collection of available site templates.

public GetSiteTemplates ( uint lcid, Template &templateList ) : uint
lcid	uint	Specifies the language code identifier (LCID).
templateList	Template	SiteTemplates list.
return	uint

GetUpdatedFormDigest() public method

This operation is used to request renewal of an expired security validation, also known as a message digest.

public GetUpdatedFormDigest ( ) : string
return	string

GetUpdatedFormDigestInformation() public method

This operation is used to request renewal of an expired security validation token, also known as a message digest, and the new security validation token’s expiration time.

public GetUpdatedFormDigestInformation ( string url ) : FormDigestInformation
url	string	Specify a page URL with which the returned security validation token information is associated.
return	FormDigestInformation

ImportWeb() public method

This operation is used to import a site from one or more content migration package files to a specified URL.

public ImportWeb ( string jobName, string webUrl, string dataFiles, string logPath, bool includeUserSecurity, bool overWrite ) : int
jobName	string	Specifies the operation.
webUrl	string	The URL of the resulting Web site.
dataFiles	string	The URLs of the content migration package files on the server that the server imports to create the resulting Web site.
logPath	string	The URL where the server places files describing the progress or status of the operation.
includeUserSecurity	bool	Specifies whether or not to include ACL, security group and membership group information in the resulting Web site.
overWrite	bool	Specifies whether or not to overwrite existing files at the location specified by logPath.
return	int

Initialize() public method

Overrides IAdapter's Initialize(),to set testSite.DefaultProtocolDocShortName.

public Initialize ( ITestSite testSite ) : void
testSite	ITestSite	Transfer ITestSite into adapter,Make adapter can use ITestSite's function.
return	void

InitializeWebService() public method

This operation is used to initialize sites service with authority information.

public InitializeWebService ( UserAuthenticationOption userAuthentication ) : void
userAuthentication	UserAuthenticationOption	This parameter used to assign the authentication information of web service.
return	void

IsScriptSafeUrl() public method

This operation is used to validate whether the specified URLs are valid script safe URLs for the current site.

public IsScriptSafeUrl ( string urls ) : bool[]
urls	string	An array of string contains all URLs that need to be validated.
return	bool[]