Public interface to define a Site object of SharePoint Online
public interface ISite : IDataModel<ISite>, IDataModelParent, IDataModelWithContext, ISupportModules<ISite>, IDataModelGet<ISite>, IDataModelLoad<ISite>, IDataModelUpdate, IDataModelSupportingGetChangesA special property used to add an asterisk to a $select statement
object All { get; }|
System.Object
|
Gets or sets a value that specifies whether the creation of declarative workflows is allowed on this site collection.
bool AllowCreateDeclarativeWorkflow { get; set; }|
System.Boolean
|
Gets or sets a value that specifies whether a designer can be used on this site collection.
bool AllowDesigner { get; set; }|
System.Boolean
|
Gets or sets a value that specifies whether external embedding wrapper is allowed on this site collection. 0 means "Don't allow embedding any external domains" 1 means "Only allow embedding external domains from allow-embed-domains-list" 2 means "Allow embedding any external domains"
int AllowExternalEmbeddingWrapper { get; set; }|
System.Int32
|
Gets or sets a value that specifies whether master page editing is allowed on this site collection.
bool AllowMasterPageEditing { get; set; }|
System.Boolean
|
Gets or sets a value that specifies whether this site collection can be reverted to its base template.
bool AllowRevertFromTemplate { get; set; }|
System.Boolean
|
Gets or sets a value that specifies whether it is allowed to save declarative workflows as template on this site collection.
bool AllowSaveDeclarativeWorkflowAsTemplate { get; set; }|
System.Boolean
|
Gets or sets a value that specifies whether it is allowed to save and publish declarative workflows on this site collection.
bool AllowSavePublishDeclarativeWorkflow { get; set; }|
System.Boolean
|
Collection of sub-webs in the current Site object
Implements
See Requesting model collections
and IQueryable performance considerations to learn more.
IWebCollection AllWebs { get; }|
IWebCollection
|
This is the number of days of audit log data to retain. If unset and audit trimming is enabled, the retention defaults default configured schedule for trimming
int AuditLogTrimmingRetention { get; set; }|
System.Int32
|
Gets or sets value if syncing hub site permissions to this associated site is allowed.
bool CanSyncHubSitePermissions { get; set; }|
System.Boolean
|
Gets the ID of the Modern Group associated with this site.
Guid ChannelGroupId { get; }|
Guid
|
The Classification of the Site object
string Classification { get; set; }|
System.String
|
Gets or sets a value that specifies whether the comments on site pages are disabled on this site collection.
bool CommentsOnSitePagesDisabled { get; set; }|
System.Boolean
|
Sets whether or not to disable app views for all child webs. True means app views are disabled throughout the site collection; False otherwise.
bool DisableAppViews { get; set; }|
System.Boolean
|
Sets whether or not to disable company sharing links for all child webs. True means companywide sharing links are disabled throughout the site collection, regardless of the settings on the root or child webs. False means each web can individually decide whether to turn on or off companywide sharing links.
bool DisableCompanyWideSharingLinks { get; set; }|
System.Boolean
|
Sets whether or not to disable Flows for all child webs. True means Flows are disabled throughout the site collection; False otherwise.
bool DisableFlows { get; set; }|
System.Boolean
|
Event Receivers defined in this web
Implements
See Requesting model collections
and IQueryable performance considerations to learn more.
IEventReceiverDefinitionCollection EventReceivers { get; }|
IEventReceiverDefinitionCollection
|
Gets a boolean value that specifies whether users will be greeted with a notification bar telling them that the site can be shared with external users. True - notification bar is enabled; False - otherwise
bool ExternalSharingTipsEnabled { get; }|
System.Boolean
|
Property that indicates the default number of days an external user will expire in. 0 if the policy is disabled or unavailable, otherwise the number of days
int ExternalUserExpirationInDays { get; }|
System.Int32
|
Collection of features enabled for the site
Implements
See Requesting model collections
and IQueryable performance considerations to learn more.
IFeatureCollection Features { get; }|
IFeatureCollection
|
returns the Geo Location hosting this site collection
string GeoLocation { get; }|
System.String
|
The unique ID of the associated Microsoft 365 Group (if any)
Guid GroupId { get; }|
Guid
|
Gets the ID of the HubSite this site is associated with.
Guid HubSiteId { get; }|
Guid
|
Use JoinHubSite method to change the value of this property.
Gets the synchronizable visitor group for a hub site
ISharePointGroup HubSiteSynchronizableVisitorGroup { get; }|
ISharePointGroup
|
The Unique ID of the Site object
Guid Id { get; }|
Guid
|
Returns whether or not this site is a HubSite. Hub sites can be associated with one or more sites.
bool IsHubSite { get; }|
System.Boolean
|
Gets the comment that is used in locking a site collection.
string LockIssue { get; }|
System.String
|
Maximum items that will not be throttled per operation.
int MaxItemsPerThrottledOperation { get; }|
System.Int32
|
Gets or sets a bool value that specifies whether the site collection is read-only, locked, and unavailable for write access.
bool ReadOnly { get; set; }|
System.Boolean
|
Gets a value that specifies the collection of Recycle Bin items for the site collection.
Implements
See Requesting model collections
and IQueryable performance considerations to learn more.
IRecycleBinItemCollection RecycleBin { get; }|
IRecycleBinItemCollection
|
Gets the ID of the Modern Group related to this site.
Guid RelatedGroupId { get; }|
Guid
|
Whether suite nav search box is shown on modern and classic pages
SearchBoxInNavBar SearchBoxInNavBar { get; set; }|
SearchBoxInNavBar
|
Search placeholder text for search box in navbar - overrides default placeholder text if set.
string SearchBoxPlaceholderText { get; set; }|
System.String
|
Information Protection Label Id for an individual site collection
string SensitivityLabel { get; }|
System.String
|
Gets the Information Protection Label Id for an individual site collection.
Guid SensitivityLabelId { get; }|
Guid
|
Gets the server-relative URL of the root Web site in the site collection.
string ServerRelativeUrl { get; }|
System.String
|
ShareByEmailEnabled when true means that user's will be able to grant permissions to guests for resources within the site collection
bool ShareByEmailEnabled { get; set; }|
System.Boolean
|
Property that indicates whether users will be able to share links to documents that can be accessed without logging in.
bool ShareByLinkEnabled { get; }|
System.Boolean
|
Gets or sets a value that specifies whether guest users should be displayed as suggestions in people picker on this site collection.
bool ShowPeoplePickerSuggestionsForGuestUsers { get; set; }|
System.Boolean
|
Defines whether social bar is disabled on Site Pages in this site collection
bool SocialBarOnSitePagesDisabled { get; set; }|
System.Boolean
|
Gets or sets a value that specifies the status bar link on this site collection (sets the SiteStatusBarLink property on the root web).
string StatusBarLink { get; set; }|
System.String
|
Gets or sets a value that specifies the text of the status bar on this site collection (sets the SiteStatusBarText property on the root web).
string StatusBarText { get; set; }|
System.String
|
Gets a value that indicates whether thicket support is disabled on this site collection.
bool ThicketSupportDisabled { get; }|
System.Boolean
|
When this flag is set for the site, the audit events are trimmed periodically.
bool TrimAuditLog { get; set; }|
System.Boolean
|
The URL of the Site object
Uri Url { get; }|
Uri
|
Gets a value that specifies the collection of user custom actions for the site collection.
Implements
See Requesting model collections
and IQueryable performance considerations to learn more.
IUserCustomActionCollection UserCustomActions { get; }|
IUserCustomActionCollection
|
Creates a new migration job
Array of the objects to migrate (absolute url to the file / folder) Destination URI to where the objects have to be migrated Migration options Defines if we have to wait until all the migrations have finished Duration between every GetCopyJobProgress call in seconds. Defaults to 1.IList<ICopyMigrationInfo> CreateCopyJobs(string[] exportObjectUris, string destinationUri, CopyMigrationOptions options, bool waitUntilFinished = false, int waitAfterStatusCheck = 1)|
System.String[]
exportObjectUris
|
|
System.String
destinationUri
|
|
CopyMigrationOptions
options
|
|
System.Boolean
waitUntilFinished
|
|
System.Int32
waitAfterStatusCheck
|
|
PnP.Core.Model.SharePoint.IList<ICopyMigrationInfo>
|
Creates a new migration job
Array of the objects to migrate (absolute url to the file / folder) Destination URI to where the objects have to be migrated Migration options Defines if we have to wait until all the migrations have finished Duration between every GetCopyJobProgress call in seconds. Defaults to 1.Task<IList<ICopyMigrationInfo>> CreateCopyJobsAsync(string[] exportObjectUris, string destinationUri, CopyMigrationOptions options, bool waitUntilFinished = false, int waitAfterStatusCheck = 1)|
System.String[]
exportObjectUris
|
|
System.String
destinationUri
|
|
CopyMigrationOptions
options
|
|
System.Boolean
waitUntilFinished
|
|
System.Int32
waitAfterStatusCheck
|
|
Task<PnP.Core.Model.SharePoint.IList<ICopyMigrationInfo>>
|
Ensures that a migration job has completely run
List of migration jobs to check the process of Duration between every GetCopyJobProgress call in seconds. Defaults to 1.void EnsureCopyJobHasFinished(IList<ICopyMigrationInfo> copyMigrationInfos, int waitAfterStatusCheck = 1)|
PnP.Core.Model.SharePoint.IList<ICopyMigrationInfo>
copyMigrationInfos
|
|
System.Int32
waitAfterStatusCheck
|
Ensures that a migration job has completely run
List of migration jobs to check the process of Duration between every GetCopyJobProgress call in seconds. Defaults to 1.Task EnsureCopyJobHasFinishedAsync(IList<ICopyMigrationInfo> copyMigrationInfos, int waitAfterStatusCheck = 1)|
PnP.Core.Model.SharePoint.IList<ICopyMigrationInfo>
copyMigrationInfos
|
|
System.Int32
waitAfterStatusCheck
|
|
Task
|
Gets site analytics
List<IActivityStat> GetAnalytics(AnalyticsOptions options = null)|
AnalyticsOptions
options
Defines which analytics are needed |
|
PnP.Core.Model.SharePoint.List<IActivityStat>
The requested analytics data |
Gets site analytics
Task<List<IActivityStat>> GetAnalyticsAsync(AnalyticsOptions options = null)|
AnalyticsOptions
options
Defines which analytics are needed |
|
Task<PnP.Core.Model.SharePoint.List<IActivityStat>>
The requested analytics data |
Retrieves the available compliance tags / retention labels for this site
IEnumerable<IComplianceTag> GetAvailableComplianceTags()|
IEnumerable<IComplianceTag>
|
Retrieves the available compliance tags / retention labels for this site
Task<IEnumerable<IComplianceTag>> GetAvailableComplianceTagsAsync()|
Task<IEnumerable<IComplianceTag>>
|
Gets the progress of an existing migration info object
Migration job to get the progress ofICopyJobProgress GetCopyJobProgress(ICopyMigrationInfo copyMigrationInfo)|
ICopyMigrationInfo
copyMigrationInfo
|
|
ICopyJobProgress
|
Gets the progress of an existing migration info object
Migration job to get the progress ofTask<ICopyJobProgress> GetCopyJobProgressAsync(ICopyMigrationInfo copyMigrationInfo)|
ICopyMigrationInfo
copyMigrationInfo
|
|
Task<ICopyJobProgress>
|
Gets hubsite data from the current site OR another specified hub site ID
IHubSite GetHubSiteData(Guid? id)|
System.Nullable<Guid>
id
Hub Site Guid |
|
IHubSite
|
Gets hubsite data from the current site OR another specified hub site ID
Task<IHubSite> GetHubSiteDataAsync(Guid? id)|
System.Nullable<Guid>
id
Hub Site Guid |
|
Task<IHubSite>
|
Gets the managed properties from the search configuration of this site
List<IManagedProperty> GetSearchConfigurationManagedProperties()|
PnP.Core.Model.SharePoint.List<IManagedProperty>
List of managed properties |
Gets the managed properties from the search configuration of this site
Task<List<IManagedProperty>> GetSearchConfigurationManagedPropertiesAsync()|
Task<PnP.Core.Model.SharePoint.List<IManagedProperty>>
List of managed properties |
Gets the search configuration of the web
string GetSearchConfigurationXml()|
System.String
Search configuration XML |
Gets the search configuration of the web
Task<string> GetSearchConfigurationXmlAsync()|
Task<System.String>
Search configuration XML |
Checks if current site is a HomeSite
bool IsHomeSite()|
System.Boolean
|
Checks if current site is a HomeSite
Task<bool> IsHomeSiteAsync()|
Task<System.Boolean>
|
Associates the current site to a primary hub site
bool JoinHubSite(Guid hubSiteId)|
Guid
hubSiteId
|
|
System.Boolean
|
Associates the current site to a primary hub site
Task<bool> JoinHubSiteAsync(Guid hubSiteId)|
Guid
hubSiteId
|
|
Task<System.Boolean>
|
Registers the current site as a primary hub site
IHubSite RegisterHubSite()|
IHubSite
|
Registers the current site as a primary hub site
Task<IHubSite> RegisterHubSiteAsync()|
Task<IHubSite>
|
Sets the search configuration for the site
void SetSearchConfigurationXml(string configuration)|
System.String
configuration
Search configuration, obtained via GetSearchConfigurationXml() to apply |
Sets the search configuration for the site
Task SetSearchConfigurationXmlAsync(string configuration)|
System.String
configuration
Search configuration, obtained via GetSearchConfigurationXml() to apply |
|
Task
|
Disassociates current site from primary hub site
bool UnJoinHubSite()|
System.Boolean
|
Disassociates current site from primary hub site
Task<bool> UnJoinHubSiteAsync()|
Task<System.Boolean>
|
Unregisters the current site as a primary hub site
bool UnregisterHubSite()|
System.Boolean
|
Unregisters the current site as a primary hub site
Task<bool> UnregisterHubSiteAsync()|
Task<System.Boolean>
|