SPSite methods

  • Article

The SPSite type exposes the following members.

Methods

  Name Description
Public method AddWorkItem(Guid, DateTime, Guid, Guid, Guid, Int32, Boolean, Guid, Guid, Int32, [], String, Guid) Adds a work item to the site collection.
Public method AddWorkItem(Guid, DateTime, Guid, Guid, Guid, Int32, Boolean, Guid, Guid, Int32, [], String, Guid, Boolean) Adds a work item to the site collection.
Public method BypassUseRemoteApis Bypasses using SOAP, WebDAV, or Microsoft Office SharePoint Designer 2007 interfaces to access the site collection.
Public method CheckForPermissions Checks the permissions for a given set of rights and throws an Unauthorized Access exception if the permission check fails.
Public method Close Closes the site collection and releases resources.
Public method ConfirmUsage Certifies that the site collection is in use.
Public method CreatePreviewSPSite Creates a temporary evaluation SPite for this SPite, for the purposes of determining whether upgrade is likely to be successful.
Public method Delete() Deletes the site collection from the server.
Public method Delete(Boolean) Deletes the site collection from the server and removes the site collection users from Active Directory Domain Services (ADDS) if bDeleteADAccounts is true.
Public method Delete(Boolean, Boolean) Deletes the site collection from the server, optionally removes the site collection users from Active Directory Domain Services (ADDS), and optionally uses a timer job to delete the site collection gradually.
Public method Dispose Releases all unmanaged resources that are used by the site collection object.
Public method DoesUserHavePermissions(SPReusableAcl, SPBasePermissions) Returns a Boolean value indicates whether the user has permissions for the specified set of rights.
Public method DoesUserHavePermissions(SPReusableAcl, SPBasePermissions, SPWeb) Returns a Boolean value that indicates whether the user has permissions for the specified Web site and set of rights.
Public method Equals (Inherited from Object.)
Public methodStatic member Exists(Uri) Returns a Boolean value that indicates whether the specified site collection exists.
Public methodStatic member Exists(Uri, Boolean) Determines if a site with the specified uri exists. Checks the config db cache and, additionally, checks the content database if checkContentDb is true.
Public method ExtendUpgradeReminderDate extend the upgrade reminder date for this SPSite by the days specified at WebApplication.UpgradeReminderDelay
Protected method Finalize (Inherited from Object.)
Public method GetAllReusableAcls() Returns the reusable access control lists (ACLs) for the site collection.
Public method GetAllReusableAcls(Int32) Returns the reusable access control lists (ACLs) of the site collection up to a specified limit.
Public method GetCatalog Returns the list template gallery, site template gallery, Web Part gallery, master page gallery, or other galleries from the site collection, including custom galleries that are defined by users.
Public method GetChanges() Returns the default number of changes listed in the current change log for the site collection.
Public method GetChanges(SPChangeQuery) Returns a collection of changes from the change log filtered by the specified query.
Public method GetChanges(SPChangeToken) Returns a collection of changes, starting from a particular point in the change log.
Public method GetChanges(SPChangeToken, SPChangeToken) Returns a collection of changes that have been logged over a specified period of time.
Public method GetCustomListTemplates Returns the collection of custom list templates, which are created by end users, from the specified site.
Public method GetCustomWebTemplates Returns the collection of site templates for the site collection based on the specified locale ID (LCID).
Public method GetEffectiveRightsForAcl(SPReusableAcl) Returns the actual permissions that the current user has for the specified Access Control List (ACL).
Public method GetEffectiveRightsForAcl(SPReusableAcl, SPWeb) Returns the actual permissions that the current user has for the specified access control list (ACL).
Public method GetFeaturesIfLoaded If the features have been loaded for the site, this will return them. If they have not yet been loaded, this call will return null (and will not have any round trip incurred)
Public method GetHashCode (Inherited from Object.)
Public method GetRecycleBinItems Returns a collection of recycle bin items based on the specified query.
Public method GetRecycleBinStatistics Gets both the number of items in the recycle bin and its size.
Public method GetReusableAclForScope Returns the reusable access control list (ACL) for the specified scope.
Public method GetSelfServiceSiteCreationSettings Gets the settings that are used for Self-Service Site Creation.
Public method GetType (Inherited from Object.)
Public method GetUrls Retrieve all the URLs for the site collection, including both Primary URL and all Secondary URLs
Public method GetVisualReport Retrieves a list of SPSite.WebVisualReport objects for all Web sites in this site collection and their corresponding visual upgrade data.
Public method GetWebTemplates(UInt32) Returns the collection of site definitions that are available for creating Web sites within the site collection.
Public method GetWebTemplates(UInt32, Int32) Returns the collection of site definitions that are available for creating Web sites within the site collection.
Public method GetWorkItems Returns the individual work items, number of columns, and number of rows in the specified work item collection as output parameters.
Public method HasEvalSite Determines if a site collection has an upgrade evaluation site or not.
Public method Invalidate IUpgradable Interface implementation
Public methodStatic member InvalidateCacheEntry Removes the specified cache entry and returns a Boolean value that indicates whether the entry was cached.
Public method IsScriptSafe Validates the specified uri against the script safe settings of the site collection and returns true if safe, false if not
Public methodStatic member LookupUriInRemoteFarm Returns the Uniform Resource Identifier (URI) of a Web site in the specified remote server farm.
Public method MakeFullUrl Returns the full URL for the specified server-relative URL.
Protected method MemberwiseClone (Inherited from Object.)
Public method NeedsUpgradeByType true if the object needs to be upgraded; otherwise, false.
Public method OpenWeb() Returns the Web site that is associated with the URL that is used in an SPSite constructor.
Public method OpenWeb(Guid) Returns the Web site with the specified GUID.
Public method OpenWeb(String) Returns the Web site that is located at the specified server-relative or site-relative URL.
Public method OpenWeb(String, SPSiteOpenWebOptions) Returns the Web site that is located at the specified server-relative or site-relative URL and applies specified options to it.
Public method OpenWeb(String, Boolean) Returns the Web site that is located at the specified server-relative or site-relative URL based on a Boolean value that specifies whether the exact URL must be supplied.
Public method QueryFeatures(Guid) Gets a collection of the features deployed in this site collection that have a specific definition identifier.
Public method QueryFeatures(Guid, Boolean) Gets a collection of the features deployed in this site collection that have a specific definition identifier, including only features that either do or do not need to be upgraded.
Public method QueryFeatures(Guid, Version) Gets a collection of the features deployed in this site collection that have a specific definition identifier and a specific version.
Public method QueryFeatures(SPFeatureScope, Boolean) Gets a collection of the features deployed in this site collection with either Site or Web scope, including only features that either do or do not need to be upgraded.
Public method RecalculateStorageMetrics
Public method RecalculateStorageUsed Recalculates the storage that is used by the site collection.
Public method RefreshEmailEnabledObjects Refreshes the email–enabled objects of the site collection.
Public method RemoveUrl This is the body of removing a secondary URL from site collection.
Public method Rename Changes the URL of a host-header-named site collection to a new URL.
Public method RunHealthCheck
Public method RunUpgradeSiteSession
Public method SelfServiceCreateSite(String, String, String, UInt32, String, String, String, String, String, String, String) Creates a site collection by using Self-Service Site Creation.
Public method SelfServiceCreateSite(String, String, String, UInt32, String, String, String, String, String, String, String, String) Creates a site collection by using Self-Service Site Creation based on the specified quota template and other information.
Public method SelfServiceCreateSite(String, String, String, UInt32, Int32, String, String, String, String, String, String, String, String)
Public method SelfServiceCreateSite(String, String, String, UInt32, String, String, String, String, String, String, String, String, SPSiteSubscription) Creates a site collection by using Self-Service Site Creation based on the specified quota template and other specified information (see parameter list).
Public method SelfServiceCreateSite(String, String, String, UInt32, Int32, String, String, String, String, String, String, String, String, SPSiteSubscription) Creates a site collection by using Self-Service Site Creation based on the specified quota template and other information.
Public method SetUrl Set secondary URL and zone for the site collection. If the URL exist for the site collection, then we only update the zone for the existing URL. If the URL does not exist, we will add the URL and the zone for the site collection.
Public method StorageManagementInformation Obsolete. Returns information about storage management for the site collection.
Public method ToString Returns the name of the site collection. (Overrides Object.ToString().)
Public method UpdateClientObjectModelUseRemoteAPIsPermissionSetting
Public method UpdateValidationKey Updates the key that is used to generate the form digest validation of the site collection.
Public method Upgrade() Upgrades this object
Public method Upgrade(Boolean) Upgrades this object
Public methodStatic member ValidateDomainCompatibility(String, String) Verifies whether two URLs point to the same site collection, even if the domain portions of the URLs are different.
Public methodStatic member ValidateDomainCompatibility(SPSite, SPSite) Verifies that two URLs have compatible domains.
Public method VisualUpgradeWebs Obsolete. Updates all Webs in this site to the new SharePoint UI.

Top

See also

Reference

SPSite class

Microsoft.SharePoint namespace