SPSite Class

Definition

Represents a collection of sites in a Web application, including a top-level Web site and all its subsites. Each SPSite object, or site collection, is represented within an SPSiteCollection object that consists of the collection of all site collections in the Web application.

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
type SPSite = class
    interface IDisposable
    interface IUpgradable
Public Class SPSite
Implements IDisposable, IUpgradable
Inheritance
SPSite
Attributes
Implements

Constructors

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

Fields

MaxFullUrlLength
MaxWebNameLength

Properties

AdministrationSiteType
AllowCreateDeclarativeWorkflow
AllowDesigner
AllowExternalEmbedding
AllowMasterPageEditing
AllowRevertFromTemplate
AllowRssFeeds
AllowSaveDeclarativeWorkflowAsTemplate
AllowSavePublishDeclarativeWorkflow
AllowSelfServiceUpgrade
AllowSelfServiceUpgradeEvaluation
AllowUnsafeUpdates
AllWebs
ApplicationRightsMask
Archived
Audit
AuditLogTrimmingCallout
AuditLogTrimmingRetention
AverageResourceUsage
BrowserDocumentsEnabled
Cache
CanUpgrade
CatchAccessDeniedException
CertificationDate
CompatibilityLevel
ContentDatabase
CurrentChangeToken
CurrentResourceUsage
DeadWebNotificationCount
DenyPermissionsMask
EvalSiteId
EventReceivers
ExpirationDate
FeatureDefinitions
Features
FileNotFoundUrl
GlobalPermMask
HasAppPrincipalContext
HideSystemStatusBar
HostHeaderIsSiteName
HostName
ID
IISAllowsAnonymous
Impersonating
InheritAllowSelfServiceUpgradeEvaluationSetting
InheritAllowSelfServiceUpgradeSetting
IsEvalSite
IsPaired
IsReadLocked
LastContentModifiedDate
LastSecurityModifiedDate
LockIssue
MaintenanceMode
NeedsUpgrade
OutgoingEmailAddress
Owner
Port
PortalName
PortalUrl
PrimaryUri
Protocol
Quota
ReadLocked
ReadOnly
RecycleBin
RequiredDesignerVersion
ResourceQuotaExceeded
ResourceQuotaExceededNotificationSent
ResourceQuotaWarningNotificationSent
RootWeb
SchemaVersion
ScriptSafeDomains
ScriptSafePages
SearchServiceInstance
SecondaryContact
ServerRelativeUrl
ShareByEmailEnabled
ShareByLinkEnabled
ShowURLStructure
SiteSubscription
Solutions
SourceSiteId
SyndicationEnabled
SystemAccount
TrimAuditLog
UIVersionConfigurationEnabled
UpgradeContext
UpgradeInfo
UpgradeRedirectUri
UpgradeReminderDate
Upgrading
Url
Usage
UserAccountDirectoryPath
UserCodeEnabled
UserCustomActions
UserDefinedWorkflowsEnabled
UserIsSiteAdminInSystem
UserToken
WarningNotificationSent
WebApplication
WorkflowManager
WriteLocked
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, Boolean)
BypassUseRemoteApis()
CheckForPermissions(SPReusableAcl, SPBasePermissions)
Close()
ConfirmUsage()
CreatePreviewSPSite(Boolean, Boolean)
Delete()
Delete(Boolean)
Delete(Boolean, Boolean)
Dispose()
DoesUserHavePermissions(SPReusableAcl, SPBasePermissions)
DoesUserHavePermissions(SPReusableAcl, SPBasePermissions, SPWeb)
Exists(Uri)
Exists(Uri, Boolean)
ExtendUpgradeReminderDate()
GetAllReusableAcls()
GetAllReusableAcls(Int32)
GetCatalog(SPListTemplateType)
GetChanges()
GetChanges(SPChangeQuery)
GetChanges(SPChangeToken)
GetChanges(SPChangeToken, SPChangeToken)
GetCustomListTemplates(SPWeb)
GetCustomWebTemplates(UInt32)
GetEffectiveRightsForAcl(SPReusableAcl)
GetEffectiveRightsForAcl(SPReusableAcl, SPWeb)
GetFeaturesIfLoaded()
GetRecycleBinItems(SPRecycleBinQuery)
GetRecycleBinStatistics(Int32, Int64)
GetReusableAclForScope(Guid)
GetSelfServiceSiteCreationSettings(Boolean, Boolean, String)
GetUrls()
GetVisualReport()
GetWebTemplates(UInt32)
GetWebTemplates(UInt32, Int32)
GetWorkItems(SPWorkItemCollection, UInt32, UInt32, Object)
HasEvalSite()
Invalidate()
InvalidateCacheEntry(Uri, Guid)
IsScriptSafe(String)
LookupUriInRemoteFarm(SPFarm, Guid, SPUrlZone)
MakeFullUrl(String)
NeedsUpgradeByType(Boolean, Boolean)
OpenWeb()
OpenWeb(Guid)
OpenWeb(String)
OpenWeb(String, Boolean)
OpenWeb(String, SPSiteOpenWebOptions)
QueryFeatures(Guid)
QueryFeatures(Guid, Boolean)
QueryFeatures(Guid, Version)
QueryFeatures(SPFeatureScope, Boolean)
RecalculateStorageMetrics()
RecalculateStorageUsed()
RefreshEmailEnabledObjects()
RemoveUrl(Uri)
Rename(Uri)
RunHealthCheck(Guid, Boolean)
RunUpgradeSiteSession(Boolean, Boolean, Boolean)
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, SPSiteSubscription)
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, SPSiteSubscription)
SetUrl(Uri, SPUrlZone)
StorageManagementInformation(SPSite+StorageManagementInformationType, SPSite+StorageManagementSortOrder, SPSite+StorageManagementSortedOn, UInt32)
ToString()
UpdateClientObjectModelUseRemoteAPIsPermissionSetting(Boolean)
UpdateValidationKey()
Upgrade()
Upgrade(Boolean)
ValidateDomainCompatibility(SPSite, SPSite)
ValidateDomainCompatibility(String, String)
VisualUpgradeWebs()

Extension Methods

ActivateHelpCollection(SPSite, String)
DeactivateHelpCollection(SPSite, String)

Applies to