Site members

Represents a collection of sites in a Web application, including a top-level website and all its subsites.

The Site type exposes the following members.

Constructors

	Name	Description
	Site	Initializes a new instance of the Site object.

Top

Properties

	Name	Description
	AllowCreateDeclarativeWorkflow
	AllowDesigner	Gets or sets a value that specifies whether a designer can be used on this site collection.
	AllowMasterPageEditing	Gets or sets a value that specifies whether master page editing is allowed on this site collection.
	AllowRevertFromTemplate	Gets or sets a value that specifies whether this site collection can be reverted to its base template.
	AllowSaveDeclarativeWorkflowAsTemplate
	AllowSavePublishDeclarativeWorkflow
	AllowSelfServiceUpgrade	Whether version to version upgrade is allowed on this site.
	AllowSelfServiceUpgradeEvaluation	Whether upgrade evaluation site collection is allowed.
	Audit
	AuditLogTrimmingRetention
	CanUpgrade	Property indicating whether or not this object can be upgraded.
	Classification
	CommentsOnSitePagesDisabled
	CompatibilityLevel	Gets the major version of this site collection for purposes of major version-level compatibility checks.
	ComplianceAttribute
	Context	Returns the context that is associated with the client object. (Inherited from ClientObject.)
	CurrentChangeToken
	DisableAppViews
	DisableCompanyWideSharingLinks
	DisableFlows
	EventReceivers	Provides event receivers for events that occur at the scope of the site collection.
	ExternalSharingTipsEnabled
	Features	Gets a value that specifies the collection of the site collection features for the site collection that contains the site.
	GeoLocation
	GroupId
	HubSiteId
	Id
	IsHubSite
	LockIssue	Gets or sets the comment that is used in locking a site collection.
	MaxItemsPerThrottledOperation	Gets a value that specifies the maximum number of list items allowed per operation before throttling will occur.
	NeedsB2BUpgrade
	ObjectData	Gets the object data for the current client object. (Inherited from ClientObject.)
	ObjectVersion	Gets a string that indicates the version of the current client object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	Owner	Gets or sets the owner of the site collection. (Read-only in sandboxed solutions.)
	Path	Tracks how a client object is created in the ClientRuntimeContext class so that the object can be recreated on the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	PrimaryUri	Specifies the primary URI of this site collection, including the host name, port number, and path.
	ReadOnly	Gets or sets a Boolean value that specifies whether the site collection is read-only, locked, and unavailable for write access.
	RecycleBin	Gets a value that specifies the collection of Recycle Bin items for the site collection.
	RequiredDesignerVersion
	ResourcePath
	RootWeb	Gets a value that returns the top-level site of the site collection.
	SandboxedCodeActivationCapability
	SecondaryContact
	ServerObjectIsNull	Gets the server object and returns null if the server object is null. (Inherited from ClientObject.)
	ServerRelativePath
	ServerRelativeUrl	Gets the server-relative URL of the root Web site in the site collection.
	ShareByEmailEnabled
	ShareByLinkEnabled	Property that indicates whether users will be able to share links to documents that can be accessed without logging in.
	ShowPeoplePickerSuggestionsForGuestUsers
	ShowUrlStructure	Gets or sets a value that specifies whether the URL structure of this site collection is viewable.
	SocialBarOnSitePagesDisabled
	StatusBarLink
	StatusBarText
	Tag	Gets or sets data that is associated with the client object. (Inherited from ClientObject.)
	ThicketSupportDisabled
	TrimAuditLog
	TypedObject	Gets the object with the correct type information returned from the server. (Inherited from ClientObject.)
	UIVersionConfigurationEnabled	Gets or sets a value that specifies whether the Visual Upgrade UI of this site collection is displayed.
	UpgradeInfo	Specifies the upgrade information of this site collection.
	UpgradeReminderDate	Specifies a date, after which site collection administrators will be reminded to upgrade the site collection.
	UpgradeScheduled
	UpgradeScheduledDate
	Upgrading	Specifies whether the site is currently upgrading.
	Url	Gets the full URL to the root Web site of the site collection, including host name, port number, and path.
	Usage	Gets a value that specifies usage information about the site, including bandwidth, storage, and the number of visits to the site collection.
	UserCustomActions	Gets a value that specifies the collection of user custom actions for the site collection.

Top

Methods

	Name	Description
	CheckUninitializedProperty	Checks to determine whether the specified value type property of a ClientObject has been initialized. (Inherited from ClientObject.)
	CreateCopyJob
	CreateCopyJobs
	CreateMigrationIngestionJob	This method is reserved for internal use only.
	CreateMigrationJob	This method creates a new migration import job and queues it up for later processing by a separate timer job. The job will consume a well formed (pre-defined format) import package that is located in the Azure Blob Storage Container(s) specified in this method. The Service Level Agreement (SLA) for migration job processing is controlled through pre-configured queue and work load throttling settings, and there is no guaranteed SLA or return time for a submitted job.
	CreateMigrationJobEncrypted
	CreatePreviewSPSite	Creates a temporary evaluation Site object for this Site object, for the purposes of determining whether upgrade is likely to be successful.
	CustomFromJson	Returns a Boolean value that indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	DeleteMigrationJob	This method deletes the migration job created by CreateMigrationJob. The job is identified by the id returned from that call.
	Exists
	ExtendUpgradeReminderDate	Extend the upgrade reminder date for this Site by the days specified at WebApplication.UpgradeReminderDelay.
	FromJson	Indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	GetBringYourOwnKeySiteStatus
	GetBringYourOwnKeyTenantStatus
	GetCatalog	Specifies 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.
	GetChanges	Specifies the collection of the site collection changes from the change log that have occurred within the scope of the site collection, based on the specified query.
	GetCopyJobProgress
	GetCustomListTemplates	Specifies the collection of custom list templates for a given site.
	GetMigrationJobStatus	This method queries the queue for the status of the specified migration job. It is an optional check that can be called after the CreateMigrationJob method and uses the id returned by that call. Once the migration job has completed, it will no longer show up in the queue and you should check the notification queue and/or log output for detailed status.
	GetMigrationStatus
	GetRecycleBinItems
	GetUrlById
	GetWebPath
	GetWebTemplates	Returns the collection of site definitions that are available for creating websites within the site collection.
	InitNonPropertyFieldFromJson	Initializes a non-property field of the client object based on JavaScript Object Notation (JSON) data from the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	InitOnePropertyFromJson	(Overrides ClientObject.InitOnePropertyFromJson(String, JsonReader).)
	Invalidate	Implements the IUpgradeable interface.
	IsObjectPropertyInstantiated	Indicates whether the specified property of the client object is instantiated. (Inherited from ClientObject.)
	IsPropertyAvailable	Returns a Boolean value that indicates whether the specified scalar property has been retrieved or set. (Inherited from ClientObject.)
	LoadExpandoFields	Initializes the extended properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
	NeedsUpgradeByType	true if the object needs to be upgraded; otherwise, false.
	OnboardSiteForBringYourOwnKey
	OnboardTenantForBringYourOwnKey
	OpenWeb	Opens a new site using the specified URL.
	OpenWebById	Returns the site with the specified GUID.
	OpenWebUsingPath
	ProvisionMigrationContainers
	ProvisionMigrationQueue
	RecoverTenantForBringYourOwnKey
	RefreshLoad	Reloads all scalar properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
	RemoveFromParentCollection	Removes the current client object from the parent client object collection. (Inherited from ClientObject.)
	Retrieve()	Retrieves all scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	Retrieve([])	Retrieves the specified scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	RollTenantBringYourOwnKey
	RunHealthCheck	Runs a health check as follows. (The health rules referenced below perform an implementation-dependent check on the health of a site collection.)If ruleId is not an empty GUID, runs the specified site collection health rule and returns a summary of the results. If ruleId is an empty GUID, runs all of the site collection health rules and returns a summary of the results.If bRepair is true, runs the specified rules in repair mode. In this case, and if a given rule is repairable, an attempt will be made to repair issues found by the rule, and the results from that attempted repairs are returned. If bRepair is false, an attempt to repair issues found is not made.If bRunAlways is true, rules are always run by this method, and the results are returned. If false, cached results from a recent previous run can be returned instead.
	RunUpgradeSiteSession	Either runs a site collection upgrade, or schedules it to be run in the future, depending on available system resources and the value of the queueOnly parameter.The user executing this method MUST be a farm administrator or a site collection administrator.
	ToString	(Inherited from Object.)
	UpdateClientObjectModelUseRemoteAPIsPermissionSetting	Sets whether the client-side object model (CSOM) requests that are made in the context of any site inside the site collection require UseRemoteAPIs permission.
	UpdateClientObjectPropertyType	Updates the client object property's value to have correct type by using the type information returned from the server. (Inherited from ClientObject.)

Top

See also

Reference

Site class

Microsoft.SharePoint.Client namespace