diff --git a/api/PnP.Core.Model.SharePoint.IWeb.html b/api/PnP.Core.Model.SharePoint.IWeb.html index 6c613120c6..3b71cf93f7 100644 --- a/api/PnP.Core.Model.SharePoint.IWeb.html +++ b/api/PnP.Core.Model.SharePoint.IWeb.html @@ -4860,7 +4860,7 @@

Methods - + @@ -4919,7 +4919,7 @@

- + @@ -4978,7 +4978,7 @@
- + @@ -5023,7 +5023,7 @@
Returns
- + @@ -5068,7 +5068,7 @@
Returns
- + @@ -5132,7 +5132,7 @@
Returns
- + @@ -5196,7 +5196,7 @@
Returns
- + @@ -5241,7 +5241,7 @@
Returns
- + @@ -5286,7 +5286,7 @@
Returns
- + @@ -5332,7 +5332,7 @@
Parameters
- + @@ -5387,7 +5387,7 @@
Returns
- + @@ -5422,7 +5422,7 @@
Declaration
- + @@ -5466,7 +5466,7 @@
Returns
- + @@ -5522,7 +5522,7 @@
Returns
- + @@ -5578,7 +5578,7 @@
Returns
- + @@ -5642,7 +5642,7 @@
Returns
- + @@ -5698,7 +5698,7 @@
Returns
- + @@ -5762,7 +5762,7 @@
Returns
- + @@ -5818,7 +5818,7 @@
Returns
- + @@ -5863,7 +5863,7 @@
Returns
- + @@ -5908,7 +5908,7 @@
Returns
- + @@ -5953,7 +5953,7 @@
Returns
- + @@ -5998,7 +5998,7 @@
Returns
- + @@ -6054,7 +6054,7 @@
Returns
- + @@ -6099,7 +6099,7 @@
Returns
- + @@ -6155,7 +6155,7 @@
Returns
- + @@ -6219,7 +6219,7 @@
Returns
- + @@ -6283,7 +6283,7 @@
Returns
- + @@ -6347,7 +6347,7 @@
Returns
- + @@ -6419,7 +6419,7 @@
Returns
- + @@ -6483,7 +6483,7 @@
Returns
- + @@ -6555,7 +6555,7 @@
Returns
- + @@ -6619,7 +6619,7 @@
Returns
- + @@ -6683,7 +6683,7 @@
Returns
- + @@ -6747,7 +6747,7 @@
Returns
- + @@ -6811,7 +6811,7 @@
Returns
- + @@ -6883,7 +6883,7 @@
Returns
- + @@ -6947,7 +6947,7 @@
Returns
- + @@ -7019,7 +7019,7 @@
Returns
- + @@ -7083,7 +7083,7 @@
Returns
- + @@ -7147,7 +7147,7 @@
Returns
- + @@ -7211,7 +7211,7 @@
Returns
- + @@ -7275,7 +7275,7 @@
Returns
- + @@ -7339,7 +7339,7 @@
Returns
- + @@ -7403,7 +7403,7 @@
Returns
- + @@ -7475,7 +7475,7 @@
Returns
- + @@ -7539,7 +7539,7 @@
Returns
- + @@ -7611,7 +7611,7 @@
Returns
- + @@ -7675,7 +7675,7 @@
Returns
- + @@ -7739,7 +7739,7 @@
Returns
- + @@ -7811,7 +7811,7 @@
Returns
- + @@ -7875,7 +7875,7 @@
Returns
- + @@ -7947,7 +7947,7 @@
Returns
- + @@ -8123,7 +8123,7 @@
Returns
- + @@ -8179,7 +8179,7 @@
Returns
- + @@ -8235,7 +8235,7 @@
Returns
- + @@ -8291,7 +8291,7 @@
Returns
- + @@ -8355,7 +8355,7 @@
Returns
- + @@ -8411,7 +8411,7 @@
Returns
- + @@ -8475,7 +8475,7 @@
Returns
- + @@ -8520,7 +8520,7 @@
Returns
- + @@ -8565,7 +8565,7 @@
Returns
- + @@ -8610,7 +8610,7 @@
Returns
- + @@ -8655,7 +8655,7 @@
Returns
- + @@ -8711,7 +8711,7 @@
Returns
- + @@ -8767,7 +8767,7 @@
Returns
- + @@ -8831,7 +8831,7 @@
Returns
- + @@ -8887,7 +8887,7 @@
Returns
- + @@ -8951,7 +8951,7 @@
Returns
- + @@ -9007,7 +9007,7 @@
Returns
- + @@ -9063,7 +9063,7 @@
Returns
- + @@ -9211,7 +9211,7 @@
Returns
- + @@ -9283,7 +9283,7 @@
Returns
- + @@ -9355,7 +9355,7 @@
Returns
- + @@ -9435,7 +9435,7 @@
Returns
- + @@ -9507,7 +9507,7 @@
Returns
- + @@ -9587,7 +9587,7 @@
Returns
- + @@ -9659,7 +9659,7 @@
Returns
- + @@ -9723,7 +9723,7 @@
Returns
- + @@ -9787,7 +9787,7 @@
Returns
- + @@ -9859,7 +9859,7 @@
Returns
- + @@ -9923,7 +9923,7 @@
Returns
- + @@ -9995,7 +9995,7 @@
Returns
- + @@ -10059,7 +10059,7 @@
Returns
- + @@ -10115,7 +10115,7 @@
Returns
- + @@ -10171,7 +10171,7 @@
Returns
- + @@ -10216,7 +10216,7 @@
Returns
- + @@ -10261,7 +10261,7 @@
Returns
- + @@ -10306,7 +10306,7 @@
Returns
- + @@ -10351,7 +10351,7 @@
Returns
- + @@ -10396,7 +10396,7 @@
Returns
- + @@ -10441,7 +10441,7 @@
Returns
- + @@ -10486,7 +10486,7 @@
Returns
- + @@ -10531,7 +10531,7 @@
Returns
- + @@ -10576,7 +10576,7 @@
Returns
- + @@ -10621,7 +10621,7 @@
Returns
- + @@ -10666,7 +10666,7 @@
Returns
- + @@ -10708,24 +10708,24 @@
Returns
- + - + -

NewPage(PageLayoutType)

+

NewPage(PageLayoutType, EditorType)

-
+

Creates a new modern page

Declaration
- 
IPage NewPage(PageLayoutType pageLayoutType = default(PageLayoutType))
+ 
IPage NewPage(PageLayoutType pageLayoutType = default(PageLayoutType), EditorType editorType = default(EditorType))
Parameters
@@ -10735,6 +10735,14 @@
Parameters
PageLayoutType pageLayoutType

Optionally specify the page type, defaults to Article

+

+ + + + + EditorType + editorType +

Editor type to be used by the new page, CK4 is the legacy model, CK5 the current

@@ -10764,24 +10772,24 @@
Returns
- + - + -

NewPageAsync(PageLayoutType)

+

NewPageAsync(PageLayoutType, EditorType)

-
+

Creates a new modern page

Declaration
- 
Task<IPage> NewPageAsync(PageLayoutType pageLayoutType = default(PageLayoutType))
+ 
Task<IPage> NewPageAsync(PageLayoutType pageLayoutType = default(PageLayoutType), EditorType editorType = default(EditorType))
Parameters
@@ -10791,6 +10799,14 @@
Parameters
PageLayoutType pageLayoutType

Optionally specify the page type, defaults to Article

+

+ + + + + EditorType + editorType +

Editor type to be used by the new page, CK4 is the legacy model, CK5 the current

@@ -10823,7 +10839,7 @@
Returns
- + @@ -10858,7 +10874,7 @@
Declaration
- + @@ -10902,7 +10918,7 @@
Returns
- + @@ -10958,7 +10974,7 @@
Returns
- + @@ -11014,7 +11030,7 @@
Returns
- + @@ -11070,7 +11086,7 @@
Returns
- + @@ -11126,7 +11142,7 @@
Returns
- + @@ -11182,7 +11198,7 @@
Returns
- + @@ -11246,7 +11262,7 @@
Returns
- + @@ -11302,7 +11318,7 @@
Returns
- + @@ -11366,7 +11382,7 @@
Returns
- + @@ -11429,7 +11445,7 @@
Returns
- + @@ -11492,7 +11508,7 @@
Returns
- + @@ -11538,7 +11554,7 @@
Parameters
- + @@ -11593,7 +11609,7 @@
Returns
- + @@ -11637,7 +11653,7 @@
Returns
- + @@ -11701,7 +11717,7 @@
Returns
- + @@ -11765,7 +11781,7 @@
Returns
- + @@ -11821,7 +11837,7 @@
Returns
- + @@ -11877,7 +11893,7 @@
Returns
- + @@ -11933,7 +11949,7 @@
Returns
- + diff --git a/index.json b/index.json index 969a0b7d20..8b7af76471 100644 --- a/index.json +++ b/index.json @@ -2347,7 +2347,7 @@ "api/PnP.Core.Model.SharePoint.IWeb.html": { "href": "api/PnP.Core.Model.SharePoint.IWeb.html", "title": "Interface IWeb | PnP Core SDK", - "keywords": "Interface IWeb Public interface to define a Web object of SharePoint Online Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() IDataModelSupportingGetChanges.GetChangesAsync(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChanges(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatchAsync(Batch, ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatch(Batch, ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatchAsync(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatch(ChangeQueryOptions) ISecurableObject.RoleAssignments ISecurableObject.HasUniqueRoleAssignments ISecurableObject.BreakRoleInheritance(Boolean, Boolean) ISecurableObject.BreakRoleInheritanceAsync(Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatch(Batch, Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatchAsync(Batch, Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatch(Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatchAsync(Boolean, Boolean) ISecurableObject.ResetRoleInheritance() ISecurableObject.ResetRoleInheritanceAsync() ISecurableObject.ResetRoleInheritanceBatch(Batch) ISecurableObject.ResetRoleInheritanceBatchAsync(Batch) ISecurableObject.ResetRoleInheritanceBatch() ISecurableObject.ResetRoleInheritanceBatchAsync() ISecurableObject.GetRoleDefinitions(Int32) ISecurableObject.GetRoleDefinitionsAsync(Int32) ISecurableObject.AddRoleDefinitions(Int32, String[]) ISecurableObject.AddRoleDefinitionsAsync(Int32, String[]) ISecurableObject.AddRoleDefinition(Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionAsync(Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatch(Batch, Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatchAsync(Batch, Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatch(Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatchAsync(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitions(Int32, String[]) ISecurableObject.RemoveRoleDefinitionsAsync(Int32, String[]) ISecurableObject.RemoveRoleDefinition(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionAsync(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatch(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatchAsync(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatch(Batch, Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatchAsync(Batch, Int32, IRoleDefinition) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IWeb : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IDataModelSupportingGetChanges, ISecurableObject, IQueryableDataModel Properties AccessRequestListUrl Gets the URL of the access request list to the current site. Declaration string AccessRequestListUrl { get; } Property Value System.String AccessRequestSiteDescription Gets or sets the description of the access request to this site. Declaration string AccessRequestSiteDescription { get; set; } Property Value System.String All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object AllowAutomaticASPXPageIndexing Gets a value that specifies whether the automatic ASPX page indexed is allowed. Declaration bool AllowAutomaticASPXPageIndexing { get; set; } Property Value System.Boolean AllowCreateDeclarativeWorkflowForCurrentUser Gets a value that specifies whether the current user is allowed to create declarative workflow on this site. Declaration bool AllowCreateDeclarativeWorkflowForCurrentUser { get; set; } Property Value System.Boolean AllowDesignerForCurrentUser Gets a value that specifies whether the current user is allowed to use a designer application to customize this site. Declaration bool AllowDesignerForCurrentUser { get; set; } Property Value System.Boolean AllowMasterPageEditingForCurrentUser Gets a value that specifies whether the current user is allowed to edit the master page. Declaration bool AllowMasterPageEditingForCurrentUser { get; } Property Value System.Boolean AllowRevertFromTemplateForCurrentUser Gets a value that specifies whether the current user is allowed to revert the site to a default site template. Declaration bool AllowRevertFromTemplateForCurrentUser { get; } Property Value System.Boolean AllowRssFeeds Gets a value that specifies whether the site allows RSS feeds. Declaration bool AllowRssFeeds { get; } Property Value System.Boolean AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser Gets a value that specifies whether the current user is allowed to save declarative workflows as template. Declaration bool AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser { get; } Property Value System.Boolean AllowSavePublishDeclarativeWorkflowForCurrentUser Gets a value that specifies whether the current user is allowed to publish a declarative workflow. Declaration bool AllowSavePublishDeclarativeWorkflowForCurrentUser { get; } Property Value System.Boolean AllProperties Gets a collection of metadata for the Web site. Declaration IPropertyValues AllProperties { get; } Property Value IPropertyValues AlternateCssUrl The AlternateCSS of the Site, optional attribute. Declaration string AlternateCssUrl { get; set; } Property Value System.String AppInstanceId The instance Id of the App Instance that this website represents. Declaration Guid AppInstanceId { get; } Property Value Guid AssociatedMemberGroup Associated SharePoint Member group Declaration ISharePointGroup AssociatedMemberGroup { get; } Property Value ISharePointGroup AssociatedOwnerGroup Associated SharePoint owner group Declaration ISharePointGroup AssociatedOwnerGroup { get; } Property Value ISharePointGroup AssociatedVisitorGroup Associated SharePoint Visitor group Declaration ISharePointGroup AssociatedVisitorGroup { get; } Property Value ISharePointGroup Author Gets the web's author Declaration ISharePointUser Author { get; } Property Value ISharePointUser AvailableContentTypes Gets the collection of all content types that apply to the current scope, including those of the current Web site, as well as any parent Web sites. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IContentTypeCollection AvailableContentTypes { get; } Property Value IContentTypeCollection AvailableFields Gets a value that specifies the collection of all fields available for the current scope, including those of the current site, as well as any parent sites. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFieldCollection AvailableFields { get; } Property Value IFieldCollection CommentsOnSitePagesDisabled Defines whether the comments on site pages are disabled or not Declaration bool CommentsOnSitePagesDisabled { get; set; } Property Value System.Boolean ContainsConfidentialInfo Gets a boolean value that specifies whether the site contains highly confidential information. If the tenant settings don't allow tagging sites as confidential, this property will always return false. Declaration bool ContainsConfidentialInfo { get; set; } Property Value System.Boolean ContentTypes Collection of content types in the current Web object Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IContentTypeCollection ContentTypes { get; } Property Value IContentTypeCollection Created Gets a value that specifies when the site was created. Declaration DateTime Created { get; } Property Value DateTime CurrentUser Gets the current user in the current context Declaration ISharePointUser CurrentUser { get; } Property Value ISharePointUser CustomMasterUrl The Custom MasterPage Url of the Site, optional attribute. Declaration string CustomMasterUrl { get; set; } Property Value System.String DefaultNewPageTemplateId The id of the default new page template. Use SetDefaultNewPageTemplateId to set the value. Declaration Guid DefaultNewPageTemplateId { get; set; } Property Value Guid Description The Description of the Site, optional attribute. Declaration string Description { get; set; } Property Value System.String DesignPackageId Gets or sets the design package Id of this site. Declaration Guid DesignPackageId { get; set; } Property Value Guid DisableAppViews Defines whether disable PowerApps for the current web Declaration bool DisableAppViews { get; set; } Property Value System.Boolean DisableFlows Defines whether disable flows for the current web Declaration bool DisableFlows { get; set; } Property Value System.Boolean DisableRecommendedItems Gets or sets whether the recommended items are disabled on this site. Declaration bool DisableRecommendedItems { get; set; } Property Value System.Boolean DocumentLibraryCalloutOfficeWebAppPreviewersDisabled Determines if the Document Library Callout's WAC previewers are enabled or not. Declaration bool DocumentLibraryCalloutOfficeWebAppPreviewersDisabled { get; } Property Value System.Boolean EffectiveBasePermissions Get's the permission levels set on this web Declaration IBasePermissions EffectiveBasePermissions { get; } Property Value IBasePermissions EnableMinimalDownload Gets or sets a Boolean value that specifies whether the Web site should use Minimal Download Strategy. Declaration bool EnableMinimalDownload { get; set; } Property Value System.Boolean EventReceivers Event Receivers defined in this web Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IEventReceiverDefinitionCollection EventReceivers { get; } Property Value IEventReceiverDefinitionCollection ExcludeFromOfflineClient Defines whether to exclude the web from offline client Declaration bool ExcludeFromOfflineClient { get; set; } Property Value System.Boolean Features Collection of features enabled for the web Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFeatureCollection Features { get; } Property Value IFeatureCollection Fields Collection of fields in the current Web object Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFieldCollection Fields { get; } Property Value IFieldCollection Folders Collection of folders in the current Web object Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFolderCollection Folders { get; } Property Value IFolderCollection FooterEmphasis Gets or sets the value of the footer emphasis. Declaration FooterVariantThemeType FooterEmphasis { get; set; } Property Value FooterVariantThemeType FooterEnabled Gets or sets a value that specifies whether the footer is enabled on the site. Declaration bool FooterEnabled { get; set; } Property Value System.Boolean FooterLayout Gets or sets the value of the footer layout. Declaration FooterLayoutType FooterLayout { get; set; } Property Value FooterLayoutType HeaderEmphasis Gets or sets the value of the header emphasis. Declaration VariantThemeType HeaderEmphasis { get; set; } Property Value VariantThemeType HeaderLayout Gets or sets the value of the header layout. Declaration HeaderLayoutType HeaderLayout { get; set; } Property Value HeaderLayoutType HideTitleInHeader Gets or sets a value that specifies whether the title in header is hidden on the site. Declaration bool HideTitleInHeader { get; set; } Property Value System.Boolean HorizontalQuickLaunch Defines whether to enable the Horizontal QuickLaunch for the current web Declaration bool HorizontalQuickLaunch { get; set; } Property Value System.Boolean Id The Unique ID of the Web object Declaration Guid Id { get; } Property Value Guid IsHomepageModernized Gets a value that indicates whether the homepage is modernized. Declaration bool IsHomepageModernized { get; } Property Value System.Boolean IsMultilingual Defines whether to enable Multilingual capabilities for the current web Declaration bool IsMultilingual { get; set; } Property Value System.Boolean IsProvisioningComplete Gets a value that indicates whether the provisioning is complete. Declaration bool IsProvisioningComplete { get; } Property Value System.Boolean IsRevertHomepageLinkHidden Gets or sets a value that specifies whether the link to revert homepage is hidden. Declaration bool IsRevertHomepageLinkHidden { get; set; } Property Value System.Boolean Language Gets a value that specifies the LCID for the language that is used on the site. Declaration int Language { get; } Property Value System.Int32 LastItemModifiedDate Gets a value that specifies when an item was last modified in the site. Declaration DateTime LastItemModifiedDate { get; } Property Value DateTime LastItemUserModifiedDate Gets a value that specifies when an item was last modified by user in the site. Declaration DateTime LastItemUserModifiedDate { get; } Property Value DateTime Lists Collection of lists in the current Web object. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IListCollection Lists { get; } Property Value IListCollection LogoAlignment Gets or sets the logo alignment of the site. Declaration LogoAlignment LogoAlignment { get; set; } Property Value LogoAlignment MasterUrl Gets or sets the URL of the master page that is used for the website. Declaration string MasterUrl { get; set; } Property Value System.String MegaMenuEnabled Gets or sets a value that specifies whether the megamenu is enabled on the site. Declaration bool MegaMenuEnabled { get; set; } Property Value System.Boolean MembersCanShare Defines whether members can share content from the current web Declaration bool MembersCanShare { get; set; } Property Value System.Boolean NavAudienceTargetingEnabled Gets or sets a value that specifies whether the audience targeting is enabled on the navigation of the site. Declaration bool NavAudienceTargetingEnabled { get; set; } Property Value System.Boolean Navigation Navigation on the Web Declaration INavigation Navigation { get; } Property Value INavigation NextStepsFirstRunEnabled Gets or sets a value that specifies if the Next steps pane should open automatically as a first run experience when someone visits the site. You can only enable the experience for sites created on or after January 1, 2020 Declaration bool NextStepsFirstRunEnabled { get; set; } Property Value System.Boolean NoCrawl Defines whether the site has to be crawled or not Declaration bool NoCrawl { get; set; } Property Value System.Boolean NotificationsInOneDriveForBusinessEnabled Returns if true if the tenant allowed to send push notifications in OneDrive for Business. Declaration bool NotificationsInOneDriveForBusinessEnabled { get; } Property Value System.Boolean NotificationsInSharePointEnabled Returns if true if the tenant allowed to send push notifications in SharePoint. Declaration bool NotificationsInSharePointEnabled { get; } Property Value System.Boolean ObjectCacheEnabled Gets or sets a value that specifies whether the object cache is enabled on the site. Declaration bool ObjectCacheEnabled { get; set; } Property Value System.Boolean OverwriteTranslationsOnChange Defines whether to OverwriteTranslationsOnChange on change for the current web Declaration bool OverwriteTranslationsOnChange { get; set; } Property Value System.Boolean PreviewFeaturesEnabled Indicates whether the tenant administrator has chosen to disable the Preview Features. Default is true. Declaration bool PreviewFeaturesEnabled { get; } Property Value System.Boolean PrimaryColor Gets or sets the primary color of the site. Declaration string PrimaryColor { get; } Property Value System.String QuickLaunchEnabled Enables or disables the QuickLaunch for the site Declaration bool QuickLaunchEnabled { get; set; } Property Value System.Boolean RecycleBin Gets the recycle bin of the website. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IRecycleBinItemCollection RecycleBin { get; } Property Value IRecycleBinItemCollection RecycleBinEnabled Gets or sets a value that specifies whether the Recycle Bin is enabled. Declaration bool RecycleBinEnabled { get; set; } Property Value System.Boolean RegionalSettings Regional settings configured for this web Declaration IRegionalSettings RegionalSettings { get; } Property Value IRegionalSettings RequestAccessEmail The email address to which any access request will be sent Declaration string RequestAccessEmail { get; set; } Property Value System.String RoleDefinitions Role Definitions defined in this web Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IRoleDefinitionCollection RoleDefinitions { get; } Property Value IRoleDefinitionCollection RootFolder Gets the root folder for the website. Declaration IFolder RootFolder { get; } Property Value IFolder SaveSiteAsTemplateEnabled Gets or sets a Boolean value that specifies whether the Web site can be saved as a site template. Declaration bool SaveSiteAsTemplateEnabled { get; set; } Property Value System.Boolean SearchBoxInNavBar Define if the suitebar search box should show or not Declaration SearchBoxInNavBar SearchBoxInNavBar { get; set; } Property Value SearchBoxInNavBar SearchBoxPlaceholderText Search placeholder text for search box in navbar - overrides default placeholder text if set, returns null if not set. Declaration string SearchBoxPlaceholderText { get; set; } Property Value System.String SearchScope Defines the SearchScope for the site Declaration SearchScope SearchScope { get; set; } Property Value SearchScope ServerRelativeUrl Gets the server relative URL of the current site. Declaration string ServerRelativeUrl { get; } Property Value System.String SiteGroups Gets the collection of all groups that belong to the site collection. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration ISharePointGroupCollection SiteGroups { get; } Property Value ISharePointGroupCollection SiteLogoDescription Gets or sets the description of the Web site logo. Declaration string SiteLogoDescription { get; set; } Property Value System.String SiteLogoUrl Gets or sets the server-relative URL of the Web site logo. This can also contain an absolute URL to the logo. Declaration string SiteLogoUrl { get; set; } Property Value System.String SiteUserInfoList Gets the UserInfo list of the site collection that contains the website. Declaration IList SiteUserInfoList { get; } Property Value IList SiteUsers Gets the collection of all users that belong to the site collection. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration ISharePointUserCollection SiteUsers { get; } Property Value ISharePointUserCollection SupportedUILanguageIds List of languages (expressed via their id) that this site supports Declaration List SupportedUILanguageIds { get; } Property Value PnP.Core.Model.SharePoint.List < System.Int32 > SyndicationEnabled Gets or sets a value that specifies whether the RSS feeds are enabled on the site. Declaration bool SyndicationEnabled { get; set; } Property Value System.Boolean TenantAdminMembersCanShare Gets or sets a value that specifies how the tenant admin members can share. Declaration SharingState TenantAdminMembersCanShare { get; } Property Value SharingState ThemeData Get JSON serialized ThemeData for the current web. Declaration string ThemeData { get; } Property Value System.String ThirdPartyMdmEnabled Gets a value that indicates whether third party MDM (Mobile Device Management) is enabled on the site. Declaration bool ThirdPartyMdmEnabled { get; } Property Value System.Boolean Title The Title of the Site, optional attribute. Declaration string Title { get; set; } Property Value System.String TreeViewEnabled Gets or sets value that specifies whether the tree view is enabled on the site. Declaration bool TreeViewEnabled { get; set; } Property Value System.Boolean Url The URL of the Web object Declaration Uri Url { get; } Property Value Uri UseAccessRequestDefault Determines if we need to use the default access request If this value is True we send access requests to owner/owner's group If this value is False we send access requests to the configured AccessRequestEmail Declaration bool UseAccessRequestDefault { get; } Property Value System.Boolean UserCustomActions Gets a value that specifies the collection of user custom actions for the site. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IUserCustomActionCollection UserCustomActions { get; } Property Value IUserCustomActionCollection Webs Collection of webs in this current web Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IWebCollection Webs { get; } Property Value IWebCollection WebTemplate Gets the name of the site definition or site template that was used to create the site. Declaration string WebTemplate { get; } Property Value System.String WebTemplateConfiguration Gets the web template configuration of the site. Declaration string WebTemplateConfiguration { get; } Property Value System.String WebTemplatesGalleryFirstRunEnabled Gets or sets a value that specifies if the web templates experience should open automatically as a first run experience after the site was created Declaration bool WebTemplatesGalleryFirstRunEnabled { get; set; } Property Value System.Boolean WelcomePage Specifies a string that contains the site-relative URL to which users are redirected when web is browsed (typically the site's home page). Declaration string WelcomePage { get; } Property Value System.String Methods AddIndexedProperty(String) Adds a web property as an indexed property Declaration bool AddIndexedProperty(string propertyName) Parameters System.String propertyName The property name Returns System.Boolean True if it was successfully added or if it is already exists otherwise false Remarks The property must already exist as metadata of the Web AddIndexedPropertyAsync(String) Adds a web property as an indexed property Declaration Task AddIndexedPropertyAsync(string propertyName) Parameters System.String propertyName The property name Returns Task < System.Boolean > True if it was successfully added or if it is already exists otherwise false Remarks The property must already exist as metadata of the Web AsSyntexContentCenter() Returns the current web as ISyntexContentCenter if the web is a Syntex Content Center, null is returned otherwise Declaration ISyntexContentCenter AsSyntexContentCenter() Returns ISyntexContentCenter The current web as ISyntexContentCenter AsSyntexContentCenterAsync() Returns the current web as ISyntexContentCenter if the web is a Syntex Content Center, null is returned otherwise Declaration Task AsSyntexContentCenterAsync() Returns Task < ISyntexContentCenter > The current web as ISyntexContentCenter CheckIfUserHasPermissions(String, PermissionKind) Checks if a user has a specific kind of permissions to a web Declaration bool CheckIfUserHasPermissions(string userPrincipalName, PermissionKind permissionKind) Parameters System.String userPrincipalName Login name of the user you wish to check if he has a specific permission PermissionKind permissionKind Permission kind to check Returns System.Boolean Boolean that says if the user has permissions or not CheckIfUserHasPermissionsAsync(String, PermissionKind) Checks if a user has a specific kind of permissions to a web Declaration Task CheckIfUserHasPermissionsAsync(string userPrincipalName, PermissionKind permissionKind) Parameters System.String userPrincipalName Login name of the user you wish to check if he has a specific permission PermissionKind permissionKind Permission kind to check Returns Task < System.Boolean > Boolean that says if the user has permissions or not EnsureEveryoneExceptExternalUsers() Retrieves everyone except external users and ensures the user in the current web Declaration ISharePointUser EnsureEveryoneExceptExternalUsers() Returns ISharePointUser The ensured ISharePointUser EnsureEveryoneExceptExternalUsersAsync() Retrieves everyone except external users and ensures the user in the current web Declaration Task EnsureEveryoneExceptExternalUsersAsync() Returns Task < ISharePointUser > The ensured ISharePointUser EnsureMultilingual(List) Ensure a site can support multilingual (pages) for the passed along languages Declaration void EnsureMultilingual(List requiredLanguageIds) Parameters PnP.Core.Model.SharePoint.List < System.Int32 > requiredLanguageIds List of langauges to support for multilingual on this site. See https://capacreative.co.uk/resources/reference-sharepoint-online-languages-ids/ for information on the language ids EnsureMultilingualAsync(List) Ensure a site can support multilingual (pages) for the passed along languages Declaration Task EnsureMultilingualAsync(List requiredLanguageIds) Parameters PnP.Core.Model.SharePoint.List < System.Int32 > requiredLanguageIds List of langauges to support for multilingual on this site. See https://capacreative.co.uk/resources/reference-sharepoint-online-languages-ids/ for information on the language ids Returns Task EnsurePageScheduling() Ensures that page publishing can work for this site. Page scheduling only works for the root web of a site collection Declaration void EnsurePageScheduling() EnsurePageSchedulingAsync() Ensures that page publishing can work for this site. Page scheduling only works for the root web of a site collection Declaration Task EnsurePageSchedulingAsync() Returns Task EnsureUser(String) Ensures the given users exists Declaration ISharePointUser EnsureUser(string userPrincipalName) Parameters System.String userPrincipalName UserPrincipalName value of the user to verify Returns ISharePointUser The ensured ISharePointUser EnsureUserAsync(String) Ensures the given users exists Declaration Task EnsureUserAsync(string userPrincipalName) Parameters System.String userPrincipalName UserPrincipalName value of the user to verify Returns Task < ISharePointUser > The ensured ISharePointUser EnsureUserBatch(Batch, String) Ensures the given users exists Declaration ISharePointUser EnsureUserBatch(Batch batch, string userPrincipalName) Parameters Batch batch Batch to add this request to System.String userPrincipalName UserPrincipalName value of the user to verify Returns ISharePointUser The ensured ISharePointUser EnsureUserBatch(String) Ensures the given users exists Declaration ISharePointUser EnsureUserBatch(string userPrincipalName) Parameters System.String userPrincipalName UserPrincipalName value of the user to verify Returns ISharePointUser The ensured ISharePointUser EnsureUserBatchAsync(Batch, String) Ensures the given users exists Declaration Task EnsureUserBatchAsync(Batch batch, string userPrincipalName) Parameters Batch batch Batch to add this request to System.String userPrincipalName UserPrincipalName value of the user to verify Returns Task < ISharePointUser > The ensured ISharePointUser EnsureUserBatchAsync(String) Ensures the given users exists Declaration Task EnsureUserBatchAsync(string userPrincipalName) Parameters System.String userPrincipalName UserPrincipalName value of the user to verify Returns Task < ISharePointUser > The ensured ISharePointUser GetBrandingManager() Returns the branding manager which can be used to change the look of the web Declaration IBrandingManager GetBrandingManager() Returns IBrandingManager An IBrandingManager instance GetCurrentUser() Get's the current logged on user making the request to SharePoint Declaration ISharePointUser GetCurrentUser() Returns ISharePointUser The current ISharePointUser GetCurrentUserAsync() Get's the current logged on user making the request to SharePoint Declaration Task GetCurrentUserAsync() Returns Task < ISharePointUser > The current ISharePointUser GetCurrentUserBatch() Get's the current logged on user making the request to SharePoint Declaration ISharePointUser GetCurrentUserBatch() Returns ISharePointUser The current ISharePointUser GetCurrentUserBatch(Batch) Get's the current logged on user making the request to SharePoint Declaration ISharePointUser GetCurrentUserBatch(Batch batch) Parameters Batch batch Batch to add this request to Returns ISharePointUser The current ISharePointUser GetCurrentUserBatchAsync() Get's the current logged on user making the request to SharePoint Declaration Task GetCurrentUserBatchAsync() Returns Task < ISharePointUser > The current ISharePointUser GetCurrentUserBatchAsync(Batch) Get's the current logged on user making the request to SharePoint Declaration Task GetCurrentUserBatchAsync(Batch batch) Parameters Batch batch Batch to add this request to Returns Task < ISharePointUser > The current ISharePointUser GetFileById(Guid, Expression>[]) Get a file in the current web from its unique id. Declaration IFile GetFileById(Guid uniqueFileId, params Expression>[] expressions) Parameters Guid uniqueFileId The unique id of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get GetFileByIdAsync(Guid, Expression>[]) Get a file in the current web from its unique id. Declaration Task GetFileByIdAsync(Guid uniqueFileId, params Expression>[] expressions) Parameters Guid uniqueFileId The unique id of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get GetFileByIdBatch(Guid, Expression>[]) Get a file in the current web from its unique id via batch. Declaration IFile GetFileByIdBatch(Guid uniqueFileId, params Expression>[] expressions) Parameters Guid uniqueFileId The unique id of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get GetFileByIdBatch(Batch, Guid, Expression>[]) Get a file in the current web from its unique id via batch. Declaration IFile GetFileByIdBatch(Batch batch, Guid uniqueFileId, params Expression>[] expressions) Parameters Batch batch Batch to add this request to Guid uniqueFileId The unique id of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get GetFileByIdBatchAsync(Guid, Expression>[]) Get a file in the current web from its unique id via batch. Declaration Task GetFileByIdBatchAsync(Guid uniqueFileId, params Expression>[] expressions) Parameters Guid uniqueFileId The unique id of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get GetFileByIdBatchAsync(Batch, Guid, Expression>[]) Get a file in the current web from its unique id via batch. Declaration Task GetFileByIdBatchAsync(Batch batch, Guid uniqueFileId, params Expression>[] expressions) Parameters Batch batch Batch to add this request to Guid uniqueFileId The unique id of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get GetFileByLink(String, Expression>[]) Get's a file from a given link (sharing link, path to file) Declaration IFile GetFileByLink(string link, params Expression>[] expressions) Parameters System.String link Link pointing to a file Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns IFile IFile reference when the file could be found, exception otherwise GetFileByLinkAsync(String, Expression>[]) Get's a file from a given link (sharing link, path to file) Declaration Task GetFileByLinkAsync(string link, params Expression>[] expressions) Parameters System.String link Link pointing to a file Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > IFile reference when the file could be found, exception otherwise GetFileByServerRelativeUrl(String, Expression>[]) Get a file in the current web from its server relative URL. Declaration IFile GetFileByServerRelativeUrl(string serverRelativeUrl, params Expression>[] expressions) Parameters System.String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get GetFileByServerRelativeUrlAsync(String, Expression>[]) Get a file in the current web from its server relative URL. Declaration Task GetFileByServerRelativeUrlAsync(string serverRelativeUrl, params Expression>[] expressions) Parameters System.String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get GetFileByServerRelativeUrlBatch(Batch, String, Expression>[]) Get a file in the current web from its server relative URL via batch. Declaration IFile GetFileByServerRelativeUrlBatch(Batch batch, string serverRelativeUrl, params Expression>[] expressions) Parameters Batch batch Batch to add this request to System.String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get GetFileByServerRelativeUrlBatch(String, Expression>[]) Get a file in the current web from its server relative URL via batch. Declaration IFile GetFileByServerRelativeUrlBatch(string serverRelativeUrl, params Expression>[] expressions) Parameters System.String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get GetFileByServerRelativeUrlBatchAsync(Batch, String, Expression>[]) Get a file in the current web from its server relative URL via batch. Declaration Task GetFileByServerRelativeUrlBatchAsync(Batch batch, string serverRelativeUrl, params Expression>[] expressions) Parameters Batch batch Batch to add this request to System.String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get GetFileByServerRelativeUrlBatchAsync(String, Expression>[]) Get a file in the current web from its server relative URL via batch. Declaration Task GetFileByServerRelativeUrlBatchAsync(string serverRelativeUrl, params Expression>[] expressions) Parameters System.String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get GetFileByServerRelativeUrlOrDefault(String, Expression>[]) Get a file in the current web from its server relative URL, it not available null will be returned Declaration IFile GetFileByServerRelativeUrlOrDefault(string serverRelativeUrl, params Expression>[] expressions) Parameters System.String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get or null if the file was not available GetFileByServerRelativeUrlOrDefaultAsync(String, Expression>[]) Get a file in the current web from its server relative URL, it not available null will be returned Declaration Task GetFileByServerRelativeUrlOrDefaultAsync(string serverRelativeUrl, params Expression>[] expressions) Parameters System.String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get or null if the file was not available GetFolderById(Guid, Expression>[]) Get a folder in the current web from its id. Declaration IFolder GetFolderById(Guid folderId, params Expression>[] expressions) Parameters Guid folderId The id of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns IFolder The folder to get GetFolderByIdAsync(Guid, Expression>[]) Get a folder in the current web from its id. Declaration Task GetFolderByIdAsync(Guid folderId, params Expression>[] expressions) Parameters Guid folderId The id of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns Task < IFolder > The folder to get GetFolderByIdBatch(Guid, Expression>[]) Get a folder in the current web from its id via batch. Declaration IFolder GetFolderByIdBatch(Guid folderId, params Expression>[] expressions) Parameters Guid folderId The id of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns IFolder The folder to get GetFolderByIdBatch(Batch, Guid, Expression>[]) Get a folder in the current web from its id via batch. Declaration IFolder GetFolderByIdBatch(Batch batch, Guid folderId, params Expression>[] expressions) Parameters Batch batch Batch to add this request to Guid folderId The id of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns IFolder The folder to get GetFolderByIdBatchAsync(Guid, Expression>[]) Get a folder in the current web from its id via batch. Declaration Task GetFolderByIdBatchAsync(Guid folderId, params Expression>[] expressions) Parameters Guid folderId The id of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns Task < IFolder > The folder to get GetFolderByIdBatchAsync(Batch, Guid, Expression>[]) Get a folder in the current web from its id via batch. Declaration Task GetFolderByIdBatchAsync(Batch batch, Guid folderId, params Expression>[] expressions) Parameters Batch batch Batch to add this request to Guid folderId The id of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns Task < IFolder > The folder to get GetFolderByServerRelativeUrl(String, Expression>[]) Get a folder in the current web from its server relative URL. Declaration IFolder GetFolderByServerRelativeUrl(string serverRelativeUrl, params Expression>[] expressions) Parameters System.String serverRelativeUrl The server relative URL of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns IFolder The folder to get GetFolderByServerRelativeUrlAsync(String, Expression>[]) Get a folder in the current web from its server relative URL. Declaration Task GetFolderByServerRelativeUrlAsync(string serverRelativeUrl, params Expression>[] expressions) Parameters System.String serverRelativeUrl The server relative URL of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns Task < IFolder > The folder to get GetFolderByServerRelativeUrlBatch(Batch, String, Expression>[]) Get a folder in the current web from its server relative URL via batch. Declaration IFolder GetFolderByServerRelativeUrlBatch(Batch batch, string serverRelativeUrl, params Expression>[] expressions) Parameters Batch batch Batch to add this request to System.String serverRelativeUrl The server relative URL of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns IFolder The folder to get GetFolderByServerRelativeUrlBatch(String, Expression>[]) Get a folder in the current web from its server relative URL via batch. Declaration IFolder GetFolderByServerRelativeUrlBatch(string serverRelativeUrl, params Expression>[] expressions) Parameters System.String serverRelativeUrl The server relative URL of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns IFolder The folder to get GetFolderByServerRelativeUrlBatchAsync(Batch, String, Expression>[]) Get a folder in the current web from its server relative URL via batch. Declaration Task GetFolderByServerRelativeUrlBatchAsync(Batch batch, string serverRelativeUrl, params Expression>[] expressions) Parameters Batch batch Batch to add this request to System.String serverRelativeUrl The server relative URL of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns Task < IFolder > The folder to get GetFolderByServerRelativeUrlBatchAsync(String, Expression>[]) Get a folder in the current web from its server relative URL via batch. Declaration Task GetFolderByServerRelativeUrlBatchAsync(string serverRelativeUrl, params Expression>[] expressions) Parameters System.String serverRelativeUrl The server relative URL of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns Task < IFolder > The folder to get GetPages(String) Gets the modern pages of this site, optionally scoped down via a filter Declaration List GetPages(string pageName = null) Parameters System.String pageName Page name to filter on, uses a \"starts with\" filter Returns PnP.Core.Model.SharePoint.List < IPage > One of more modern pages GetPagesAsync(String) Gets the modern pages of this site, optionally scoped down via a filter Declaration Task> GetPagesAsync(string pageName = null) Parameters System.String pageName Page name to filter on, uses a \"starts with\" filter Returns Task < PnP.Core.Model.SharePoint.List < IPage >> One of more modern pages GetRecycleBinItemsByQuery(RecycleBinQueryOptions) Searches the recyclebin returning items based upon the passed search criteria Declaration IRecycleBinItemCollection GetRecycleBinItemsByQuery(RecycleBinQueryOptions options) Parameters RecycleBinQueryOptions options Recycle bin search criteria Returns IRecycleBinItemCollection A list containing zero or more recycle bin items GetRecycleBinItemsByQueryAsync(RecycleBinQueryOptions) Searches the recyclebin returning items based upon the passed search criteria Declaration Task GetRecycleBinItemsByQueryAsync(RecycleBinQueryOptions options) Parameters RecycleBinQueryOptions options Recycle bin search criteria Returns Task < IRecycleBinItemCollection > A list containing zero or more recycle bin items GetRecycleBinItemsByQueryBatch(RecycleBinQueryOptions) Searches the recyclebin returning items based upon the passed search criteria Declaration IRecycleBinItemCollection GetRecycleBinItemsByQueryBatch(RecycleBinQueryOptions options) Parameters RecycleBinQueryOptions options Recycle bin search criteria Returns IRecycleBinItemCollection A list containing zero or more recycle bin items GetRecycleBinItemsByQueryBatch(Batch, RecycleBinQueryOptions) Searches the recyclebin returning items based upon the passed search criteria Declaration IRecycleBinItemCollection GetRecycleBinItemsByQueryBatch(Batch batch, RecycleBinQueryOptions options) Parameters Batch batch Batch to add this request to RecycleBinQueryOptions options Recycle bin search criteria Returns IRecycleBinItemCollection A list containing zero or more recycle bin items GetRecycleBinItemsByQueryBatchAsync(RecycleBinQueryOptions) Searches the recyclebin returning items based upon the passed search criteria Declaration Task GetRecycleBinItemsByQueryBatchAsync(RecycleBinQueryOptions options) Parameters RecycleBinQueryOptions options Recycle bin search criteria Returns Task < IRecycleBinItemCollection > A list containing zero or more recycle bin items GetRecycleBinItemsByQueryBatchAsync(Batch, RecycleBinQueryOptions) Searches the recyclebin returning items based upon the passed search criteria Declaration Task GetRecycleBinItemsByQueryBatchAsync(Batch batch, RecycleBinQueryOptions options) Parameters Batch batch Batch to add this request to RecycleBinQueryOptions options Recycle bin search criteria Returns Task < IRecycleBinItemCollection > A list containing zero or more recycle bin items GetSearchConfigurationManagedProperties() Gets the managed properties from the search configuration of this web Declaration List GetSearchConfigurationManagedProperties() Returns PnP.Core.Model.SharePoint.List < IManagedProperty > List of managed properties GetSearchConfigurationManagedPropertiesAsync() Gets the managed properties from the search configuration of this web Declaration Task> GetSearchConfigurationManagedPropertiesAsync() Returns Task < PnP.Core.Model.SharePoint.List < IManagedProperty >> List of managed properties GetSearchConfigurationXml() Gets the search configuration of the web Declaration string GetSearchConfigurationXml() Returns System.String Search configuration XML GetSearchConfigurationXmlAsync() Gets the search configuration of the web Declaration Task GetSearchConfigurationXmlAsync() Returns Task < System.String > Search configuration XML GetUserById(Int32) Get's a user by it's id in this site. The user needs to exist, use EnsureUser(String) if you want to create the user if it does not yet exist Declaration ISharePointUser GetUserById(int userId) Parameters System.Int32 userId Id of the user to get Returns ISharePointUser The found user as ISharePointPrincipal GetUserByIdAsync(Int32) Get's a user by it's id in this site. The user needs to exist, use EnsureUserAsync(String) if you want to create the user if it does not yet exist Declaration Task GetUserByIdAsync(int userId) Parameters System.Int32 userId Id of the user to get Returns Task < ISharePointUser > The found user as ISharePointPrincipal GetUserByIdBatch(Batch, Int32) Get's a user by it's id in this site. The user needs to exist, use EnsureUserBatch(String) if you want to create the user if it does not yet exist Declaration ISharePointUser GetUserByIdBatch(Batch batch, int userId) Parameters Batch batch Batch to add this request to System.Int32 userId Id of the user to get Returns ISharePointUser The found user as ISharePointPrincipal GetUserByIdBatch(Int32) Get's a user by it's id in this site. The user needs to exist, use EnsureUserBatch(String) if you want to create the user if it does not yet exist Declaration ISharePointUser GetUserByIdBatch(int userId) Parameters System.Int32 userId Id of the user to get Returns ISharePointUser The found user as ISharePointPrincipal GetUserByIdBatchAsync(Batch, Int32) Get's a user by it's id in this site. The user needs to exist, use EnsureUserBatchAsync(String) if you want to create the user if it does not yet exist Declaration Task GetUserByIdBatchAsync(Batch batch, int userId) Parameters Batch batch Batch to add this request to System.Int32 userId Id of the user to get Returns Task < ISharePointUser > The found user as ISharePointPrincipal GetUserByIdBatchAsync(Int32) Get's a user by it's id in this site. The user needs to exist, use EnsureUserBatchAsync(String) if you want to create the user if it does not yet exist Declaration Task GetUserByIdBatchAsync(int userId) Parameters System.Int32 userId Id of the user to get Returns Task < ISharePointUser > The found user as ISharePointPrincipal GetUserEffectivePermissions(String) Gets the user effective permissions of a user for a web Declaration IBasePermissions GetUserEffectivePermissions(string userPrincipalName) Parameters System.String userPrincipalName Login name of the user you wish to retrieve the permissions of Returns IBasePermissions Base permissions object that contains the High and the Low permissions GetUserEffectivePermissionsAsync(String) Gets the user effective permissions of a user for a web Declaration Task GetUserEffectivePermissionsAsync(string userPrincipalName) Parameters System.String userPrincipalName Login name of the user you wish to retrieve the permissions of Returns Task < IBasePermissions > Base permissions object that contains the High and the Low permissions GetVivaDashboard() Gets Viva Connections dashboard. If there is no dashboard configured, returns null Declaration IVivaDashboard GetVivaDashboard() Returns IVivaDashboard Viva Dashboard or null GetVivaDashboardAsync() Gets Viva Connections dashboard. If there is no dashboard configured, returns null Declaration Task GetVivaDashboardAsync() Returns Task < IVivaDashboard > Viva Dashboard or null GetWebTemplateByName(String, Int32, Boolean) Return a specific web template based by a name Declaration IWebTemplate GetWebTemplateByName(string name, int lcid = 1033, bool includeCrossLanguage = false) Parameters System.String name Name of the template to retrieve System.Int32 lcid Specifies the LCID of the site templates to be retrieved. System.Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns IWebTemplate The template with the specified name, if available GetWebTemplateByNameAsync(String, Int32, Boolean) Return a specific web template based by a name Declaration Task GetWebTemplateByNameAsync(string name, int lcid = 1033, bool includeCrossLanguage = false) Parameters System.String name Name of the template to retrieve System.Int32 lcid Specifies the LCID of the site templates to be retrieved. System.Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns Task < IWebTemplate > The template with the specified name, if available GetWebTemplateByNameBatch(Batch, String, Int32, Boolean) Return a specific web template based by a name Declaration IBatchSingleResult GetWebTemplateByNameBatch(Batch batch, string name, int lcid = 1033, bool includeCrossLanguage = false) Parameters Batch batch Batch to add this request to System.String name Name of the template to retrieve System.Int32 lcid Specifies the LCID of the site templates to be retrieved. System.Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns IBatchSingleResult < IWebTemplate > The template with the specified name, if available GetWebTemplateByNameBatch(String, Int32, Boolean) Return a specific web template based by a name Declaration IBatchSingleResult GetWebTemplateByNameBatch(string name, int lcid = 1033, bool includeCrossLanguage = false) Parameters System.String name Name of the template to retrieve System.Int32 lcid Specifies the LCID of the site templates to be retrieved. System.Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns IBatchSingleResult < IWebTemplate > The template with the specified name, if available GetWebTemplateByNameBatchAsync(Batch, String, Int32, Boolean) Return a specific web template based by a name Declaration Task> GetWebTemplateByNameBatchAsync(Batch batch, string name, int lcid = 1033, bool includeCrossLanguage = false) Parameters Batch batch Batch to add this request to System.String name Name of the template to retrieve System.Int32 lcid Specifies the LCID of the site templates to be retrieved. System.Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns Task < IBatchSingleResult < IWebTemplate >> The template with the specified name, if available GetWebTemplateByNameBatchAsync(String, Int32, Boolean) Return a specific web template based by a name Declaration Task> GetWebTemplateByNameBatchAsync(string name, int lcid = 1033, bool includeCrossLanguage = false) Parameters System.String name Name of the template to retrieve System.Int32 lcid Specifies the LCID of the site templates to be retrieved. System.Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns Task < IBatchSingleResult < IWebTemplate >> The list of webtemplates available on the current web GetWebTemplates(Int32, Boolean) Returns a collection of site templates available for the site. Declaration List GetWebTemplates(int lcid = 1033, bool includeCrossLanguage = false) Parameters System.Int32 lcid Specifies the LCID of the site templates to be retrieved. System.Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns PnP.Core.Model.SharePoint.List < IWebTemplate > The list of webtemplates available on the current web GetWebTemplatesAsync(Int32, Boolean) Returns a collection of site templates available for the site. Declaration Task> GetWebTemplatesAsync(int lcid = 1033, bool includeCrossLanguage = false) Parameters System.Int32 lcid Specifies the LCID of the site templates to be retrieved. System.Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns Task < PnP.Core.Model.SharePoint.List < IWebTemplate >> The list of webtemplates available on the current web GetWebTemplatesBatch(Batch, Int32, Boolean) Returns a collection of site templates available for the site. Declaration IEnumerableBatchResult GetWebTemplatesBatch(Batch batch, int lcid = 1033, bool includeCrossLanguage = false) Parameters Batch batch Batch to add this request to System.Int32 lcid Specifies the LCID of the site templates to be retrieved. System.Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns IEnumerableBatchResult < IWebTemplate > The list of webtemplates available on the current web GetWebTemplatesBatch(Int32, Boolean) Returns a collection of site templates available for the site. Declaration IEnumerableBatchResult GetWebTemplatesBatch(int lcid = 1033, bool includeCrossLanguage = false) Parameters System.Int32 lcid Specifies the LCID of the site templates to be retrieved. System.Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns IEnumerableBatchResult < IWebTemplate > The list of webtemplates available on the current web GetWebTemplatesBatchAsync(Batch, Int32, Boolean) Returns a collection of site templates available for the site. Declaration Task> GetWebTemplatesBatchAsync(Batch batch, int lcid = 1033, bool includeCrossLanguage = false) Parameters Batch batch Batch to add this request to System.Int32 lcid Specifies the LCID of the site templates to be retrieved. System.Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns Task < IEnumerableBatchResult < IWebTemplate >> The list of webtemplates available on the current web GetWebTemplatesBatchAsync(Int32, Boolean) Returns a collection of site templates available for the site. Declaration Task> GetWebTemplatesBatchAsync(int lcid = 1033, bool includeCrossLanguage = false) Parameters System.Int32 lcid Specifies the LCID of the site templates to be retrieved. System.Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns Task < IEnumerableBatchResult < IWebTemplate >> The list of webtemplates available on the current web GetWssIdForTerm(String) Returns the Id for a term if present in the TaxonomyHiddenList. Otherwise returns -1; Declaration int GetWssIdForTerm(string termId) Parameters System.String termId Id of the term to lookup Returns System.Int32 Id of the term in the taxonomy hidden list, otherwise -1 GetWssIdForTermAsync(String) Returns the Id for a term if present in the TaxonomyHiddenList. Otherwise returns -1; Declaration Task GetWssIdForTermAsync(string termId) Parameters System.String termId Id of the term to lookup Returns Task < System.Int32 > Id of the term in the taxonomy hidden list, otherwise -1 HasCommunicationSiteFeatures() Does this web have the communication site features enabled? Declaration bool HasCommunicationSiteFeatures() Returns System.Boolean True if enabled, false otherwise HasCommunicationSiteFeaturesAsync() Does this web have the communication site features enabled? Declaration Task HasCommunicationSiteFeaturesAsync() Returns Task < System.Boolean > True if enabled, false otherwise IsNoScriptSite() Checks if this web is configured for NoScript Declaration bool IsNoScriptSite() Returns System.Boolean True if set to NoScript, false otherwise IsNoScriptSiteAsync() Checks if this web is configured for NoScript Declaration Task IsNoScriptSiteAsync() Returns Task < System.Boolean > True if set to NoScript, false otherwise IsSubSite() Checks if this web is a sub site Declaration bool IsSubSite() Returns System.Boolean True if the web is a sub site IsSubSiteAsync() Checks if this web is a sub site Declaration Task IsSubSiteAsync() Returns Task < System.Boolean > True if the web is a sub site IsSyntexContentCenter() Is this web a Syntex Content Center Declaration bool IsSyntexContentCenter() Returns System.Boolean True if this web is a Syntex Content Center, false otherwise IsSyntexContentCenterAsync() Is this web a Syntex Content Center Declaration Task IsSyntexContentCenterAsync() Returns Task < System.Boolean > True if this web is a Syntex Content Center, false otherwise IsSyntexEnabled() Is the tenant enabled for SharePoint Syntex Declaration bool IsSyntexEnabled() Returns System.Boolean True if SharePoint Syntex is enabled, false otherwise IsSyntexEnabledAsync() Is the tenant enabled for SharePoint Syntex Declaration Task IsSyntexEnabledAsync() Returns Task < System.Boolean > True if SharePoint Syntex is enabled, false otherwise IsSyntexEnabledForCurrentUser() Is SharePoint Syntex enabled for the current user Declaration bool IsSyntexEnabledForCurrentUser() Returns System.Boolean True if SharePoint Syntex is enabled for the current user, false otherwise IsSyntexEnabledForCurrentUserAsync() Is SharePoint Syntex enabled for the current user Declaration Task IsSyntexEnabledForCurrentUserAsync() Returns Task < System.Boolean > True if SharePoint Syntex is enabled for the current user, false otherwise NewPage(PageLayoutType) Creates a new modern page Declaration IPage NewPage(PageLayoutType pageLayoutType = default(PageLayoutType)) Parameters PageLayoutType pageLayoutType Optionally specify the page type, defaults to Article Returns IPage Created modern page NewPageAsync(PageLayoutType) Creates a new modern page Declaration Task NewPageAsync(PageLayoutType pageLayoutType = default(PageLayoutType)) Parameters PageLayoutType pageLayoutType Optionally specify the page type, defaults to Article Returns Task < IPage > Created modern page ReIndex() Reindexes this web Declaration void ReIndex() ReIndexAsync() Reindexes this web Declaration Task ReIndexAsync() Returns Task RemoveIndexedProperty(String) Removes a web propetry from the indexed properties Declaration bool RemoveIndexedProperty(string propertyName) Parameters System.String propertyName The property name Returns System.Boolean True if it was successfully removed otherwise false RemoveIndexedPropertyAsync(String) Removes a web propetry from the indexed properties Declaration Task RemoveIndexedPropertyAsync(string propertyName) Parameters System.String propertyName The property name Returns Task < System.Boolean > True if it was successfully removed otherwise false Search(SearchOptions) Performs a search query Declaration ISearchResult Search(SearchOptions query) Parameters SearchOptions query Search query to run Returns ISearchResult The results of the search query SearchAsync(SearchOptions) Performs a search query Declaration Task SearchAsync(SearchOptions query) Parameters SearchOptions query Search query to run Returns Task < ISearchResult > The results of the search query SearchBatch(SearchOptions) Performs a search query Declaration IBatchSingleResult SearchBatch(SearchOptions query) Parameters SearchOptions query Search query to run Returns IBatchSingleResult < ISearchResult > The results of the search query SearchBatch(Batch, SearchOptions) Performs a search query Declaration IBatchSingleResult SearchBatch(Batch batch, SearchOptions query) Parameters Batch batch Batch to add this request to SearchOptions query Search query to run Returns IBatchSingleResult < ISearchResult > The results of the search query SearchBatchAsync(SearchOptions) Performs a search query Declaration Task> SearchBatchAsync(SearchOptions query) Parameters SearchOptions query Search query to run Returns Task < IBatchSingleResult < ISearchResult >> The results of the search query SearchBatchAsync(Batch, SearchOptions) Performs a search query Declaration Task> SearchBatchAsync(Batch batch, SearchOptions query) Parameters Batch batch Batch to add this request to SearchOptions query Search query to run Returns Task < IBatchSingleResult < ISearchResult >> The results of the search query SetAccessRequest(AccessRequestOption, String) Applies the access request settings Declaration Task SetAccessRequest(AccessRequestOption operation, string email = null) Parameters AccessRequestOption operation The operation to be performed System.String email Applies the email address for the 'SpecificMail' operation Returns Task SetAccessRequestAsync(AccessRequestOption, String) Applies the access request settings Declaration Task SetAccessRequestAsync(AccessRequestOption operation, string email = null) Parameters AccessRequestOption operation The operation to be performed System.String email Applies the email address for the 'SpecificMail' operation Returns Task SetSearchConfigurationXml(String) Sets the search configuration for the web Declaration void SetSearchConfigurationXml(string configuration) Parameters System.String configuration Search configuration, obtained via GetSearchConfigurationXml() to apply SetSearchConfigurationXmlAsync(String) Sets the search configuration for the web Declaration Task SetSearchConfigurationXmlAsync(string configuration) Parameters System.String configuration Search configuration, obtained via GetSearchConfigurationXml() to apply Returns Task SyncHubSiteThemeAsync() Sync the hub site theme from parent hub site Declaration Task SyncHubSiteThemeAsync() Returns Task UnfurlLink(String, UnfurlOptions) Takes in a sharing or regular SharePoint link and tries to provide relavant information about the resource behind the passed in link Declaration IUnfurledResource UnfurlLink(string link, UnfurlOptions unfurlOptions = null) Parameters System.String link Link to resource to get information for UnfurlOptions unfurlOptions Options to control the unfurling data gathering Returns IUnfurledResource Data about the unfurled resource UnfurlLinkAsync(String, UnfurlOptions) Takes in a sharing or regular SharePoint link and tries to provide relavant information about the resource behind the passed in link Declaration Task UnfurlLinkAsync(string link, UnfurlOptions unfurlOptions = null) Parameters System.String link Link to resource to get information for UnfurlOptions unfurlOptions Options to control the unfurling data gathering Returns Task < IUnfurledResource > Data about the unfurled resource ValidateAndEnsureUsers(IList) Checks if the provided list of user UPN's are valid users in Azure AD and returns the 'ensured' SharePoint user Declaration IList ValidateAndEnsureUsers(IList userList) Parameters PnP.Core.Model.SharePoint.IList < System.String > userList List of user UPN's to validate in Azure AD Returns PnP.Core.Model.SharePoint.IList < ISharePointUser > The list of ISharePointUser that exist ValidateAndEnsureUsersAsync(IList) Checks if the provided list of user UPN's are valid users in Azure AD and returns the 'ensured' SharePoint user Declaration Task> ValidateAndEnsureUsersAsync(IList userList) Parameters PnP.Core.Model.SharePoint.IList < System.String > userList List of user UPN's to validate in Azure AD Returns Task < PnP.Core.Model.SharePoint.IList < ISharePointUser >> The list of ISharePointUser that exist ValidateUsers(IList) Checks if the provided list of user UPN's are valid users in Azure AD Declaration IList ValidateUsers(IList userList) Parameters PnP.Core.Model.SharePoint.IList < System.String > userList List of user UPN's to validate in Azure AD Returns PnP.Core.Model.SharePoint.IList < System.String > A list of users that were not found in Azure AD ValidateUsersAsync(IList) Checks if the provided list of user UPN's are valid users in Azure AD Declaration Task> ValidateUsersAsync(IList userList) Parameters PnP.Core.Model.SharePoint.IList < System.String > userList List of user UPN's to validate in Azure AD Returns Task < PnP.Core.Model.SharePoint.IList < System.String >> A list of users that were not found in Azure AD Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>) RequestModuleExtensions.WithResponseHeaders(ISupportModules, Action>)" + "keywords": "Interface IWeb Public interface to define a Web object of SharePoint Online Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() IDataModelSupportingGetChanges.GetChangesAsync(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChanges(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatchAsync(Batch, ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatch(Batch, ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatchAsync(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatch(ChangeQueryOptions) ISecurableObject.RoleAssignments ISecurableObject.HasUniqueRoleAssignments ISecurableObject.BreakRoleInheritance(Boolean, Boolean) ISecurableObject.BreakRoleInheritanceAsync(Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatch(Batch, Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatchAsync(Batch, Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatch(Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatchAsync(Boolean, Boolean) ISecurableObject.ResetRoleInheritance() ISecurableObject.ResetRoleInheritanceAsync() ISecurableObject.ResetRoleInheritanceBatch(Batch) ISecurableObject.ResetRoleInheritanceBatchAsync(Batch) ISecurableObject.ResetRoleInheritanceBatch() ISecurableObject.ResetRoleInheritanceBatchAsync() ISecurableObject.GetRoleDefinitions(Int32) ISecurableObject.GetRoleDefinitionsAsync(Int32) ISecurableObject.AddRoleDefinitions(Int32, String[]) ISecurableObject.AddRoleDefinitionsAsync(Int32, String[]) ISecurableObject.AddRoleDefinition(Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionAsync(Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatch(Batch, Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatchAsync(Batch, Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatch(Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatchAsync(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitions(Int32, String[]) ISecurableObject.RemoveRoleDefinitionsAsync(Int32, String[]) ISecurableObject.RemoveRoleDefinition(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionAsync(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatch(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatchAsync(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatch(Batch, Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatchAsync(Batch, Int32, IRoleDefinition) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IWeb : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IDataModelSupportingGetChanges, ISecurableObject, IQueryableDataModel Properties AccessRequestListUrl Gets the URL of the access request list to the current site. Declaration string AccessRequestListUrl { get; } Property Value System.String AccessRequestSiteDescription Gets or sets the description of the access request to this site. Declaration string AccessRequestSiteDescription { get; set; } Property Value System.String All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object AllowAutomaticASPXPageIndexing Gets a value that specifies whether the automatic ASPX page indexed is allowed. Declaration bool AllowAutomaticASPXPageIndexing { get; set; } Property Value System.Boolean AllowCreateDeclarativeWorkflowForCurrentUser Gets a value that specifies whether the current user is allowed to create declarative workflow on this site. Declaration bool AllowCreateDeclarativeWorkflowForCurrentUser { get; set; } Property Value System.Boolean AllowDesignerForCurrentUser Gets a value that specifies whether the current user is allowed to use a designer application to customize this site. Declaration bool AllowDesignerForCurrentUser { get; set; } Property Value System.Boolean AllowMasterPageEditingForCurrentUser Gets a value that specifies whether the current user is allowed to edit the master page. Declaration bool AllowMasterPageEditingForCurrentUser { get; } Property Value System.Boolean AllowRevertFromTemplateForCurrentUser Gets a value that specifies whether the current user is allowed to revert the site to a default site template. Declaration bool AllowRevertFromTemplateForCurrentUser { get; } Property Value System.Boolean AllowRssFeeds Gets a value that specifies whether the site allows RSS feeds. Declaration bool AllowRssFeeds { get; } Property Value System.Boolean AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser Gets a value that specifies whether the current user is allowed to save declarative workflows as template. Declaration bool AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser { get; } Property Value System.Boolean AllowSavePublishDeclarativeWorkflowForCurrentUser Gets a value that specifies whether the current user is allowed to publish a declarative workflow. Declaration bool AllowSavePublishDeclarativeWorkflowForCurrentUser { get; } Property Value System.Boolean AllProperties Gets a collection of metadata for the Web site. Declaration IPropertyValues AllProperties { get; } Property Value IPropertyValues AlternateCssUrl The AlternateCSS of the Site, optional attribute. Declaration string AlternateCssUrl { get; set; } Property Value System.String AppInstanceId The instance Id of the App Instance that this website represents. Declaration Guid AppInstanceId { get; } Property Value Guid AssociatedMemberGroup Associated SharePoint Member group Declaration ISharePointGroup AssociatedMemberGroup { get; } Property Value ISharePointGroup AssociatedOwnerGroup Associated SharePoint owner group Declaration ISharePointGroup AssociatedOwnerGroup { get; } Property Value ISharePointGroup AssociatedVisitorGroup Associated SharePoint Visitor group Declaration ISharePointGroup AssociatedVisitorGroup { get; } Property Value ISharePointGroup Author Gets the web's author Declaration ISharePointUser Author { get; } Property Value ISharePointUser AvailableContentTypes Gets the collection of all content types that apply to the current scope, including those of the current Web site, as well as any parent Web sites. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IContentTypeCollection AvailableContentTypes { get; } Property Value IContentTypeCollection AvailableFields Gets a value that specifies the collection of all fields available for the current scope, including those of the current site, as well as any parent sites. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFieldCollection AvailableFields { get; } Property Value IFieldCollection CommentsOnSitePagesDisabled Defines whether the comments on site pages are disabled or not Declaration bool CommentsOnSitePagesDisabled { get; set; } Property Value System.Boolean ContainsConfidentialInfo Gets a boolean value that specifies whether the site contains highly confidential information. If the tenant settings don't allow tagging sites as confidential, this property will always return false. Declaration bool ContainsConfidentialInfo { get; set; } Property Value System.Boolean ContentTypes Collection of content types in the current Web object Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IContentTypeCollection ContentTypes { get; } Property Value IContentTypeCollection Created Gets a value that specifies when the site was created. Declaration DateTime Created { get; } Property Value DateTime CurrentUser Gets the current user in the current context Declaration ISharePointUser CurrentUser { get; } Property Value ISharePointUser CustomMasterUrl The Custom MasterPage Url of the Site, optional attribute. Declaration string CustomMasterUrl { get; set; } Property Value System.String DefaultNewPageTemplateId The id of the default new page template. Use SetDefaultNewPageTemplateId to set the value. Declaration Guid DefaultNewPageTemplateId { get; set; } Property Value Guid Description The Description of the Site, optional attribute. Declaration string Description { get; set; } Property Value System.String DesignPackageId Gets or sets the design package Id of this site. Declaration Guid DesignPackageId { get; set; } Property Value Guid DisableAppViews Defines whether disable PowerApps for the current web Declaration bool DisableAppViews { get; set; } Property Value System.Boolean DisableFlows Defines whether disable flows for the current web Declaration bool DisableFlows { get; set; } Property Value System.Boolean DisableRecommendedItems Gets or sets whether the recommended items are disabled on this site. Declaration bool DisableRecommendedItems { get; set; } Property Value System.Boolean DocumentLibraryCalloutOfficeWebAppPreviewersDisabled Determines if the Document Library Callout's WAC previewers are enabled or not. Declaration bool DocumentLibraryCalloutOfficeWebAppPreviewersDisabled { get; } Property Value System.Boolean EffectiveBasePermissions Get's the permission levels set on this web Declaration IBasePermissions EffectiveBasePermissions { get; } Property Value IBasePermissions EnableMinimalDownload Gets or sets a Boolean value that specifies whether the Web site should use Minimal Download Strategy. Declaration bool EnableMinimalDownload { get; set; } Property Value System.Boolean EventReceivers Event Receivers defined in this web Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IEventReceiverDefinitionCollection EventReceivers { get; } Property Value IEventReceiverDefinitionCollection ExcludeFromOfflineClient Defines whether to exclude the web from offline client Declaration bool ExcludeFromOfflineClient { get; set; } Property Value System.Boolean Features Collection of features enabled for the web Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFeatureCollection Features { get; } Property Value IFeatureCollection Fields Collection of fields in the current Web object Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFieldCollection Fields { get; } Property Value IFieldCollection Folders Collection of folders in the current Web object Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFolderCollection Folders { get; } Property Value IFolderCollection FooterEmphasis Gets or sets the value of the footer emphasis. Declaration FooterVariantThemeType FooterEmphasis { get; set; } Property Value FooterVariantThemeType FooterEnabled Gets or sets a value that specifies whether the footer is enabled on the site. Declaration bool FooterEnabled { get; set; } Property Value System.Boolean FooterLayout Gets or sets the value of the footer layout. Declaration FooterLayoutType FooterLayout { get; set; } Property Value FooterLayoutType HeaderEmphasis Gets or sets the value of the header emphasis. Declaration VariantThemeType HeaderEmphasis { get; set; } Property Value VariantThemeType HeaderLayout Gets or sets the value of the header layout. Declaration HeaderLayoutType HeaderLayout { get; set; } Property Value HeaderLayoutType HideTitleInHeader Gets or sets a value that specifies whether the title in header is hidden on the site. Declaration bool HideTitleInHeader { get; set; } Property Value System.Boolean HorizontalQuickLaunch Defines whether to enable the Horizontal QuickLaunch for the current web Declaration bool HorizontalQuickLaunch { get; set; } Property Value System.Boolean Id The Unique ID of the Web object Declaration Guid Id { get; } Property Value Guid IsHomepageModernized Gets a value that indicates whether the homepage is modernized. Declaration bool IsHomepageModernized { get; } Property Value System.Boolean IsMultilingual Defines whether to enable Multilingual capabilities for the current web Declaration bool IsMultilingual { get; set; } Property Value System.Boolean IsProvisioningComplete Gets a value that indicates whether the provisioning is complete. Declaration bool IsProvisioningComplete { get; } Property Value System.Boolean IsRevertHomepageLinkHidden Gets or sets a value that specifies whether the link to revert homepage is hidden. Declaration bool IsRevertHomepageLinkHidden { get; set; } Property Value System.Boolean Language Gets a value that specifies the LCID for the language that is used on the site. Declaration int Language { get; } Property Value System.Int32 LastItemModifiedDate Gets a value that specifies when an item was last modified in the site. Declaration DateTime LastItemModifiedDate { get; } Property Value DateTime LastItemUserModifiedDate Gets a value that specifies when an item was last modified by user in the site. Declaration DateTime LastItemUserModifiedDate { get; } Property Value DateTime Lists Collection of lists in the current Web object. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IListCollection Lists { get; } Property Value IListCollection LogoAlignment Gets or sets the logo alignment of the site. Declaration LogoAlignment LogoAlignment { get; set; } Property Value LogoAlignment MasterUrl Gets or sets the URL of the master page that is used for the website. Declaration string MasterUrl { get; set; } Property Value System.String MegaMenuEnabled Gets or sets a value that specifies whether the megamenu is enabled on the site. Declaration bool MegaMenuEnabled { get; set; } Property Value System.Boolean MembersCanShare Defines whether members can share content from the current web Declaration bool MembersCanShare { get; set; } Property Value System.Boolean NavAudienceTargetingEnabled Gets or sets a value that specifies whether the audience targeting is enabled on the navigation of the site. Declaration bool NavAudienceTargetingEnabled { get; set; } Property Value System.Boolean Navigation Navigation on the Web Declaration INavigation Navigation { get; } Property Value INavigation NextStepsFirstRunEnabled Gets or sets a value that specifies if the Next steps pane should open automatically as a first run experience when someone visits the site. You can only enable the experience for sites created on or after January 1, 2020 Declaration bool NextStepsFirstRunEnabled { get; set; } Property Value System.Boolean NoCrawl Defines whether the site has to be crawled or not Declaration bool NoCrawl { get; set; } Property Value System.Boolean NotificationsInOneDriveForBusinessEnabled Returns if true if the tenant allowed to send push notifications in OneDrive for Business. Declaration bool NotificationsInOneDriveForBusinessEnabled { get; } Property Value System.Boolean NotificationsInSharePointEnabled Returns if true if the tenant allowed to send push notifications in SharePoint. Declaration bool NotificationsInSharePointEnabled { get; } Property Value System.Boolean ObjectCacheEnabled Gets or sets a value that specifies whether the object cache is enabled on the site. Declaration bool ObjectCacheEnabled { get; set; } Property Value System.Boolean OverwriteTranslationsOnChange Defines whether to OverwriteTranslationsOnChange on change for the current web Declaration bool OverwriteTranslationsOnChange { get; set; } Property Value System.Boolean PreviewFeaturesEnabled Indicates whether the tenant administrator has chosen to disable the Preview Features. Default is true. Declaration bool PreviewFeaturesEnabled { get; } Property Value System.Boolean PrimaryColor Gets or sets the primary color of the site. Declaration string PrimaryColor { get; } Property Value System.String QuickLaunchEnabled Enables or disables the QuickLaunch for the site Declaration bool QuickLaunchEnabled { get; set; } Property Value System.Boolean RecycleBin Gets the recycle bin of the website. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IRecycleBinItemCollection RecycleBin { get; } Property Value IRecycleBinItemCollection RecycleBinEnabled Gets or sets a value that specifies whether the Recycle Bin is enabled. Declaration bool RecycleBinEnabled { get; set; } Property Value System.Boolean RegionalSettings Regional settings configured for this web Declaration IRegionalSettings RegionalSettings { get; } Property Value IRegionalSettings RequestAccessEmail The email address to which any access request will be sent Declaration string RequestAccessEmail { get; set; } Property Value System.String RoleDefinitions Role Definitions defined in this web Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IRoleDefinitionCollection RoleDefinitions { get; } Property Value IRoleDefinitionCollection RootFolder Gets the root folder for the website. Declaration IFolder RootFolder { get; } Property Value IFolder SaveSiteAsTemplateEnabled Gets or sets a Boolean value that specifies whether the Web site can be saved as a site template. Declaration bool SaveSiteAsTemplateEnabled { get; set; } Property Value System.Boolean SearchBoxInNavBar Define if the suitebar search box should show or not Declaration SearchBoxInNavBar SearchBoxInNavBar { get; set; } Property Value SearchBoxInNavBar SearchBoxPlaceholderText Search placeholder text for search box in navbar - overrides default placeholder text if set, returns null if not set. Declaration string SearchBoxPlaceholderText { get; set; } Property Value System.String SearchScope Defines the SearchScope for the site Declaration SearchScope SearchScope { get; set; } Property Value SearchScope ServerRelativeUrl Gets the server relative URL of the current site. Declaration string ServerRelativeUrl { get; } Property Value System.String SiteGroups Gets the collection of all groups that belong to the site collection. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration ISharePointGroupCollection SiteGroups { get; } Property Value ISharePointGroupCollection SiteLogoDescription Gets or sets the description of the Web site logo. Declaration string SiteLogoDescription { get; set; } Property Value System.String SiteLogoUrl Gets or sets the server-relative URL of the Web site logo. This can also contain an absolute URL to the logo. Declaration string SiteLogoUrl { get; set; } Property Value System.String SiteUserInfoList Gets the UserInfo list of the site collection that contains the website. Declaration IList SiteUserInfoList { get; } Property Value IList SiteUsers Gets the collection of all users that belong to the site collection. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration ISharePointUserCollection SiteUsers { get; } Property Value ISharePointUserCollection SupportedUILanguageIds List of languages (expressed via their id) that this site supports Declaration List SupportedUILanguageIds { get; } Property Value PnP.Core.Model.SharePoint.List < System.Int32 > SyndicationEnabled Gets or sets a value that specifies whether the RSS feeds are enabled on the site. Declaration bool SyndicationEnabled { get; set; } Property Value System.Boolean TenantAdminMembersCanShare Gets or sets a value that specifies how the tenant admin members can share. Declaration SharingState TenantAdminMembersCanShare { get; } Property Value SharingState ThemeData Get JSON serialized ThemeData for the current web. Declaration string ThemeData { get; } Property Value System.String ThirdPartyMdmEnabled Gets a value that indicates whether third party MDM (Mobile Device Management) is enabled on the site. Declaration bool ThirdPartyMdmEnabled { get; } Property Value System.Boolean Title The Title of the Site, optional attribute. Declaration string Title { get; set; } Property Value System.String TreeViewEnabled Gets or sets value that specifies whether the tree view is enabled on the site. Declaration bool TreeViewEnabled { get; set; } Property Value System.Boolean Url The URL of the Web object Declaration Uri Url { get; } Property Value Uri UseAccessRequestDefault Determines if we need to use the default access request If this value is True we send access requests to owner/owner's group If this value is False we send access requests to the configured AccessRequestEmail Declaration bool UseAccessRequestDefault { get; } Property Value System.Boolean UserCustomActions Gets a value that specifies the collection of user custom actions for the site. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IUserCustomActionCollection UserCustomActions { get; } Property Value IUserCustomActionCollection Webs Collection of webs in this current web Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IWebCollection Webs { get; } Property Value IWebCollection WebTemplate Gets the name of the site definition or site template that was used to create the site. Declaration string WebTemplate { get; } Property Value System.String WebTemplateConfiguration Gets the web template configuration of the site. Declaration string WebTemplateConfiguration { get; } Property Value System.String WebTemplatesGalleryFirstRunEnabled Gets or sets a value that specifies if the web templates experience should open automatically as a first run experience after the site was created Declaration bool WebTemplatesGalleryFirstRunEnabled { get; set; } Property Value System.Boolean WelcomePage Specifies a string that contains the site-relative URL to which users are redirected when web is browsed (typically the site's home page). Declaration string WelcomePage { get; } Property Value System.String Methods AddIndexedProperty(String) Adds a web property as an indexed property Declaration bool AddIndexedProperty(string propertyName) Parameters System.String propertyName The property name Returns System.Boolean True if it was successfully added or if it is already exists otherwise false Remarks The property must already exist as metadata of the Web AddIndexedPropertyAsync(String) Adds a web property as an indexed property Declaration Task AddIndexedPropertyAsync(string propertyName) Parameters System.String propertyName The property name Returns Task < System.Boolean > True if it was successfully added or if it is already exists otherwise false Remarks The property must already exist as metadata of the Web AsSyntexContentCenter() Returns the current web as ISyntexContentCenter if the web is a Syntex Content Center, null is returned otherwise Declaration ISyntexContentCenter AsSyntexContentCenter() Returns ISyntexContentCenter The current web as ISyntexContentCenter AsSyntexContentCenterAsync() Returns the current web as ISyntexContentCenter if the web is a Syntex Content Center, null is returned otherwise Declaration Task AsSyntexContentCenterAsync() Returns Task < ISyntexContentCenter > The current web as ISyntexContentCenter CheckIfUserHasPermissions(String, PermissionKind) Checks if a user has a specific kind of permissions to a web Declaration bool CheckIfUserHasPermissions(string userPrincipalName, PermissionKind permissionKind) Parameters System.String userPrincipalName Login name of the user you wish to check if he has a specific permission PermissionKind permissionKind Permission kind to check Returns System.Boolean Boolean that says if the user has permissions or not CheckIfUserHasPermissionsAsync(String, PermissionKind) Checks if a user has a specific kind of permissions to a web Declaration Task CheckIfUserHasPermissionsAsync(string userPrincipalName, PermissionKind permissionKind) Parameters System.String userPrincipalName Login name of the user you wish to check if he has a specific permission PermissionKind permissionKind Permission kind to check Returns Task < System.Boolean > Boolean that says if the user has permissions or not EnsureEveryoneExceptExternalUsers() Retrieves everyone except external users and ensures the user in the current web Declaration ISharePointUser EnsureEveryoneExceptExternalUsers() Returns ISharePointUser The ensured ISharePointUser EnsureEveryoneExceptExternalUsersAsync() Retrieves everyone except external users and ensures the user in the current web Declaration Task EnsureEveryoneExceptExternalUsersAsync() Returns Task < ISharePointUser > The ensured ISharePointUser EnsureMultilingual(List) Ensure a site can support multilingual (pages) for the passed along languages Declaration void EnsureMultilingual(List requiredLanguageIds) Parameters PnP.Core.Model.SharePoint.List < System.Int32 > requiredLanguageIds List of langauges to support for multilingual on this site. See https://capacreative.co.uk/resources/reference-sharepoint-online-languages-ids/ for information on the language ids EnsureMultilingualAsync(List) Ensure a site can support multilingual (pages) for the passed along languages Declaration Task EnsureMultilingualAsync(List requiredLanguageIds) Parameters PnP.Core.Model.SharePoint.List < System.Int32 > requiredLanguageIds List of langauges to support for multilingual on this site. See https://capacreative.co.uk/resources/reference-sharepoint-online-languages-ids/ for information on the language ids Returns Task EnsurePageScheduling() Ensures that page publishing can work for this site. Page scheduling only works for the root web of a site collection Declaration void EnsurePageScheduling() EnsurePageSchedulingAsync() Ensures that page publishing can work for this site. Page scheduling only works for the root web of a site collection Declaration Task EnsurePageSchedulingAsync() Returns Task EnsureUser(String) Ensures the given users exists Declaration ISharePointUser EnsureUser(string userPrincipalName) Parameters System.String userPrincipalName UserPrincipalName value of the user to verify Returns ISharePointUser The ensured ISharePointUser EnsureUserAsync(String) Ensures the given users exists Declaration Task EnsureUserAsync(string userPrincipalName) Parameters System.String userPrincipalName UserPrincipalName value of the user to verify Returns Task < ISharePointUser > The ensured ISharePointUser EnsureUserBatch(Batch, String) Ensures the given users exists Declaration ISharePointUser EnsureUserBatch(Batch batch, string userPrincipalName) Parameters Batch batch Batch to add this request to System.String userPrincipalName UserPrincipalName value of the user to verify Returns ISharePointUser The ensured ISharePointUser EnsureUserBatch(String) Ensures the given users exists Declaration ISharePointUser EnsureUserBatch(string userPrincipalName) Parameters System.String userPrincipalName UserPrincipalName value of the user to verify Returns ISharePointUser The ensured ISharePointUser EnsureUserBatchAsync(Batch, String) Ensures the given users exists Declaration Task EnsureUserBatchAsync(Batch batch, string userPrincipalName) Parameters Batch batch Batch to add this request to System.String userPrincipalName UserPrincipalName value of the user to verify Returns Task < ISharePointUser > The ensured ISharePointUser EnsureUserBatchAsync(String) Ensures the given users exists Declaration Task EnsureUserBatchAsync(string userPrincipalName) Parameters System.String userPrincipalName UserPrincipalName value of the user to verify Returns Task < ISharePointUser > The ensured ISharePointUser GetBrandingManager() Returns the branding manager which can be used to change the look of the web Declaration IBrandingManager GetBrandingManager() Returns IBrandingManager An IBrandingManager instance GetCurrentUser() Get's the current logged on user making the request to SharePoint Declaration ISharePointUser GetCurrentUser() Returns ISharePointUser The current ISharePointUser GetCurrentUserAsync() Get's the current logged on user making the request to SharePoint Declaration Task GetCurrentUserAsync() Returns Task < ISharePointUser > The current ISharePointUser GetCurrentUserBatch() Get's the current logged on user making the request to SharePoint Declaration ISharePointUser GetCurrentUserBatch() Returns ISharePointUser The current ISharePointUser GetCurrentUserBatch(Batch) Get's the current logged on user making the request to SharePoint Declaration ISharePointUser GetCurrentUserBatch(Batch batch) Parameters Batch batch Batch to add this request to Returns ISharePointUser The current ISharePointUser GetCurrentUserBatchAsync() Get's the current logged on user making the request to SharePoint Declaration Task GetCurrentUserBatchAsync() Returns Task < ISharePointUser > The current ISharePointUser GetCurrentUserBatchAsync(Batch) Get's the current logged on user making the request to SharePoint Declaration Task GetCurrentUserBatchAsync(Batch batch) Parameters Batch batch Batch to add this request to Returns Task < ISharePointUser > The current ISharePointUser GetFileById(Guid, Expression>[]) Get a file in the current web from its unique id. Declaration IFile GetFileById(Guid uniqueFileId, params Expression>[] expressions) Parameters Guid uniqueFileId The unique id of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get GetFileByIdAsync(Guid, Expression>[]) Get a file in the current web from its unique id. Declaration Task GetFileByIdAsync(Guid uniqueFileId, params Expression>[] expressions) Parameters Guid uniqueFileId The unique id of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get GetFileByIdBatch(Guid, Expression>[]) Get a file in the current web from its unique id via batch. Declaration IFile GetFileByIdBatch(Guid uniqueFileId, params Expression>[] expressions) Parameters Guid uniqueFileId The unique id of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get GetFileByIdBatch(Batch, Guid, Expression>[]) Get a file in the current web from its unique id via batch. Declaration IFile GetFileByIdBatch(Batch batch, Guid uniqueFileId, params Expression>[] expressions) Parameters Batch batch Batch to add this request to Guid uniqueFileId The unique id of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get GetFileByIdBatchAsync(Guid, Expression>[]) Get a file in the current web from its unique id via batch. Declaration Task GetFileByIdBatchAsync(Guid uniqueFileId, params Expression>[] expressions) Parameters Guid uniqueFileId The unique id of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get GetFileByIdBatchAsync(Batch, Guid, Expression>[]) Get a file in the current web from its unique id via batch. Declaration Task GetFileByIdBatchAsync(Batch batch, Guid uniqueFileId, params Expression>[] expressions) Parameters Batch batch Batch to add this request to Guid uniqueFileId The unique id of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get GetFileByLink(String, Expression>[]) Get's a file from a given link (sharing link, path to file) Declaration IFile GetFileByLink(string link, params Expression>[] expressions) Parameters System.String link Link pointing to a file Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns IFile IFile reference when the file could be found, exception otherwise GetFileByLinkAsync(String, Expression>[]) Get's a file from a given link (sharing link, path to file) Declaration Task GetFileByLinkAsync(string link, params Expression>[] expressions) Parameters System.String link Link pointing to a file Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > IFile reference when the file could be found, exception otherwise GetFileByServerRelativeUrl(String, Expression>[]) Get a file in the current web from its server relative URL. Declaration IFile GetFileByServerRelativeUrl(string serverRelativeUrl, params Expression>[] expressions) Parameters System.String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get GetFileByServerRelativeUrlAsync(String, Expression>[]) Get a file in the current web from its server relative URL. Declaration Task GetFileByServerRelativeUrlAsync(string serverRelativeUrl, params Expression>[] expressions) Parameters System.String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get GetFileByServerRelativeUrlBatch(Batch, String, Expression>[]) Get a file in the current web from its server relative URL via batch. Declaration IFile GetFileByServerRelativeUrlBatch(Batch batch, string serverRelativeUrl, params Expression>[] expressions) Parameters Batch batch Batch to add this request to System.String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get GetFileByServerRelativeUrlBatch(String, Expression>[]) Get a file in the current web from its server relative URL via batch. Declaration IFile GetFileByServerRelativeUrlBatch(string serverRelativeUrl, params Expression>[] expressions) Parameters System.String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get GetFileByServerRelativeUrlBatchAsync(Batch, String, Expression>[]) Get a file in the current web from its server relative URL via batch. Declaration Task GetFileByServerRelativeUrlBatchAsync(Batch batch, string serverRelativeUrl, params Expression>[] expressions) Parameters Batch batch Batch to add this request to System.String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get GetFileByServerRelativeUrlBatchAsync(String, Expression>[]) Get a file in the current web from its server relative URL via batch. Declaration Task GetFileByServerRelativeUrlBatchAsync(string serverRelativeUrl, params Expression>[] expressions) Parameters System.String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get GetFileByServerRelativeUrlOrDefault(String, Expression>[]) Get a file in the current web from its server relative URL, it not available null will be returned Declaration IFile GetFileByServerRelativeUrlOrDefault(string serverRelativeUrl, params Expression>[] expressions) Parameters System.String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get or null if the file was not available GetFileByServerRelativeUrlOrDefaultAsync(String, Expression>[]) Get a file in the current web from its server relative URL, it not available null will be returned Declaration Task GetFileByServerRelativeUrlOrDefaultAsync(string serverRelativeUrl, params Expression>[] expressions) Parameters System.String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get or null if the file was not available GetFolderById(Guid, Expression>[]) Get a folder in the current web from its id. Declaration IFolder GetFolderById(Guid folderId, params Expression>[] expressions) Parameters Guid folderId The id of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns IFolder The folder to get GetFolderByIdAsync(Guid, Expression>[]) Get a folder in the current web from its id. Declaration Task GetFolderByIdAsync(Guid folderId, params Expression>[] expressions) Parameters Guid folderId The id of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns Task < IFolder > The folder to get GetFolderByIdBatch(Guid, Expression>[]) Get a folder in the current web from its id via batch. Declaration IFolder GetFolderByIdBatch(Guid folderId, params Expression>[] expressions) Parameters Guid folderId The id of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns IFolder The folder to get GetFolderByIdBatch(Batch, Guid, Expression>[]) Get a folder in the current web from its id via batch. Declaration IFolder GetFolderByIdBatch(Batch batch, Guid folderId, params Expression>[] expressions) Parameters Batch batch Batch to add this request to Guid folderId The id of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns IFolder The folder to get GetFolderByIdBatchAsync(Guid, Expression>[]) Get a folder in the current web from its id via batch. Declaration Task GetFolderByIdBatchAsync(Guid folderId, params Expression>[] expressions) Parameters Guid folderId The id of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns Task < IFolder > The folder to get GetFolderByIdBatchAsync(Batch, Guid, Expression>[]) Get a folder in the current web from its id via batch. Declaration Task GetFolderByIdBatchAsync(Batch batch, Guid folderId, params Expression>[] expressions) Parameters Batch batch Batch to add this request to Guid folderId The id of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns Task < IFolder > The folder to get GetFolderByServerRelativeUrl(String, Expression>[]) Get a folder in the current web from its server relative URL. Declaration IFolder GetFolderByServerRelativeUrl(string serverRelativeUrl, params Expression>[] expressions) Parameters System.String serverRelativeUrl The server relative URL of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns IFolder The folder to get GetFolderByServerRelativeUrlAsync(String, Expression>[]) Get a folder in the current web from its server relative URL. Declaration Task GetFolderByServerRelativeUrlAsync(string serverRelativeUrl, params Expression>[] expressions) Parameters System.String serverRelativeUrl The server relative URL of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns Task < IFolder > The folder to get GetFolderByServerRelativeUrlBatch(Batch, String, Expression>[]) Get a folder in the current web from its server relative URL via batch. Declaration IFolder GetFolderByServerRelativeUrlBatch(Batch batch, string serverRelativeUrl, params Expression>[] expressions) Parameters Batch batch Batch to add this request to System.String serverRelativeUrl The server relative URL of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns IFolder The folder to get GetFolderByServerRelativeUrlBatch(String, Expression>[]) Get a folder in the current web from its server relative URL via batch. Declaration IFolder GetFolderByServerRelativeUrlBatch(string serverRelativeUrl, params Expression>[] expressions) Parameters System.String serverRelativeUrl The server relative URL of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns IFolder The folder to get GetFolderByServerRelativeUrlBatchAsync(Batch, String, Expression>[]) Get a folder in the current web from its server relative URL via batch. Declaration Task GetFolderByServerRelativeUrlBatchAsync(Batch batch, string serverRelativeUrl, params Expression>[] expressions) Parameters Batch batch Batch to add this request to System.String serverRelativeUrl The server relative URL of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns Task < IFolder > The folder to get GetFolderByServerRelativeUrlBatchAsync(String, Expression>[]) Get a folder in the current web from its server relative URL via batch. Declaration Task GetFolderByServerRelativeUrlBatchAsync(string serverRelativeUrl, params Expression>[] expressions) Parameters System.String serverRelativeUrl The server relative URL of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns Task < IFolder > The folder to get GetPages(String) Gets the modern pages of this site, optionally scoped down via a filter Declaration List GetPages(string pageName = null) Parameters System.String pageName Page name to filter on, uses a \"starts with\" filter Returns PnP.Core.Model.SharePoint.List < IPage > One of more modern pages GetPagesAsync(String) Gets the modern pages of this site, optionally scoped down via a filter Declaration Task> GetPagesAsync(string pageName = null) Parameters System.String pageName Page name to filter on, uses a \"starts with\" filter Returns Task < PnP.Core.Model.SharePoint.List < IPage >> One of more modern pages GetRecycleBinItemsByQuery(RecycleBinQueryOptions) Searches the recyclebin returning items based upon the passed search criteria Declaration IRecycleBinItemCollection GetRecycleBinItemsByQuery(RecycleBinQueryOptions options) Parameters RecycleBinQueryOptions options Recycle bin search criteria Returns IRecycleBinItemCollection A list containing zero or more recycle bin items GetRecycleBinItemsByQueryAsync(RecycleBinQueryOptions) Searches the recyclebin returning items based upon the passed search criteria Declaration Task GetRecycleBinItemsByQueryAsync(RecycleBinQueryOptions options) Parameters RecycleBinQueryOptions options Recycle bin search criteria Returns Task < IRecycleBinItemCollection > A list containing zero or more recycle bin items GetRecycleBinItemsByQueryBatch(RecycleBinQueryOptions) Searches the recyclebin returning items based upon the passed search criteria Declaration IRecycleBinItemCollection GetRecycleBinItemsByQueryBatch(RecycleBinQueryOptions options) Parameters RecycleBinQueryOptions options Recycle bin search criteria Returns IRecycleBinItemCollection A list containing zero or more recycle bin items GetRecycleBinItemsByQueryBatch(Batch, RecycleBinQueryOptions) Searches the recyclebin returning items based upon the passed search criteria Declaration IRecycleBinItemCollection GetRecycleBinItemsByQueryBatch(Batch batch, RecycleBinQueryOptions options) Parameters Batch batch Batch to add this request to RecycleBinQueryOptions options Recycle bin search criteria Returns IRecycleBinItemCollection A list containing zero or more recycle bin items GetRecycleBinItemsByQueryBatchAsync(RecycleBinQueryOptions) Searches the recyclebin returning items based upon the passed search criteria Declaration Task GetRecycleBinItemsByQueryBatchAsync(RecycleBinQueryOptions options) Parameters RecycleBinQueryOptions options Recycle bin search criteria Returns Task < IRecycleBinItemCollection > A list containing zero or more recycle bin items GetRecycleBinItemsByQueryBatchAsync(Batch, RecycleBinQueryOptions) Searches the recyclebin returning items based upon the passed search criteria Declaration Task GetRecycleBinItemsByQueryBatchAsync(Batch batch, RecycleBinQueryOptions options) Parameters Batch batch Batch to add this request to RecycleBinQueryOptions options Recycle bin search criteria Returns Task < IRecycleBinItemCollection > A list containing zero or more recycle bin items GetSearchConfigurationManagedProperties() Gets the managed properties from the search configuration of this web Declaration List GetSearchConfigurationManagedProperties() Returns PnP.Core.Model.SharePoint.List < IManagedProperty > List of managed properties GetSearchConfigurationManagedPropertiesAsync() Gets the managed properties from the search configuration of this web Declaration Task> GetSearchConfigurationManagedPropertiesAsync() Returns Task < PnP.Core.Model.SharePoint.List < IManagedProperty >> List of managed properties GetSearchConfigurationXml() Gets the search configuration of the web Declaration string GetSearchConfigurationXml() Returns System.String Search configuration XML GetSearchConfigurationXmlAsync() Gets the search configuration of the web Declaration Task GetSearchConfigurationXmlAsync() Returns Task < System.String > Search configuration XML GetUserById(Int32) Get's a user by it's id in this site. The user needs to exist, use EnsureUser(String) if you want to create the user if it does not yet exist Declaration ISharePointUser GetUserById(int userId) Parameters System.Int32 userId Id of the user to get Returns ISharePointUser The found user as ISharePointPrincipal GetUserByIdAsync(Int32) Get's a user by it's id in this site. The user needs to exist, use EnsureUserAsync(String) if you want to create the user if it does not yet exist Declaration Task GetUserByIdAsync(int userId) Parameters System.Int32 userId Id of the user to get Returns Task < ISharePointUser > The found user as ISharePointPrincipal GetUserByIdBatch(Batch, Int32) Get's a user by it's id in this site. The user needs to exist, use EnsureUserBatch(String) if you want to create the user if it does not yet exist Declaration ISharePointUser GetUserByIdBatch(Batch batch, int userId) Parameters Batch batch Batch to add this request to System.Int32 userId Id of the user to get Returns ISharePointUser The found user as ISharePointPrincipal GetUserByIdBatch(Int32) Get's a user by it's id in this site. The user needs to exist, use EnsureUserBatch(String) if you want to create the user if it does not yet exist Declaration ISharePointUser GetUserByIdBatch(int userId) Parameters System.Int32 userId Id of the user to get Returns ISharePointUser The found user as ISharePointPrincipal GetUserByIdBatchAsync(Batch, Int32) Get's a user by it's id in this site. The user needs to exist, use EnsureUserBatchAsync(String) if you want to create the user if it does not yet exist Declaration Task GetUserByIdBatchAsync(Batch batch, int userId) Parameters Batch batch Batch to add this request to System.Int32 userId Id of the user to get Returns Task < ISharePointUser > The found user as ISharePointPrincipal GetUserByIdBatchAsync(Int32) Get's a user by it's id in this site. The user needs to exist, use EnsureUserBatchAsync(String) if you want to create the user if it does not yet exist Declaration Task GetUserByIdBatchAsync(int userId) Parameters System.Int32 userId Id of the user to get Returns Task < ISharePointUser > The found user as ISharePointPrincipal GetUserEffectivePermissions(String) Gets the user effective permissions of a user for a web Declaration IBasePermissions GetUserEffectivePermissions(string userPrincipalName) Parameters System.String userPrincipalName Login name of the user you wish to retrieve the permissions of Returns IBasePermissions Base permissions object that contains the High and the Low permissions GetUserEffectivePermissionsAsync(String) Gets the user effective permissions of a user for a web Declaration Task GetUserEffectivePermissionsAsync(string userPrincipalName) Parameters System.String userPrincipalName Login name of the user you wish to retrieve the permissions of Returns Task < IBasePermissions > Base permissions object that contains the High and the Low permissions GetVivaDashboard() Gets Viva Connections dashboard. If there is no dashboard configured, returns null Declaration IVivaDashboard GetVivaDashboard() Returns IVivaDashboard Viva Dashboard or null GetVivaDashboardAsync() Gets Viva Connections dashboard. If there is no dashboard configured, returns null Declaration Task GetVivaDashboardAsync() Returns Task < IVivaDashboard > Viva Dashboard or null GetWebTemplateByName(String, Int32, Boolean) Return a specific web template based by a name Declaration IWebTemplate GetWebTemplateByName(string name, int lcid = 1033, bool includeCrossLanguage = false) Parameters System.String name Name of the template to retrieve System.Int32 lcid Specifies the LCID of the site templates to be retrieved. System.Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns IWebTemplate The template with the specified name, if available GetWebTemplateByNameAsync(String, Int32, Boolean) Return a specific web template based by a name Declaration Task GetWebTemplateByNameAsync(string name, int lcid = 1033, bool includeCrossLanguage = false) Parameters System.String name Name of the template to retrieve System.Int32 lcid Specifies the LCID of the site templates to be retrieved. System.Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns Task < IWebTemplate > The template with the specified name, if available GetWebTemplateByNameBatch(Batch, String, Int32, Boolean) Return a specific web template based by a name Declaration IBatchSingleResult GetWebTemplateByNameBatch(Batch batch, string name, int lcid = 1033, bool includeCrossLanguage = false) Parameters Batch batch Batch to add this request to System.String name Name of the template to retrieve System.Int32 lcid Specifies the LCID of the site templates to be retrieved. System.Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns IBatchSingleResult < IWebTemplate > The template with the specified name, if available GetWebTemplateByNameBatch(String, Int32, Boolean) Return a specific web template based by a name Declaration IBatchSingleResult GetWebTemplateByNameBatch(string name, int lcid = 1033, bool includeCrossLanguage = false) Parameters System.String name Name of the template to retrieve System.Int32 lcid Specifies the LCID of the site templates to be retrieved. System.Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns IBatchSingleResult < IWebTemplate > The template with the specified name, if available GetWebTemplateByNameBatchAsync(Batch, String, Int32, Boolean) Return a specific web template based by a name Declaration Task> GetWebTemplateByNameBatchAsync(Batch batch, string name, int lcid = 1033, bool includeCrossLanguage = false) Parameters Batch batch Batch to add this request to System.String name Name of the template to retrieve System.Int32 lcid Specifies the LCID of the site templates to be retrieved. System.Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns Task < IBatchSingleResult < IWebTemplate >> The template with the specified name, if available GetWebTemplateByNameBatchAsync(String, Int32, Boolean) Return a specific web template based by a name Declaration Task> GetWebTemplateByNameBatchAsync(string name, int lcid = 1033, bool includeCrossLanguage = false) Parameters System.String name Name of the template to retrieve System.Int32 lcid Specifies the LCID of the site templates to be retrieved. System.Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns Task < IBatchSingleResult < IWebTemplate >> The list of webtemplates available on the current web GetWebTemplates(Int32, Boolean) Returns a collection of site templates available for the site. Declaration List GetWebTemplates(int lcid = 1033, bool includeCrossLanguage = false) Parameters System.Int32 lcid Specifies the LCID of the site templates to be retrieved. System.Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns PnP.Core.Model.SharePoint.List < IWebTemplate > The list of webtemplates available on the current web GetWebTemplatesAsync(Int32, Boolean) Returns a collection of site templates available for the site. Declaration Task> GetWebTemplatesAsync(int lcid = 1033, bool includeCrossLanguage = false) Parameters System.Int32 lcid Specifies the LCID of the site templates to be retrieved. System.Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns Task < PnP.Core.Model.SharePoint.List < IWebTemplate >> The list of webtemplates available on the current web GetWebTemplatesBatch(Batch, Int32, Boolean) Returns a collection of site templates available for the site. Declaration IEnumerableBatchResult GetWebTemplatesBatch(Batch batch, int lcid = 1033, bool includeCrossLanguage = false) Parameters Batch batch Batch to add this request to System.Int32 lcid Specifies the LCID of the site templates to be retrieved. System.Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns IEnumerableBatchResult < IWebTemplate > The list of webtemplates available on the current web GetWebTemplatesBatch(Int32, Boolean) Returns a collection of site templates available for the site. Declaration IEnumerableBatchResult GetWebTemplatesBatch(int lcid = 1033, bool includeCrossLanguage = false) Parameters System.Int32 lcid Specifies the LCID of the site templates to be retrieved. System.Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns IEnumerableBatchResult < IWebTemplate > The list of webtemplates available on the current web GetWebTemplatesBatchAsync(Batch, Int32, Boolean) Returns a collection of site templates available for the site. Declaration Task> GetWebTemplatesBatchAsync(Batch batch, int lcid = 1033, bool includeCrossLanguage = false) Parameters Batch batch Batch to add this request to System.Int32 lcid Specifies the LCID of the site templates to be retrieved. System.Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns Task < IEnumerableBatchResult < IWebTemplate >> The list of webtemplates available on the current web GetWebTemplatesBatchAsync(Int32, Boolean) Returns a collection of site templates available for the site. Declaration Task> GetWebTemplatesBatchAsync(int lcid = 1033, bool includeCrossLanguage = false) Parameters System.Int32 lcid Specifies the LCID of the site templates to be retrieved. System.Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns Task < IEnumerableBatchResult < IWebTemplate >> The list of webtemplates available on the current web GetWssIdForTerm(String) Returns the Id for a term if present in the TaxonomyHiddenList. Otherwise returns -1; Declaration int GetWssIdForTerm(string termId) Parameters System.String termId Id of the term to lookup Returns System.Int32 Id of the term in the taxonomy hidden list, otherwise -1 GetWssIdForTermAsync(String) Returns the Id for a term if present in the TaxonomyHiddenList. Otherwise returns -1; Declaration Task GetWssIdForTermAsync(string termId) Parameters System.String termId Id of the term to lookup Returns Task < System.Int32 > Id of the term in the taxonomy hidden list, otherwise -1 HasCommunicationSiteFeatures() Does this web have the communication site features enabled? Declaration bool HasCommunicationSiteFeatures() Returns System.Boolean True if enabled, false otherwise HasCommunicationSiteFeaturesAsync() Does this web have the communication site features enabled? Declaration Task HasCommunicationSiteFeaturesAsync() Returns Task < System.Boolean > True if enabled, false otherwise IsNoScriptSite() Checks if this web is configured for NoScript Declaration bool IsNoScriptSite() Returns System.Boolean True if set to NoScript, false otherwise IsNoScriptSiteAsync() Checks if this web is configured for NoScript Declaration Task IsNoScriptSiteAsync() Returns Task < System.Boolean > True if set to NoScript, false otherwise IsSubSite() Checks if this web is a sub site Declaration bool IsSubSite() Returns System.Boolean True if the web is a sub site IsSubSiteAsync() Checks if this web is a sub site Declaration Task IsSubSiteAsync() Returns Task < System.Boolean > True if the web is a sub site IsSyntexContentCenter() Is this web a Syntex Content Center Declaration bool IsSyntexContentCenter() Returns System.Boolean True if this web is a Syntex Content Center, false otherwise IsSyntexContentCenterAsync() Is this web a Syntex Content Center Declaration Task IsSyntexContentCenterAsync() Returns Task < System.Boolean > True if this web is a Syntex Content Center, false otherwise IsSyntexEnabled() Is the tenant enabled for SharePoint Syntex Declaration bool IsSyntexEnabled() Returns System.Boolean True if SharePoint Syntex is enabled, false otherwise IsSyntexEnabledAsync() Is the tenant enabled for SharePoint Syntex Declaration Task IsSyntexEnabledAsync() Returns Task < System.Boolean > True if SharePoint Syntex is enabled, false otherwise IsSyntexEnabledForCurrentUser() Is SharePoint Syntex enabled for the current user Declaration bool IsSyntexEnabledForCurrentUser() Returns System.Boolean True if SharePoint Syntex is enabled for the current user, false otherwise IsSyntexEnabledForCurrentUserAsync() Is SharePoint Syntex enabled for the current user Declaration Task IsSyntexEnabledForCurrentUserAsync() Returns Task < System.Boolean > True if SharePoint Syntex is enabled for the current user, false otherwise NewPage(PageLayoutType, EditorType) Creates a new modern page Declaration IPage NewPage(PageLayoutType pageLayoutType = default(PageLayoutType), EditorType editorType = default(EditorType)) Parameters PageLayoutType pageLayoutType Optionally specify the page type, defaults to Article EditorType editorType Editor type to be used by the new page, CK4 is the legacy model, CK5 the current Returns IPage Created modern page NewPageAsync(PageLayoutType, EditorType) Creates a new modern page Declaration Task NewPageAsync(PageLayoutType pageLayoutType = default(PageLayoutType), EditorType editorType = default(EditorType)) Parameters PageLayoutType pageLayoutType Optionally specify the page type, defaults to Article EditorType editorType Editor type to be used by the new page, CK4 is the legacy model, CK5 the current Returns Task < IPage > Created modern page ReIndex() Reindexes this web Declaration void ReIndex() ReIndexAsync() Reindexes this web Declaration Task ReIndexAsync() Returns Task RemoveIndexedProperty(String) Removes a web propetry from the indexed properties Declaration bool RemoveIndexedProperty(string propertyName) Parameters System.String propertyName The property name Returns System.Boolean True if it was successfully removed otherwise false RemoveIndexedPropertyAsync(String) Removes a web propetry from the indexed properties Declaration Task RemoveIndexedPropertyAsync(string propertyName) Parameters System.String propertyName The property name Returns Task < System.Boolean > True if it was successfully removed otherwise false Search(SearchOptions) Performs a search query Declaration ISearchResult Search(SearchOptions query) Parameters SearchOptions query Search query to run Returns ISearchResult The results of the search query SearchAsync(SearchOptions) Performs a search query Declaration Task SearchAsync(SearchOptions query) Parameters SearchOptions query Search query to run Returns Task < ISearchResult > The results of the search query SearchBatch(SearchOptions) Performs a search query Declaration IBatchSingleResult SearchBatch(SearchOptions query) Parameters SearchOptions query Search query to run Returns IBatchSingleResult < ISearchResult > The results of the search query SearchBatch(Batch, SearchOptions) Performs a search query Declaration IBatchSingleResult SearchBatch(Batch batch, SearchOptions query) Parameters Batch batch Batch to add this request to SearchOptions query Search query to run Returns IBatchSingleResult < ISearchResult > The results of the search query SearchBatchAsync(SearchOptions) Performs a search query Declaration Task> SearchBatchAsync(SearchOptions query) Parameters SearchOptions query Search query to run Returns Task < IBatchSingleResult < ISearchResult >> The results of the search query SearchBatchAsync(Batch, SearchOptions) Performs a search query Declaration Task> SearchBatchAsync(Batch batch, SearchOptions query) Parameters Batch batch Batch to add this request to SearchOptions query Search query to run Returns Task < IBatchSingleResult < ISearchResult >> The results of the search query SetAccessRequest(AccessRequestOption, String) Applies the access request settings Declaration Task SetAccessRequest(AccessRequestOption operation, string email = null) Parameters AccessRequestOption operation The operation to be performed System.String email Applies the email address for the 'SpecificMail' operation Returns Task SetAccessRequestAsync(AccessRequestOption, String) Applies the access request settings Declaration Task SetAccessRequestAsync(AccessRequestOption operation, string email = null) Parameters AccessRequestOption operation The operation to be performed System.String email Applies the email address for the 'SpecificMail' operation Returns Task SetSearchConfigurationXml(String) Sets the search configuration for the web Declaration void SetSearchConfigurationXml(string configuration) Parameters System.String configuration Search configuration, obtained via GetSearchConfigurationXml() to apply SetSearchConfigurationXmlAsync(String) Sets the search configuration for the web Declaration Task SetSearchConfigurationXmlAsync(string configuration) Parameters System.String configuration Search configuration, obtained via GetSearchConfigurationXml() to apply Returns Task SyncHubSiteThemeAsync() Sync the hub site theme from parent hub site Declaration Task SyncHubSiteThemeAsync() Returns Task UnfurlLink(String, UnfurlOptions) Takes in a sharing or regular SharePoint link and tries to provide relavant information about the resource behind the passed in link Declaration IUnfurledResource UnfurlLink(string link, UnfurlOptions unfurlOptions = null) Parameters System.String link Link to resource to get information for UnfurlOptions unfurlOptions Options to control the unfurling data gathering Returns IUnfurledResource Data about the unfurled resource UnfurlLinkAsync(String, UnfurlOptions) Takes in a sharing or regular SharePoint link and tries to provide relavant information about the resource behind the passed in link Declaration Task UnfurlLinkAsync(string link, UnfurlOptions unfurlOptions = null) Parameters System.String link Link to resource to get information for UnfurlOptions unfurlOptions Options to control the unfurling data gathering Returns Task < IUnfurledResource > Data about the unfurled resource ValidateAndEnsureUsers(IList) Checks if the provided list of user UPN's are valid users in Azure AD and returns the 'ensured' SharePoint user Declaration IList ValidateAndEnsureUsers(IList userList) Parameters PnP.Core.Model.SharePoint.IList < System.String > userList List of user UPN's to validate in Azure AD Returns PnP.Core.Model.SharePoint.IList < ISharePointUser > The list of ISharePointUser that exist ValidateAndEnsureUsersAsync(IList) Checks if the provided list of user UPN's are valid users in Azure AD and returns the 'ensured' SharePoint user Declaration Task> ValidateAndEnsureUsersAsync(IList userList) Parameters PnP.Core.Model.SharePoint.IList < System.String > userList List of user UPN's to validate in Azure AD Returns Task < PnP.Core.Model.SharePoint.IList < ISharePointUser >> The list of ISharePointUser that exist ValidateUsers(IList) Checks if the provided list of user UPN's are valid users in Azure AD Declaration IList ValidateUsers(IList userList) Parameters PnP.Core.Model.SharePoint.IList < System.String > userList List of user UPN's to validate in Azure AD Returns PnP.Core.Model.SharePoint.IList < System.String > A list of users that were not found in Azure AD ValidateUsersAsync(IList) Checks if the provided list of user UPN's are valid users in Azure AD Declaration Task> ValidateUsersAsync(IList userList) Parameters PnP.Core.Model.SharePoint.IList < System.String > userList List of user UPN's to validate in Azure AD Returns Task < PnP.Core.Model.SharePoint.IList < System.String >> A list of users that were not found in Azure AD Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>) RequestModuleExtensions.WithResponseHeaders(ISupportModules, Action>)" }, "api/PnP.Core.Model.SharePoint.IWebCollection.html": { "href": "api/PnP.Core.Model.SharePoint.IWebCollection.html", diff --git a/manifest.json b/manifest.json index c18c4e7c93..9a154d05be 100644 --- a/manifest.json +++ b/manifest.json @@ -5586,7 +5586,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IWeb.html", - "hash": "/Y0ES3zt8NxTapaV+tQdcX2ZXDf5d3C4MscPsbMFe8M=" + "hash": "yr8eCSYDiW1ZVblsB8lAapGOFqqxidRYEz1Ynt52GxY=" } }, "is_incremental": false, diff --git a/xrefmap.yml b/xrefmap.yml index 23c6612c96..d7904bef75 100644 --- a/xrefmap.yml +++ b/xrefmap.yml @@ -52378,12 +52378,12 @@ references: isSpec: "True" fullName: PnP.Core.Model.SharePoint.IWeb.Navigation nameWithType: IWeb.Navigation -- uid: PnP.Core.Model.SharePoint.IWeb.NewPage(PnP.Core.Model.SharePoint.PageLayoutType) - name: NewPage(PageLayoutType) - href: api/PnP.Core.Model.SharePoint.IWeb.html#PnP_Core_Model_SharePoint_IWeb_NewPage_PnP_Core_Model_SharePoint_PageLayoutType_ - commentId: M:PnP.Core.Model.SharePoint.IWeb.NewPage(PnP.Core.Model.SharePoint.PageLayoutType) - fullName: PnP.Core.Model.SharePoint.IWeb.NewPage(PnP.Core.Model.SharePoint.PageLayoutType) - nameWithType: IWeb.NewPage(PageLayoutType) +- uid: PnP.Core.Model.SharePoint.IWeb.NewPage(PnP.Core.Model.SharePoint.PageLayoutType,PnP.Core.Model.SharePoint.EditorType) + name: NewPage(PageLayoutType, EditorType) + href: api/PnP.Core.Model.SharePoint.IWeb.html#PnP_Core_Model_SharePoint_IWeb_NewPage_PnP_Core_Model_SharePoint_PageLayoutType_PnP_Core_Model_SharePoint_EditorType_ + commentId: M:PnP.Core.Model.SharePoint.IWeb.NewPage(PnP.Core.Model.SharePoint.PageLayoutType,PnP.Core.Model.SharePoint.EditorType) + fullName: PnP.Core.Model.SharePoint.IWeb.NewPage(PnP.Core.Model.SharePoint.PageLayoutType, PnP.Core.Model.SharePoint.EditorType) + nameWithType: IWeb.NewPage(PageLayoutType, EditorType) - uid: PnP.Core.Model.SharePoint.IWeb.NewPage* name: NewPage href: api/PnP.Core.Model.SharePoint.IWeb.html#PnP_Core_Model_SharePoint_IWeb_NewPage_ @@ -52391,12 +52391,12 @@ references: isSpec: "True" fullName: PnP.Core.Model.SharePoint.IWeb.NewPage nameWithType: IWeb.NewPage -- uid: PnP.Core.Model.SharePoint.IWeb.NewPageAsync(PnP.Core.Model.SharePoint.PageLayoutType) - name: NewPageAsync(PageLayoutType) - href: api/PnP.Core.Model.SharePoint.IWeb.html#PnP_Core_Model_SharePoint_IWeb_NewPageAsync_PnP_Core_Model_SharePoint_PageLayoutType_ - commentId: M:PnP.Core.Model.SharePoint.IWeb.NewPageAsync(PnP.Core.Model.SharePoint.PageLayoutType) - fullName: PnP.Core.Model.SharePoint.IWeb.NewPageAsync(PnP.Core.Model.SharePoint.PageLayoutType) - nameWithType: IWeb.NewPageAsync(PageLayoutType) +- uid: PnP.Core.Model.SharePoint.IWeb.NewPageAsync(PnP.Core.Model.SharePoint.PageLayoutType,PnP.Core.Model.SharePoint.EditorType) + name: NewPageAsync(PageLayoutType, EditorType) + href: api/PnP.Core.Model.SharePoint.IWeb.html#PnP_Core_Model_SharePoint_IWeb_NewPageAsync_PnP_Core_Model_SharePoint_PageLayoutType_PnP_Core_Model_SharePoint_EditorType_ + commentId: M:PnP.Core.Model.SharePoint.IWeb.NewPageAsync(PnP.Core.Model.SharePoint.PageLayoutType,PnP.Core.Model.SharePoint.EditorType) + fullName: PnP.Core.Model.SharePoint.IWeb.NewPageAsync(PnP.Core.Model.SharePoint.PageLayoutType, PnP.Core.Model.SharePoint.EditorType) + nameWithType: IWeb.NewPageAsync(PageLayoutType, EditorType) - uid: PnP.Core.Model.SharePoint.IWeb.NewPageAsync* name: NewPageAsync href: api/PnP.Core.Model.SharePoint.IWeb.html#PnP_Core_Model_SharePoint_IWeb_NewPageAsync_