SPSite SPSite SPSite Class

Definition

public ref class SPSite : IDisposable, Microsoft::SharePoint::Administration::IUpgradable
[Microsoft.SharePoint.Client.ClientCallableType(FactoryType=typeof(Microsoft.SharePoint.SPObjectFactory), Name="Site", ObjectIdentityPropertyName="CanonicalId", SampleUrl="{apiroot}/site", ServerTypeId="{E1BB82E8-0D1E-4e52-B90C-684802AB4EF6}")]
[Microsoft.SharePoint.Client.SubsetCallableExcludeInterface(Microsoft.SharePoint.Client.SubsetCallableExcludeMemberType.InternalInterface, ExcludeInterface=typeof(Microsoft.SharePoint.ISPWorkItemHost))]
[Microsoft.SharePoint.Client.SubsetCallableExcludeInterface(Microsoft.SharePoint.Client.SubsetCallableExcludeMemberType.InternalInterface, ExcludeInterface=typeof(Microsoft.SharePoint.Administration.IUpgradable))]
[Microsoft.SharePoint.Client.SubsetCallableType]
[Microsoft.SharePoint.Upgrade.Upgradable]
public class SPSite : IDisposable, Microsoft.SharePoint.Administration.IUpgradable
Public Class SPSite
Implements IDisposable, IUpgradable
Inheritance
SPSiteSPSiteSPSite
Attributes
Microsoft.SharePoint.Client.ClientCallableTypeAttribute Microsoft.SharePoint.Client.SubsetCallableExcludeInterfaceAttribute Microsoft.SharePoint.Client.SubsetCallableExcludeInterfaceAttribute Microsoft.SharePoint.Client.SubsetCallableTypeAttribute UpgradableAttribute
Implements

Constructors

SPSite(Guid) SPSite(Guid) SPSite(Guid)
SPSite(String) SPSite(String) SPSite(String)
SPSite(Guid, SPUrlZone) SPSite(Guid, SPUrlZone) SPSite(Guid, SPUrlZone)
SPSite(Guid, SPUserToken) SPSite(Guid, SPUserToken) SPSite(Guid, SPUserToken)
SPSite(String, SPUserToken) SPSite(String, SPUserToken) SPSite(String, SPUserToken)
SPSite(Guid, SPUrlZone, SPUserToken) SPSite(Guid, SPUrlZone, SPUserToken) SPSite(Guid, SPUrlZone, SPUserToken)

Fields

MaxFullUrlLength MaxFullUrlLength MaxFullUrlLength
MaxWebNameLength MaxWebNameLength MaxWebNameLength

Properties

AdministrationSiteType AdministrationSiteType AdministrationSiteType
AllowCreateDeclarativeWorkflow AllowCreateDeclarativeWorkflow AllowCreateDeclarativeWorkflow
AllowDesigner AllowDesigner AllowDesigner
AllowExternalEmbedding AllowExternalEmbedding AllowExternalEmbedding
AllowMasterPageEditing AllowMasterPageEditing AllowMasterPageEditing
AllowRevertFromTemplate AllowRevertFromTemplate AllowRevertFromTemplate
AllowRssFeeds AllowRssFeeds AllowRssFeeds
AllowSaveDeclarativeWorkflowAsTemplate AllowSaveDeclarativeWorkflowAsTemplate AllowSaveDeclarativeWorkflowAsTemplate
AllowSavePublishDeclarativeWorkflow AllowSavePublishDeclarativeWorkflow AllowSavePublishDeclarativeWorkflow
AllowSelfServiceUpgrade AllowSelfServiceUpgrade AllowSelfServiceUpgrade
AllowSelfServiceUpgradeEvaluation AllowSelfServiceUpgradeEvaluation AllowSelfServiceUpgradeEvaluation
AllowUnsafeUpdates AllowUnsafeUpdates AllowUnsafeUpdates
AllWebs AllWebs AllWebs
ApplicationRightsMask ApplicationRightsMask ApplicationRightsMask
Archived Archived Archived
Audit Audit Audit
AuditLogTrimmingCallout AuditLogTrimmingCallout AuditLogTrimmingCallout
AuditLogTrimmingRetention AuditLogTrimmingRetention AuditLogTrimmingRetention
AverageResourceUsage AverageResourceUsage AverageResourceUsage
BrowserDocumentsEnabled BrowserDocumentsEnabled BrowserDocumentsEnabled
Cache Cache Cache
CanUpgrade CanUpgrade CanUpgrade
CatchAccessDeniedException CatchAccessDeniedException CatchAccessDeniedException
CertificationDate CertificationDate CertificationDate
CompatibilityLevel CompatibilityLevel CompatibilityLevel
ContentDatabase ContentDatabase ContentDatabase
CurrentChangeToken CurrentChangeToken CurrentChangeToken
CurrentResourceUsage CurrentResourceUsage CurrentResourceUsage
DeadWebNotificationCount DeadWebNotificationCount DeadWebNotificationCount
DenyPermissionsMask DenyPermissionsMask DenyPermissionsMask
EvalSiteId EvalSiteId EvalSiteId
EventReceivers EventReceivers EventReceivers
ExpirationDate ExpirationDate ExpirationDate
FeatureDefinitions FeatureDefinitions FeatureDefinitions
Features Features Features
FileNotFoundUrl FileNotFoundUrl FileNotFoundUrl
GlobalPermMask GlobalPermMask GlobalPermMask
HasAppPrincipalContext HasAppPrincipalContext HasAppPrincipalContext
HideSystemStatusBar HideSystemStatusBar HideSystemStatusBar
HostHeaderIsSiteName HostHeaderIsSiteName HostHeaderIsSiteName
HostName HostName HostName
ID ID ID
IISAllowsAnonymous IISAllowsAnonymous IISAllowsAnonymous
Impersonating Impersonating Impersonating
InheritAllowSelfServiceUpgradeEvaluationSetting InheritAllowSelfServiceUpgradeEvaluationSetting InheritAllowSelfServiceUpgradeEvaluationSetting
InheritAllowSelfServiceUpgradeSetting InheritAllowSelfServiceUpgradeSetting InheritAllowSelfServiceUpgradeSetting
IsEvalSite IsEvalSite IsEvalSite
IsPaired IsPaired IsPaired
IsReadLocked IsReadLocked IsReadLocked
LastContentModifiedDate LastContentModifiedDate LastContentModifiedDate
LastSecurityModifiedDate LastSecurityModifiedDate LastSecurityModifiedDate
LockIssue LockIssue LockIssue
MaintenanceMode MaintenanceMode MaintenanceMode
NeedsUpgrade NeedsUpgrade NeedsUpgrade
OutgoingEmailAddress OutgoingEmailAddress OutgoingEmailAddress
Owner Owner Owner
Port Port Port
PortalName PortalName PortalName
PortalUrl PortalUrl PortalUrl
PrimaryUri PrimaryUri PrimaryUri
Protocol Protocol Protocol
Quota Quota Quota
ReadLocked ReadLocked ReadLocked
ReadOnly ReadOnly ReadOnly
RecycleBin RecycleBin RecycleBin
RequiredDesignerVersion RequiredDesignerVersion RequiredDesignerVersion
ResourceQuotaExceeded ResourceQuotaExceeded ResourceQuotaExceeded
ResourceQuotaExceededNotificationSent ResourceQuotaExceededNotificationSent ResourceQuotaExceededNotificationSent
ResourceQuotaWarningNotificationSent ResourceQuotaWarningNotificationSent ResourceQuotaWarningNotificationSent
RootWeb RootWeb RootWeb
SchemaVersion SchemaVersion SchemaVersion
ScriptSafeDomains ScriptSafeDomains ScriptSafeDomains
ScriptSafePages ScriptSafePages ScriptSafePages
SearchServiceInstance SearchServiceInstance SearchServiceInstance
SecondaryContact SecondaryContact SecondaryContact
ServerRelativeUrl ServerRelativeUrl ServerRelativeUrl
ShareByEmailEnabled ShareByEmailEnabled ShareByEmailEnabled
ShareByLinkEnabled ShareByLinkEnabled ShareByLinkEnabled
ShowURLStructure ShowURLStructure ShowURLStructure
SiteSubscription SiteSubscription SiteSubscription
Solutions Solutions Solutions
SourceSiteId SourceSiteId SourceSiteId
SyndicationEnabled SyndicationEnabled SyndicationEnabled
SystemAccount SystemAccount SystemAccount
TrimAuditLog TrimAuditLog TrimAuditLog
UIVersionConfigurationEnabled UIVersionConfigurationEnabled UIVersionConfigurationEnabled
UpgradeContext UpgradeContext UpgradeContext
UpgradeInfo UpgradeInfo UpgradeInfo
UpgradeRedirectUri UpgradeRedirectUri UpgradeRedirectUri
UpgradeReminderDate UpgradeReminderDate UpgradeReminderDate
Upgrading Upgrading Upgrading
Url Url Url
Usage Usage Usage
UserAccountDirectoryPath UserAccountDirectoryPath UserAccountDirectoryPath
UserCodeEnabled UserCodeEnabled UserCodeEnabled
UserCustomActions UserCustomActions UserCustomActions
UserDefinedWorkflowsEnabled UserDefinedWorkflowsEnabled UserDefinedWorkflowsEnabled
UserIsSiteAdminInSystem UserIsSiteAdminInSystem UserIsSiteAdminInSystem
UserToken UserToken UserToken
WarningNotificationSent WarningNotificationSent WarningNotificationSent
WebApplication WebApplication WebApplication
WorkflowManager WorkflowManager WorkflowManager
WriteLocked WriteLocked WriteLocked
Zone Zone Zone

Methods

AddWorkItem(Guid, DateTime, Guid, Guid, Guid, Int32, Boolean, Guid, Guid, Int32, Byte[], String, Guid) AddWorkItem(Guid, DateTime, Guid, Guid, Guid, Int32, Boolean, Guid, Guid, Int32, Byte[], String, Guid) AddWorkItem(Guid, DateTime, Guid, Guid, Guid, Int32, Boolean, Guid, Guid, Int32, Byte[], String, Guid)
AddWorkItem(Guid, DateTime, Guid, Guid, Guid, Int32, Boolean, Guid, Guid, Int32, Byte[], String, Guid, Boolean) AddWorkItem(Guid, DateTime, Guid, Guid, Guid, Int32, Boolean, Guid, Guid, Int32, Byte[], String, Guid, Boolean) AddWorkItem(Guid, DateTime, Guid, Guid, Guid, Int32, Boolean, Guid, Guid, Int32, Byte[], String, Guid, Boolean)
BypassUseRemoteApis() BypassUseRemoteApis() BypassUseRemoteApis()
CheckForPermissions(SPReusableAcl, SPBasePermissions) CheckForPermissions(SPReusableAcl, SPBasePermissions) CheckForPermissions(SPReusableAcl, SPBasePermissions)
Close() Close() Close()
ConfirmUsage() ConfirmUsage() ConfirmUsage()
CreatePreviewSPSite(Boolean, Boolean) CreatePreviewSPSite(Boolean, Boolean) CreatePreviewSPSite(Boolean, Boolean)
Delete() Delete() Delete()
Delete(Boolean) Delete(Boolean) Delete(Boolean)
Delete(Boolean, Boolean) Delete(Boolean, Boolean) Delete(Boolean, Boolean)
Dispose() Dispose() Dispose()
DoesUserHavePermissions(SPReusableAcl, SPBasePermissions) DoesUserHavePermissions(SPReusableAcl, SPBasePermissions) DoesUserHavePermissions(SPReusableAcl, SPBasePermissions)
DoesUserHavePermissions(SPReusableAcl, SPBasePermissions, SPWeb) DoesUserHavePermissions(SPReusableAcl, SPBasePermissions, SPWeb) DoesUserHavePermissions(SPReusableAcl, SPBasePermissions, SPWeb)
Exists(Uri) Exists(Uri) Exists(Uri)
Exists(Uri, Boolean) Exists(Uri, Boolean) Exists(Uri, Boolean)
ExtendUpgradeReminderDate() ExtendUpgradeReminderDate() ExtendUpgradeReminderDate()
GetAllReusableAcls() GetAllReusableAcls() GetAllReusableAcls()
GetAllReusableAcls(Int32) GetAllReusableAcls(Int32) GetAllReusableAcls(Int32)
GetCatalog(SPListTemplateType) GetCatalog(SPListTemplateType) GetCatalog(SPListTemplateType)
GetChanges() GetChanges() GetChanges()
GetChanges(SPChangeQuery) GetChanges(SPChangeQuery) GetChanges(SPChangeQuery)
GetChanges(SPChangeToken) GetChanges(SPChangeToken) GetChanges(SPChangeToken)
GetChanges(SPChangeToken, SPChangeToken) GetChanges(SPChangeToken, SPChangeToken) GetChanges(SPChangeToken, SPChangeToken)
GetCustomListTemplates(SPWeb) GetCustomListTemplates(SPWeb) GetCustomListTemplates(SPWeb)
GetCustomWebTemplates(UInt32) GetCustomWebTemplates(UInt32) GetCustomWebTemplates(UInt32)
GetEffectiveRightsForAcl(SPReusableAcl) GetEffectiveRightsForAcl(SPReusableAcl) GetEffectiveRightsForAcl(SPReusableAcl)
GetEffectiveRightsForAcl(SPReusableAcl, SPWeb) GetEffectiveRightsForAcl(SPReusableAcl, SPWeb) GetEffectiveRightsForAcl(SPReusableAcl, SPWeb)
GetFeaturesIfLoaded() GetFeaturesIfLoaded() GetFeaturesIfLoaded()
GetRecycleBinItems(SPRecycleBinQuery) GetRecycleBinItems(SPRecycleBinQuery) GetRecycleBinItems(SPRecycleBinQuery)
GetRecycleBinStatistics(Int32, Int64) GetRecycleBinStatistics(Int32, Int64) GetRecycleBinStatistics(Int32, Int64)
GetReusableAclForScope(Guid) GetReusableAclForScope(Guid) GetReusableAclForScope(Guid)
GetSelfServiceSiteCreationSettings(Boolean, Boolean, String) GetSelfServiceSiteCreationSettings(Boolean, Boolean, String) GetSelfServiceSiteCreationSettings(Boolean, Boolean, String)
GetUrls() GetUrls() GetUrls()
GetVisualReport() GetVisualReport() GetVisualReport()
GetWebTemplates(UInt32) GetWebTemplates(UInt32) GetWebTemplates(UInt32)
GetWebTemplates(UInt32, Int32) GetWebTemplates(UInt32, Int32) GetWebTemplates(UInt32, Int32)
GetWorkItems(SPWorkItemCollection, UInt32, UInt32, Object) GetWorkItems(SPWorkItemCollection, UInt32, UInt32, Object) GetWorkItems(SPWorkItemCollection, UInt32, UInt32, Object)
HasEvalSite() HasEvalSite() HasEvalSite()
Invalidate() Invalidate() Invalidate()
InvalidateCacheEntry(Uri, Guid) InvalidateCacheEntry(Uri, Guid) InvalidateCacheEntry(Uri, Guid)
IsScriptSafe(String) IsScriptSafe(String) IsScriptSafe(String)
LookupUriInRemoteFarm(SPFarm, Guid, SPUrlZone) LookupUriInRemoteFarm(SPFarm, Guid, SPUrlZone) LookupUriInRemoteFarm(SPFarm, Guid, SPUrlZone)
MakeFullUrl(String) MakeFullUrl(String) MakeFullUrl(String)
NeedsUpgradeByType(Boolean, Boolean) NeedsUpgradeByType(Boolean, Boolean) NeedsUpgradeByType(Boolean, Boolean)
OpenWeb() OpenWeb() OpenWeb()
OpenWeb(Guid) OpenWeb(Guid) OpenWeb(Guid)
OpenWeb(String) OpenWeb(String) OpenWeb(String)
OpenWeb(String, SPSiteOpenWebOptions) OpenWeb(String, SPSiteOpenWebOptions) OpenWeb(String, SPSiteOpenWebOptions)
OpenWeb(String, Boolean) OpenWeb(String, Boolean) OpenWeb(String, Boolean)
QueryFeatures(Guid) QueryFeatures(Guid) QueryFeatures(Guid)
QueryFeatures(SPFeatureScope, Boolean) QueryFeatures(SPFeatureScope, Boolean) QueryFeatures(SPFeatureScope, Boolean)
QueryFeatures(Guid, Boolean) QueryFeatures(Guid, Boolean) QueryFeatures(Guid, Boolean)
QueryFeatures(Guid, Version) QueryFeatures(Guid, Version) QueryFeatures(Guid, Version)
RecalculateStorageMetrics() RecalculateStorageMetrics() RecalculateStorageMetrics()
RecalculateStorageUsed() RecalculateStorageUsed() RecalculateStorageUsed()
RefreshEmailEnabledObjects() RefreshEmailEnabledObjects() RefreshEmailEnabledObjects()
RemoveUrl(Uri) RemoveUrl(Uri) RemoveUrl(Uri)
Rename(Uri) Rename(Uri) Rename(Uri)
RunHealthCheck(Guid, Boolean) RunHealthCheck(Guid, Boolean) RunHealthCheck(Guid, Boolean)
RunUpgradeSiteSession(Boolean, Boolean, Boolean) RunUpgradeSiteSession(Boolean, Boolean, Boolean) RunUpgradeSiteSession(Boolean, Boolean, Boolean)
SelfServiceCreateSite(String, String, String, UInt32, String, String, String, String, String, String, String) SelfServiceCreateSite(String, String, String, UInt32, String, String, String, String, String, String, String) SelfServiceCreateSite(String, String, String, UInt32, String, String, String, String, String, String, String)
SelfServiceCreateSite(String, String, String, UInt32, String, String, String, String, String, String, String, String) SelfServiceCreateSite(String, String, String, UInt32, String, String, String, String, String, String, String, String) SelfServiceCreateSite(String, String, String, UInt32, String, String, String, String, String, String, String, String)
SelfServiceCreateSite(String, String, String, UInt32, Int32, String, String, String, String, String, String, String, String) SelfServiceCreateSite(String, String, String, UInt32, Int32, String, String, String, String, String, String, String, String) SelfServiceCreateSite(String, String, String, UInt32, Int32, String, String, String, String, String, String, String, String)
SelfServiceCreateSite(String, String, String, UInt32, String, String, String, String, String, String, String, String, SPSiteSubscription) SelfServiceCreateSite(String, String, String, UInt32, String, String, String, String, String, String, String, String, SPSiteSubscription) SelfServiceCreateSite(String, String, String, UInt32, String, String, String, String, String, String, String, String, SPSiteSubscription)
SelfServiceCreateSite(String, String, String, UInt32, Int32, String, String, String, String, String, String, String, String, SPSiteSubscription) SelfServiceCreateSite(String, String, String, UInt32, Int32, String, String, String, String, String, String, String, String, SPSiteSubscription) SelfServiceCreateSite(String, String, String, UInt32, Int32, String, String, String, String, String, String, String, String, SPSiteSubscription)
SetUrl(Uri, SPUrlZone) SetUrl(Uri, SPUrlZone) SetUrl(Uri, SPUrlZone)
StorageManagementInformation(SPSite+StorageManagementInformationType, SPSite+StorageManagementSortOrder, SPSite+StorageManagementSortedOn, UInt32) StorageManagementInformation(SPSite+StorageManagementInformationType, SPSite+StorageManagementSortOrder, SPSite+StorageManagementSortedOn, UInt32) StorageManagementInformation(SPSite+StorageManagementInformationType, SPSite+StorageManagementSortOrder, SPSite+StorageManagementSortedOn, UInt32)
ToString() ToString() ToString()
UpdateClientObjectModelUseRemoteAPIsPermissionSetting(Boolean) UpdateClientObjectModelUseRemoteAPIsPermissionSetting(Boolean) UpdateClientObjectModelUseRemoteAPIsPermissionSetting(Boolean)
UpdateValidationKey() UpdateValidationKey() UpdateValidationKey()
Upgrade() Upgrade() Upgrade()
Upgrade(Boolean) Upgrade(Boolean) Upgrade(Boolean)
ValidateDomainCompatibility(SPSite, SPSite) ValidateDomainCompatibility(SPSite, SPSite) ValidateDomainCompatibility(SPSite, SPSite)
ValidateDomainCompatibility(String, String) ValidateDomainCompatibility(String, String) ValidateDomainCompatibility(String, String)
VisualUpgradeWebs() VisualUpgradeWebs() VisualUpgradeWebs()

Extension Methods

ToJson(Object) ToJson(Object) ToJson(Object)
ActivateHelpCollection(SPSite, String) ActivateHelpCollection(SPSite, String) ActivateHelpCollection(SPSite, String)
DeactivateHelpCollection(SPSite, String) DeactivateHelpCollection(SPSite, String) DeactivateHelpCollection(SPSite, String)

Applies to