SPWebService members

Represents a Web service that contains one or more Web applications. This Web service allows a Web browser to access the content in SharePoint sites.

The SPWebService type exposes the following members.

Constructors

  Name Description
Public method SPWebService() Reserved for internal use only.
Public method SPWebService(String, SPFarm) Initialize a new instance of the SPWebService class.

Top

Properties

  Name Description
Public property ActiveDirectoryDomain Gets or sets the domain in which to create Active Directory accounts.
Public property ActiveDirectoryOrganizationalUnit Gets or sets the organizational unit in which to create Active Directory accounts.
Public propertyStatic member AdministrationService Gets the Web service associated with the administration application.
Public property AllowAggregationCalendar Gets or sets flag for allowing aggregation on calendar view
Public property AllowDeclarativeWorkflowAutostartOnEmailAsAuthor
Public property AlternateContentEditorScript Gets or sets the alternate editor script to include in the Content Editor Web Part.
Public property AntivirusSettings Gets the collection of antivirus settings for this service.
Public property AppCacheToken
Public property ApplicationPools Gets the collection of IIS application pools available to this service.
Public property Applications Gets the collection of service applications associated with the service. (Inherited from SPService.)
Public property AutoProvision (Overrides SPService.AutoProvision.)
Public property BackgroundFileSyncThrottlingSettings Controls limits for background file sync requests.
Public property BrowserCEIPEnabled Stores the opt-in status for whether a browser is configured to provide data for the customer experience improvement program (CEIP).
Public property CacheSiteLookup If true, site lookup will be cached.
Public property CanRenameOnRestore Gets a value indicating whether the service can be renamed when it is restored.
Public property CanSelectForBackup Gets or sets a value indicating whether the service can be backed up.
Public property CanSelectForRestore Gets or sets a value that indicates whether the service can be restored.
Public property CanUpgrade Gets a value that indicates whether the object can be upgraded. (Inherited from SPPersistedUpgradableObject.)
Public property CdnPrefix If a CDN is enabled, the string to use as the prefix for generated script and style URLs
Public property ClientRequestServiceSettings The settings for client.svc
Public property CoauthoringMaxAuthors Default value of maximum number of users allowed to coauthor a document at a time
Public property CoauthoringVersionPeriod Minimum time in minutes between new coauthoring versions Versions created during coauthoring will be created no more frequently than this time period.
Public property CollectSPRequestAllocationCallStacks If true, the callstack of every SPRequest allocation will be collected.
Public property CommunitySearchUrl
Public property CompliantWithMinRole (Inherited from SPService.)
Public propertyStatic member ContentService Gets the Web service associated with the content application.
Public property CorporateCuratedGalleryAppQueryInterval The interval that each frontend in the farm will check the app installed state of the corporate curated gallery. The setting is in seconds.
Public property CreateActiveDirectoryAccounts Gets or sets a Boolean value that specifies whether to create Active Directory accounts for new site users.
Public property DeclarativeWorkflowAutostartOnEmailEnabled Indicates whether or not workflows should automatically start on e-mail-enabled lists.
Public property DefaultDatabaseInstance Gets or sets the default SQL installation for new content databases associated with this Web service.
Public property DefaultDatabasePassword Gets or sets the default password to use for new content databases when using SQL authentication.
Public property DefaultDatabaseUsername Gets or sets the default username to use for new content databases when using SQL authentication.
Public property DenyPermissionsMaskRefreshInterval
Public property DeploymentLocked (Inherited from SPPersistedObject.)
Public property Description (Overrides SPService.Description.)
Public property DeveloperDashboardSettings Settings that control the build in performance monitoring tools for the services in the farm.
Public property DisableCoauthoring If this property is set to false, shared file locking is enabled for coauthoring Office documents
Public property DiscoPage Gets or sets the path to the Web Services Discovery page relative to the /_vti_bin virtual directory.
Public property DiskSizeRequired Gets the amount of disk space that is required to back up this Web service.
Public property DisplayName Gets the display name that describes the persisted object instance within the administrative user interface. (Inherited from SPPersistedObject.)
Public property DynamicClaimCacheTimeout
Public property EnableAjaxBundling
Public property EnableCdn Whether to enable a Content Delivery Network for downloading script and style files
Public property EnableHostHeaderSiteBasedSchemeSelection Gets or sets a value that indicates whether the host header site scheme selection is enabled.
Public property EnableSideBySide
Public property ExternalApplicationSettings Gets an object that provides information about how the Web service manages non-SharePoint applications that are hosted in Web Parts.
Public property ExternalSiteMapProvider Registers a type which will be used in place of our configuration database for site map operations.
Public property Farm Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
Public property FeatureCacheHighWaterMark High water mark for the feature XML document cache, in bytes.
Public property FeatureCacheLowWaterMark Low water mark for the feature XML document cache, in bytes.
Public property FeatureCacheTrimInterval Trimming interval for the feature XML document cache, in milliseconds.
Public property Features Gets the collection of globally scoped features that are activated in the farm.
Public property FileNotFoundErrorThrottlingSettings
Public property FileOperationSettings Obsolete. Gets or sets a Boolean value that specifies whether all Webs should do direct to shredded store.
Public property FileReadChunkSize Chunk size in bytes for optimal reading of data from SQL or some other external storage device. Large values improve throughput, small values improve latency.
Public property FileWriteChunkSize Chunk size in bytes for optimal writing of data from SQL or some other external storage device. Large values improve throughput, small values improve latency.
Public property Hidden (Inherited from SPService.)
Public property HostHeaderPrefixes Gets the set of prefixes for host header sites.
Public property HtmlTransformSettings Gets the collection of HTML transform settings for the Web service.
Public property Id Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
Public property ImagingDownloadSizeLimit Gets or sets the maximum allowable combined size, in bytes, of all files downloaded by an imaging Web service in a single request.
Public property IncomingEmailAccountToModifyAD This option allows you specify an account (username and password) that would be used when creating and deleting and modifying AD contact objects. This is primarily important if the domain in which SharePoint is in is a 1 way trust relationship. It would allow the "email-enable this list" feature to work in such an environment by providing the account to be used when interacting with AD
Public property Instances Gets a collection of all instances of the service in the server farm. (Inherited from SPService.)
Public property IrmSettings Gets the collection of IRM settings for the Web service.
Public property IsBackwardsCompatible Gets or sets a value that indicates whether the current object is backward compatible. (Inherited from SPPersistedUpgradableObject.)
Public property JobDefinitions Gets a collection of job definitions for this service. (Inherited from SPService.)
Public property JobHistoryEntries Gets an enumeration of the job history entries for this service. (Inherited from SPService.)
Public property LargeFileChunkSize Gets or sets the maximum amount of data that the front-end Web server writes to the content database in a single write operation.
Public property MaximumFileFillersPerOperation
Public property MaxListsAccessedByApp The maximun number of SharePoint lists in one web that could be accessed by one app.
Public property MaxTemplateDocumentSize Gets or sets the maximum size for catalogs of list and site templates.
Public property MembershipUserKeyType
Public property Name Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.)
Public property NeedsUpgrade Gets or sets a Boolean value that specifies whether the object needs to be upgraded. (Inherited from SPPersistedUpgradableObject.)
Public property NeedsUpgradeIncludeChildren Gets a Boolean value that indicates whether the object should be upgraded, considering the children of the object. (Inherited from SPPersistedUpgradableObject.)
Public property O365CommunityUrl
Public property OfficeSupportUrl
Public property OnlineHelpEnabled Indicates if the help system directs users to help sources outside the farm (e.g. Office Online)
Public property Parent Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
Public property PeoplePickerSearchInMultipleForests This option allows you to resolve people picker entries using the old algorithm. Set to TRUE to use the old algorithm where entries are searched sequentially in each forest. Set to FALSE to use the Global Catalog to search for all replicated users in the current forest itself....
Public property PeoplePickerSearchReplicatedMasterSIDPropertyName Specifies which ActiveDirectory attribute the people picker control uses to represent a user's SID
Public property PluggableParsers The set of document parsers available to this Web service.
Public property Properties Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
Public property QuotaTemplates Gets a collection of SPQuotaTemplate objects.
Public property RegisteredDatabaseExtensionTypes
Public property RemoteAdministratorAccessDenied If true, all calls to SPFarm.CurrentUserIsAdministrator() will return false during http requests. This setting has no effect on the central administration site.
Public property RemoteEventServiceSettings The settings for handling remote event receiver calls.
Public property RequestRoutingMode
Public property Required Gets a Boolean value that indicates whether an instance of the Web service must be running on at least one computer in the server farm. (Overrides SPService.Required.)
Public property ResourceTag
Public property RestrictedObjectModel The APIs that are not allowed to be called by client request.
Public property RunningJobs Gets a collection of running jobs for this service. (Inherited from SPService.)
Public property ScopeEveryoneToSiteCollectionOnly A boolean value indicating whether allowEveryoneViewItems should apply to existing user only
Public property ShouldDeferUpgradeActions (Inherited from SPPersistedUpgradableObject.)
Public property ShowUserNameOnAccessDenied in hosting environment, people may want to set it to false so as to prevent information disclosure to other sites hosted on the same server.
Public property SideBySideToken
Public property SiteCreationProvider Registers a type which will be used to change the behavior of site creation.
Public property SiteRedirectionEnabled Gets or sets a value that indicates whether the feature that redirects requests for a site to another URL is enabled.
Public property SiteSubscriptionCacheRefreshInterval
Public property SMTPTimeout Timeout for SMTP server
Public property Status Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
Public property SupportMultipleAppDomains
Public property SystemService (Inherited from SPService.)
Public property TokenTimeout Gets or sets the amount of time before a user token times out.
Public property TypeName Gets the user-friendly name used to describe the Web service in the administration user interface. (Overrides SPPersistedObject.TypeName.)
Public property UpgradeContext Gets the SPUpgradeContext for the current upgrade operation. (Inherited from SPPersistedUpgradableObject.)
Public property UpgradedPersistedProperties Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
Public property UsageSettings Obsolete. Gets the collection of usage settings for this Web service.
Public property Version Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.)
Public property ViewStateOnServer By default set to true, the view state will be stored in the velocity cache.
Protected property WasCreated Gets a Boolean value that indicates whether the object is initialized and can be found in the database. (Inherited from SPPersistedObject.)
Public property WcfServiceSettings Gets a dictionary list that provides the settings of the WCF services that use the service factory of MultipleBaseAddressWebServiceHostFactory, MultipleBaseAddressDataServiceHostFactory, and MultipleBaseAddressBasicHttpBindingServiceHostFactory.
Public property WebApplications Gets the set of Web applications that are installed with this service.
Public property WebConfigModifications Gets the web.config modifications that apply to all the Web applications in the Web service.
Public property WebUpgradeBatchSize
Public property WellKnownAppPrincipals
Public property WorkflowCPUThrottle
Public property WorkflowEventDeliveryBatchSize
Public property WorkflowEventDeliveryThrottle
Public property WorkflowTimeoutMinutes
Public property WorkflowTimerJobCPUThrottle
Public property WorkItemEventDeliveryBatchSize
Public property WorkItemEventDeliveryThrottle

Top

Methods

  Name Description
Public method AddBackupObjects Adds the Web service to the backup/restore operation.
Public method ApplyApplicationContentToLocalServer Copies the resource files and DLLs of provisioned Web applications in the Web service to folders within C:\Inetpub\wwwroot\wss\VirtualDirectories.
Public method ApplyWebConfigModifications Applies the list of web.config modifications to all Web applications in this Web service across the farm.
Public method Clone Returns a clone of the object that does not come from the in-memory cache, which enables calling code to help ensure thread safety. (Inherited from SPPersistedObject.)
Public method Delete Removes the service and associated resources. (Inherited from SPService.)
Public method Equals Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
Protected method Finalize (Inherited from Object.)
Public method GetChild<T>() Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.)
Public method GetChild<T>(String) Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.)
Public method GetCreateApplicationLink Gets the administration user interface link that is used to create a new service application. (Inherited from SPService.)
Public method GetCreateApplicationOptions Gets the options for creating a new service application. (Inherited from SPService.)
Protected method GetFirstPreconfiguredDatabase (Inherited from SPService.)
Public method GetHashCode Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.)
Public method GetObjectData Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
Protected method GetPreconfiguredDatabaseInfo (Inherited from SPService.)
Public method GetType (Inherited from Object.)
Protected method HasAdditionalUpdateAccess Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
Public method Invalidate Invalidates computed property values. (Inherited from SPPersistedUpgradableObject.)
Public method IsUserLicensedForEntity Checks if the current user has the proper license to access the specified entity. (Inherited from SPService.)
Public method LegacyUpdate (Inherited from SPPersistedObject.)
Protected method MemberwiseClone (Inherited from Object.)
Public method OnAbort Raises the Abort (backup) event.
Public method OnBackup Raises the Backup event.
Public method OnBackupComplete Raises the BackupComplete event.
Protected method OnDeserialization Do some additional work immediately after the base class deserializes itself. (Overrides SPPersistedObject.OnDeserialization().)
Protected method OnPostCreate (Overrides SPPersistedObject.OnPostCreate().)
Public method OnPostRestore Raises the PostRestore event.
Protected method OnPreCreate (Overrides SPPersistedObject.OnPreCreate().)
Public method OnPrepareBackup Raises the PrepareBackup event.
Public method OnPreRestore Raises the PreRestore event.
Public method OnRestore Raises the Restore event.
Public method Provision Makes the changes to the local server that are needed before the object can be used. (Inherited from SPPersistedObject.)
Public method QueryFeatures(Guid) Gets all features in the Web service that have a specific feature ID.
Public method QueryFeatures(SPFeatureScope, Boolean) Gets either all features in the Web service at the specified scope that need an upgrade, or all features that do not.
Public method QueryFeatures(Guid, Boolean) Gets all features in the Web service that have a specific feature ID and upgrade state.
Public method QueryFeatures(Guid, Version) Gets all features in the Web service that have a specific feature ID and version.
Public methodStatic member QueryFeaturesInAllWebServices(Guid) Gets all features in all Web services that have a specific feature ID.
Public methodStatic member QueryFeaturesInAllWebServices(SPFeatureScope, Boolean) Gets all of the features in all Web services at the specified scope that need an upgrade, or gets all of the features that do not.
Public methodStatic member QueryFeaturesInAllWebServices(Guid, Boolean) Gets all features in all Web services that have a specific feature ID and upgrade state.
Public methodStatic member QueryFeaturesInAllWebServices(Guid, Version) Gets all features in all Web services that have a specific feature ID and version.
Public method RunWithConcurrencyRetries (Inherited from SPPersistedObject.)
Public method ToString Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.)
Public method Uncache Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.)
Public method Unprovision Makes the changes to the local server that are needed to clean up after deleting the object. (Inherited from SPPersistedObject.)
Public method Update() Causes this Web service to save its state and to propagate changes to all the machines in the farm. (Overrides SPPersistedObject.Update().)
Public method Update(Boolean) Causes the object to save its state and propagate changes to all the computers in the server farm, optionally throwing an exception if the object already exists in the configuration store. (Inherited from SPPersistedObject.)
Protected method UpdateParent Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
Public method UpdateWithNoObjectCallbackCheck (Inherited from SPPersistedObject.)
Public method Upgrade() Upgrades the object. (Inherited from SPPersistedUpgradableObject.)
Public method Upgrade(Boolean) Upgrades the object, and if a Boolean parameter equals true, recursively upgrades all descendants of the current object. (Inherited from SPPersistedUpgradableObject.)
Protected method Validate Validates the state of all fields before persisting the object. (Inherited from SPPersistedObject.)
Public method ValidateBackwardsCompatibility Validates the backward compatibility of the content database schema for the DLLs on the Web front end. This method is called each time a connection is made to the content database to verify that the database schema is compatible. (Inherited from SPPersistedUpgradableObject.)

Top

Explicit interface implementations

  Name Description
Explicit interface implemetationPrivate property IBackupRestoreConfiguration.CanBackupRestoreAsConfiguration Gets a value that indicates whether the Web service can be selected for inclusion in a configuration-only backup or restore operation.

Top

See also

Reference

SPWebService class

Microsoft.SharePoint.Administration namespace