Public interface to define a Web object of SharePoint Online
public interface IWeb : IDataModel<IWeb>, IDataModelParent, IDataModelWithContext, ISupportModules<IWeb>, IDataModelGet<IWeb>, IDataModelLoad<IWeb>, IDataModelUpdate, IDataModelDelete, IDataModelSupportingGetChanges, ISecurableObject, IQueryableDataModelGets the URL of the access request list to the current site.
string AccessRequestListUrl { get; }|
String
|
Gets or sets the description of the access request to this site.
string AccessRequestSiteDescription { get; set; }|
String
|
A special property used to add an asterisk to a $select statement
object All { get; }|
Object
|
Gets a value that specifies whether the automatic ASPX page indexed is allowed.
bool AllowAutomaticASPXPageIndexing { get; set; }|
Boolean
|
Gets a value that specifies whether the current user is allowed to create declarative workflow on this site.
bool AllowCreateDeclarativeWorkflowForCurrentUser { get; set; }|
Boolean
|
Gets a value that specifies whether the current user is allowed to use a designer application to customize this site.
bool AllowDesignerForCurrentUser { get; set; }|
Boolean
|
Gets a value that specifies whether the current user is allowed to edit the master page.
bool AllowMasterPageEditingForCurrentUser { get; }|
Boolean
|
Gets a value that specifies whether the current user is allowed to revert the site to a default site template.
bool AllowRevertFromTemplateForCurrentUser { get; }|
Boolean
|
Gets a value that specifies whether the site allows RSS feeds.
bool AllowRssFeeds { get; }|
Boolean
|
Gets a value that specifies whether the current user is allowed to save declarative workflows as template.
bool AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser { get; }|
Boolean
|
Gets a value that specifies whether the current user is allowed to publish a declarative workflow.
bool AllowSavePublishDeclarativeWorkflowForCurrentUser { get; }|
Boolean
|
Gets a collection of metadata for the Web site.
IPropertyValues AllProperties { get; }|
IPropertyValues
|
The AlternateCSS of the Site, optional attribute.
string AlternateCssUrl { get; set; }|
String
|
The instance Id of the App Instance that this website represents.
Guid AppInstanceId { get; }|
Guid
|
Associated SharePoint Member group
ISharePointGroup AssociatedMemberGroup { get; }|
ISharePointGroup
|
Associated SharePoint owner group
ISharePointGroup AssociatedOwnerGroup { get; }|
ISharePointGroup
|
Associated SharePoint Visitor group
ISharePointGroup AssociatedVisitorGroup { get; }|
ISharePointGroup
|
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.
IContentTypeCollection AvailableContentTypes { get; }|
IContentTypeCollection
|
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.
IFieldCollection AvailableFields { get; }|
IFieldCollection
|
Defines whether the comments on site pages are disabled or not
bool CommentsOnSitePagesDisabled { get; set; }|
Boolean
|
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.
bool ContainsConfidentialInfo { get; set; }|
Boolean
|
Collection of content types in the current Web object
Implements
See Requesting model collections
and IQueryable performance considerations to learn more.
IContentTypeCollection ContentTypes { get; }|
IContentTypeCollection
|
Gets a value that specifies when the site was created.
DateTime Created { get; }|
DateTime
|
Gets the current user in the current context
ISharePointUser CurrentUser { get; }|
ISharePointUser
|
The Custom MasterPage Url of the Site, optional attribute.
string CustomMasterUrl { get; set; }|
String
|
The id of the default new page template. Use SetDefaultNewPageTemplateId to set the value.
Guid DefaultNewPageTemplateId { get; set; }|
Guid
|
The Description of the Site, optional attribute.
string Description { get; set; }|
String
|
Gets or sets the design package Id of this site.
Guid DesignPackageId { get; set; }|
Guid
|
Defines whether disable PowerApps for the current web
bool DisableAppViews { get; set; }|
Boolean
|
Defines whether disable flows for the current web
bool DisableFlows { get; set; }|
Boolean
|
Gets or sets whether the recommended items are disabled on this site.
bool DisableRecommendedItems { get; set; }|
Boolean
|
Determines if the Document Library Callout's WAC previewers are enabled or not.
bool DocumentLibraryCalloutOfficeWebAppPreviewersDisabled { get; }|
Boolean
|
Get's the permission levels set on this web
IBasePermissions EffectiveBasePermissions { get; }|
IBasePermissions
|
Gets or sets a Boolean value that specifies whether the Web site should use Minimal Download Strategy.
bool EnableMinimalDownload { get; set; }|
Boolean
|
Event Receivers defined in this web
Implements
See Requesting model collections
and IQueryable performance considerations to learn more.
IEventReceiverDefinitionCollection EventReceivers { get; }|
IEventReceiverDefinitionCollection
|
Defines whether to exclude the web from offline client
bool ExcludeFromOfflineClient { get; set; }|
Boolean
|
Collection of features enabled for the web
Implements
See Requesting model collections
and IQueryable performance considerations to learn more.
IFeatureCollection Features { get; }|
IFeatureCollection
|
Collection of fields in the current Web object
Implements
See Requesting model collections
and IQueryable performance considerations to learn more.
IFieldCollection Fields { get; }|
IFieldCollection
|
Collection of folders in the current Web object
Implements
See Requesting model collections
and IQueryable performance considerations to learn more.
IFolderCollection Folders { get; }|
IFolderCollection
|
Gets or sets the value of the footer emphasis.
FooterVariantThemeType FooterEmphasis { get; set; }|
FooterVariantThemeType
|
Gets or sets a value that specifies whether the footer is enabled on the site.
bool FooterEnabled { get; set; }|
Boolean
|
Gets or sets the value of the footer layout.
FooterLayoutType FooterLayout { get; set; }|
FooterLayoutType
|
Gets or sets the value of the header emphasis.
VariantThemeType HeaderEmphasis { get; set; }|
VariantThemeType
|
Gets or sets the value of the header layout.
HeaderLayoutType HeaderLayout { get; set; }|
HeaderLayoutType
|
Gets or sets a value that specifies whether the title in header is hidden on the site.
bool HideTitleInHeader { get; set; }|
Boolean
|
Defines whether to enable the Horizontal QuickLaunch for the current web
bool HorizontalQuickLaunch { get; set; }|
Boolean
|
The Unique ID of the Web object
Guid Id { get; }|
Guid
|
Gets a value that indicates whether the homepage is modernized.
bool IsHomepageModernized { get; }|
Boolean
|
Defines whether to enable Multilingual capabilities for the current web
bool IsMultilingual { get; set; }|
Boolean
|
Gets a value that indicates whether the provisioning is complete.
bool IsProvisioningComplete { get; }|
Boolean
|
Gets or sets a value that specifies whether the link to revert homepage is hidden.
bool IsRevertHomepageLinkHidden { get; set; }|
Boolean
|
Gets a value that specifies the LCID for the language that is used on the site.
int Language { get; }|
Int32
|
Gets a value that specifies when an item was last modified in the site.
DateTime LastItemModifiedDate { get; }|
DateTime
|
Gets a value that specifies when an item was last modified by user in the site.
DateTime LastItemUserModifiedDate { get; }|
DateTime
|
Collection of lists in the current Web object.
Implements
See Requesting model collections
and IQueryable performance considerations to learn more.
IListCollection Lists { get; }|
IListCollection
|
Gets or sets the logo alignment of the site.
LogoAlignment LogoAlignment { get; set; }|
LogoAlignment
|
Gets or sets the URL of the master page that is used for the website.
string MasterUrl { get; set; }|
String
|
Gets or sets a value that specifies whether the megamenu is enabled on the site.
bool MegaMenuEnabled { get; set; }|
Boolean
|
Defines whether members can share content from the current web
bool MembersCanShare { get; set; }|
Boolean
|
Gets or sets a value that specifies whether the audience targeting is enabled on the navigation of the site.
bool NavAudienceTargetingEnabled { get; set; }|
Boolean
|
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
bool NextStepsFirstRunEnabled { get; set; }|
Boolean
|
Defines whether the site has to be crawled or not
bool NoCrawl { get; set; }|
Boolean
|
Returns if true if the tenant allowed to send push notifications in OneDrive for Business.
bool NotificationsInOneDriveForBusinessEnabled { get; }|
Boolean
|
Returns if true if the tenant allowed to send push notifications in SharePoint.
bool NotificationsInSharePointEnabled { get; }|
Boolean
|
Gets or sets a value that specifies whether the object cache is enabled on the site.
bool ObjectCacheEnabled { get; set; }|
Boolean
|
Defines whether to OverwriteTranslationsOnChange on change for the current web
bool OverwriteTranslationsOnChange { get; set; }|
Boolean
|
Indicates whether the tenant administrator has chosen to disable the Preview Features. Default is true.
bool PreviewFeaturesEnabled { get; }|
Boolean
|
Gets or sets the primary color of the site.
string PrimaryColor { get; }|
String
|
Enables or disables the QuickLaunch for the site
bool QuickLaunchEnabled { get; set; }|
Boolean
|
Gets the recycle bin of the website.
Implements
See Requesting model collections
and IQueryable performance considerations to learn more.
IRecycleBinItemCollection RecycleBin { get; }|
IRecycleBinItemCollection
|
Gets or sets a value that specifies whether the Recycle Bin is enabled.
bool RecycleBinEnabled { get; set; }|
Boolean
|
Regional settings configured for this web
IRegionalSettings RegionalSettings { get; }|
IRegionalSettings
|
The email address to which any access request will be sent
string RequestAccessEmail { get; set; }|
String
|
Role Definitions defined in this web
Implements
See Requesting model collections
and IQueryable performance considerations to learn more.
IRoleDefinitionCollection RoleDefinitions { get; }|
IRoleDefinitionCollection
|
Gets the root folder for the website.
IFolder RootFolder { get; }|
IFolder
|
Gets or sets a Boolean value that specifies whether the Web site can be saved as a site template.
bool SaveSiteAsTemplateEnabled { get; set; }|
Boolean
|
Define if the suitebar search box should show or not
SearchBoxInNavBar SearchBoxInNavBar { get; set; }|
SearchBoxInNavBar
|
Search placeholder text for search box in navbar - overrides default placeholder text if set, returns null if not set.
string SearchBoxPlaceholderText { get; set; }|
String
|
Defines the SearchScope for the site
SearchScope SearchScope { get; set; }|
SearchScope
|
Gets the server relative URL of the current site.
string ServerRelativeUrl { get; }|
String
|
Gets the collection of all groups that belong to the site collection.
Implements
See Requesting model collections
and IQueryable performance considerations to learn more.
ISharePointGroupCollection SiteGroups { get; }|
ISharePointGroupCollection
|
Gets or sets the description of the Web site logo.
string SiteLogoDescription { get; set; }|
String
|
Gets or sets the server-relative URL of the Web site logo. This can also contain an absolute URL to the logo.
string SiteLogoUrl { get; set; }|
String
|
Gets the UserInfo list of the site collection that contains the website.
IList SiteUserInfoList { get; }|
IList
|
Gets the collection of all users that belong to the site collection.
Implements
See Requesting model collections
and IQueryable performance considerations to learn more.
ISharePointUserCollection SiteUsers { get; }|
ISharePointUserCollection
|
List of languages (expressed via their id) that this site supports
List<int> SupportedUILanguageIds { get; }|
PnP.Core.Model.SharePoint.List<Int32>
|
Gets or sets a value that specifies whether the RSS feeds are enabled on the site.
bool SyndicationEnabled { get; set; }|
Boolean
|
Gets or sets a value that specifies how the tenant admin members can share.
SharingState TenantAdminMembersCanShare { get; }|
SharingState
|
Get JSON serialized ThemeData for the current web.
string ThemeData { get; }|
String
|
Gets a value that indicates whether third party MDM (Mobile Device Management) is enabled on the site.
bool ThirdPartyMdmEnabled { get; }|
Boolean
|
The Title of the Site, optional attribute.
string Title { get; set; }|
String
|
Gets or sets value that specifies whether the tree view is enabled on the site.
bool TreeViewEnabled { get; set; }|
Boolean
|
The URL of the Web object
Uri Url { get; }|
Uri
|
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
bool UseAccessRequestDefault { get; }|
Boolean
|
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.
IUserCustomActionCollection UserCustomActions { get; }|
IUserCustomActionCollection
|
Collection of webs in this current web
Implements
See Requesting model collections
and IQueryable performance considerations to learn more.
IWebCollection Webs { get; }|
IWebCollection
|
Gets the name of the site definition or site template that was used to create the site.
string WebTemplate { get; }|
String
|
Gets the web template configuration of the site.
string WebTemplateConfiguration { get; }|
String
|
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
bool WebTemplatesGalleryFirstRunEnabled { get; set; }|
Boolean
|
Specifies a string that contains the site-relative URL to which users are redirected when web is browsed (typically the site's home page).
string WelcomePage { get; }|
String
|
Adds a web property as an indexed property
bool AddIndexedProperty(string propertyName)|
String
propertyName
The property name |
|
Boolean
True if it was successfully added or if it is already exists otherwise false |
The property must already exist as metadata of the Web
Adds a web property as an indexed property
Task<bool> AddIndexedPropertyAsync(string propertyName)|
String
propertyName
The property name |
|
Task<Boolean>
True if it was successfully added or if it is already exists otherwise false |
The property must already exist as metadata of the Web
Returns the current web as ISyntexContentCenter if the web is a Syntex Content Center, null is returned otherwise
ISyntexContentCenter AsSyntexContentCenter()|
ISyntexContentCenter
The current web as ISyntexContentCenter |
Returns the current web as ISyntexContentCenter if the web is a Syntex Content Center, null is returned otherwise
Task<ISyntexContentCenter> AsSyntexContentCenterAsync()|
Task<ISyntexContentCenter>
The current web as ISyntexContentCenter |
Checks if a user has a specific kind of permissions to a web
bool CheckIfUserHasPermissions(string userPrincipalName, PermissionKind permissionKind)|
String
userPrincipalName
Login name of the user you wish to check if he has a specific permission |
|
PermissionKind
permissionKind
Permission kind to check |
|
Boolean
Boolean that says if the user has permissions or not |
Checks if a user has a specific kind of permissions to a web
Task<bool> CheckIfUserHasPermissionsAsync(string userPrincipalName, PermissionKind permissionKind)|
String
userPrincipalName
Login name of the user you wish to check if he has a specific permission |
|
PermissionKind
permissionKind
Permission kind to check |
|
Task<Boolean>
Boolean that says if the user has permissions or not |
Ensure a site can support multilingual (pages) for the passed along languages
void EnsureMultilingual(List<int> requiredLanguageIds)|
PnP.Core.Model.SharePoint.List<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 |
Ensure a site can support multilingual (pages) for the passed along languages
Task EnsureMultilingualAsync(List<int> requiredLanguageIds)|
PnP.Core.Model.SharePoint.List<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 |
|
Task
|
Ensures that page publishing can work for this site. Page scheduling only works for the root web of a site collection
void EnsurePageScheduling()Ensures that page publishing can work for this site. Page scheduling only works for the root web of a site collection
Task EnsurePageSchedulingAsync()|
Task
|
Ensures the given users exists
ISharePointUser EnsureUser(string userPrincipalName)|
String
userPrincipalName
UserPrincipalName value of the user to verify |
|
ISharePointUser
The ensured ISharePointUser |
Ensures the given users exists
Task<ISharePointUser> EnsureUserAsync(string userPrincipalName)|
String
userPrincipalName
UserPrincipalName value of the user to verify |
|
Task<ISharePointUser>
The ensured ISharePointUser |
Ensures the given users exists
ISharePointUser EnsureUserBatch(Batch batch, string userPrincipalName)|
Batch
batch
Batch to add this request to |
|
String
userPrincipalName
UserPrincipalName value of the user to verify |
|
ISharePointUser
The ensured ISharePointUser |
Ensures the given users exists
ISharePointUser EnsureUserBatch(string userPrincipalName)|
String
userPrincipalName
UserPrincipalName value of the user to verify |
|
ISharePointUser
The ensured ISharePointUser |
Ensures the given users exists
Task<ISharePointUser> EnsureUserBatchAsync(Batch batch, string userPrincipalName)|
Batch
batch
Batch to add this request to |
|
String
userPrincipalName
UserPrincipalName value of the user to verify |
|
Task<ISharePointUser>
The ensured ISharePointUser |
Ensures the given users exists
Task<ISharePointUser> EnsureUserBatchAsync(string userPrincipalName)|
String
userPrincipalName
UserPrincipalName value of the user to verify |
|
Task<ISharePointUser>
The ensured ISharePointUser |
Returns the branding manager which can be used to change the look of the web
IBrandingManager GetBrandingManager()|
IBrandingManager
An IBrandingManager instance |
Get's the current logged on user making the request to SharePoint
ISharePointUser GetCurrentUser()|
ISharePointUser
The current ISharePointUser |
Get's the current logged on user making the request to SharePoint
Task<ISharePointUser> GetCurrentUserAsync()|
Task<ISharePointUser>
The current ISharePointUser |
Get's the current logged on user making the request to SharePoint
ISharePointUser GetCurrentUserBatch()|
ISharePointUser
The current ISharePointUser |
Get's the current logged on user making the request to SharePoint
ISharePointUser GetCurrentUserBatch(Batch batch)|
Batch
batch
Batch to add this request to |
|
ISharePointUser
The current ISharePointUser |
Get's the current logged on user making the request to SharePoint
Task<ISharePointUser> GetCurrentUserBatchAsync()|
Task<ISharePointUser>
The current ISharePointUser |
Get's the current logged on user making the request to SharePoint
Task<ISharePointUser> GetCurrentUserBatchAsync(Batch batch)|
Batch
batch
Batch to add this request to |
|
Task<ISharePointUser>
The current ISharePointUser |
Get a file in the current web from its unique id.
IFile GetFileById(Guid uniqueFileId, params Expression<Func<IFile, object>>[] expressions)|
Guid
uniqueFileId
The unique id of the file to get. |
|
Expression<Func<IFile, Object>>[]
expressions
Properties to load for the requested IFile |
|
IFile
The file to get |
Get a file in the current web from its unique id.
Task<IFile> GetFileByIdAsync(Guid uniqueFileId, params Expression<Func<IFile, object>>[] expressions)|
Guid
uniqueFileId
The unique id of the file to get. |
|
Expression<Func<IFile, Object>>[]
expressions
Properties to load for the requested IFile |
|
Task<IFile>
The file to get |
Get a file in the current web from its unique id via batch.
IFile GetFileByIdBatch(Guid uniqueFileId, params Expression<Func<IFile, object>>[] expressions)|
Guid
uniqueFileId
The unique id of the file to get. |
|
Expression<Func<IFile, Object>>[]
expressions
Properties to load for the requested IFile |
|
IFile
The file to get |
Get a file in the current web from its unique id via batch.
IFile GetFileByIdBatch(Batch batch, Guid uniqueFileId, params Expression<Func<IFile, object>>[] expressions)|
Batch
batch
Batch to add this request to |
|
Guid
uniqueFileId
The unique id of the file to get. |
|
Expression<Func<IFile, Object>>[]
expressions
Properties to load for the requested IFile |
|
IFile
The file to get |
Get a file in the current web from its unique id via batch.
Task<IFile> GetFileByIdBatchAsync(Guid uniqueFileId, params Expression<Func<IFile, object>>[] expressions)|
Guid
uniqueFileId
The unique id of the file to get. |
|
Expression<Func<IFile, Object>>[]
expressions
Properties to load for the requested IFile |
|
Task<IFile>
The file to get |
Get a file in the current web from its unique id via batch.
Task<IFile> GetFileByIdBatchAsync(Batch batch, Guid uniqueFileId, params Expression<Func<IFile, object>>[] expressions)|
Batch
batch
Batch to add this request to |
|
Guid
uniqueFileId
The unique id of the file to get. |
|
Expression<Func<IFile, Object>>[]
expressions
Properties to load for the requested IFile |
|
Task<IFile>
The file to get |
Get's a file from a given link (sharing link, path to file)
IFile GetFileByLink(string link, params Expression<Func<IFile, object>>[] expressions)|
String
link
Link pointing to a file |
|
Expression<Func<IFile, Object>>[]
expressions
Properties to load for the requested IFile |
|
IFile
IFile reference when the file could be found, exception otherwise |
Get's a file from a given link (sharing link, path to file)
Task<IFile> GetFileByLinkAsync(string link, params Expression<Func<IFile, object>>[] expressions)|
String
link
Link pointing to a file |
|
Expression<Func<IFile, Object>>[]
expressions
Properties to load for the requested IFile |
|
Task<IFile>
IFile reference when the file could be found, exception otherwise |
Get a file in the current web from its server relative URL.
IFile GetFileByServerRelativeUrl(string serverRelativeUrl, params Expression<Func<IFile, object>>[] expressions)|
String
serverRelativeUrl
The server relative URL of the file to get. |
|
Expression<Func<IFile, Object>>[]
expressions
Properties to load for the requested IFile |
|
IFile
The file to get |
Get a file in the current web from its server relative URL.
Task<IFile> GetFileByServerRelativeUrlAsync(string serverRelativeUrl, params Expression<Func<IFile, object>>[] expressions)|
String
serverRelativeUrl
The server relative URL of the file to get. |
|
Expression<Func<IFile, Object>>[]
expressions
Properties to load for the requested IFile |
|
Task<IFile>
The file to get |
Get a file in the current web from its server relative URL via batch.
IFile GetFileByServerRelativeUrlBatch(Batch batch, string serverRelativeUrl, params Expression<Func<IFile, object>>[] expressions)|
Batch
batch
Batch to add this request to |
|
String
serverRelativeUrl
The server relative URL of the file to get. |
|
Expression<Func<IFile, Object>>[]
expressions
Properties to load for the requested IFile |
|
IFile
The file to get |
Get a file in the current web from its server relative URL via batch.
IFile GetFileByServerRelativeUrlBatch(string serverRelativeUrl, params Expression<Func<IFile, object>>[] expressions)|
String
serverRelativeUrl
The server relative URL of the file to get. |
|
Expression<Func<IFile, Object>>[]
expressions
Properties to load for the requested IFile |
|
IFile
The file to get |
Get a file in the current web from its server relative URL via batch.
Task<IFile> GetFileByServerRelativeUrlBatchAsync(Batch batch, string serverRelativeUrl, params Expression<Func<IFile, object>>[] expressions)|
Batch
batch
Batch to add this request to |
|
String
serverRelativeUrl
The server relative URL of the file to get. |
|
Expression<Func<IFile, Object>>[]
expressions
Properties to load for the requested IFile |
|
Task<IFile>
The file to get |
Get a file in the current web from its server relative URL via batch.
Task<IFile> GetFileByServerRelativeUrlBatchAsync(string serverRelativeUrl, params Expression<Func<IFile, object>>[] expressions)|
String
serverRelativeUrl
The server relative URL of the file to get. |
|
Expression<Func<IFile, Object>>[]
expressions
Properties to load for the requested IFile |
|
Task<IFile>
The file to get |
Get a file in the current web from its server relative URL, it not available null will be returned
IFile GetFileByServerRelativeUrlOrDefault(string serverRelativeUrl, params Expression<Func<IFile, object>>[] expressions)|
String
serverRelativeUrl
The server relative URL of the file to get. |
|
Expression<Func<IFile, Object>>[]
expressions
Properties to load for the requested IFile |
|
IFile
The file to get or null if the file was not available |
Get a file in the current web from its server relative URL, it not available null will be returned
Task<IFile> GetFileByServerRelativeUrlOrDefaultAsync(string serverRelativeUrl, params Expression<Func<IFile, object>>[] expressions)|
String
serverRelativeUrl
The server relative URL of the file to get. |
|
Expression<Func<IFile, Object>>[]
expressions
Properties to load for the requested IFile |
|
Task<IFile>
The file to get or null if the file was not available |
Get a folder in the current web from its id.
IFolder GetFolderById(Guid folderId, params Expression<Func<IFolder, object>>[] expressions)|
Guid
folderId
The id of the folder to get. |
|
Expression<Func<IFolder, Object>>[]
expressions
Expressions needed to create the request |
|
IFolder
The folder to get |
Get a folder in the current web from its id.
Task<IFolder> GetFolderByIdAsync(Guid folderId, params Expression<Func<IFolder, object>>[] expressions)|
Guid
folderId
The id of the folder to get. |
|
Expression<Func<IFolder, Object>>[]
expressions
Expressions needed to create the request |
|
Task<IFolder>
The folder to get |
Get a folder in the current web from its id via batch.
IFolder GetFolderByIdBatch(Guid folderId, params Expression<Func<IFolder, object>>[] expressions)|
Guid
folderId
The id of the folder to get. |
|
Expression<Func<IFolder, Object>>[]
expressions
Expressions needed to create the request |
|
IFolder
The folder to get |
Get a folder in the current web from its id via batch.
IFolder GetFolderByIdBatch(Batch batch, Guid folderId, params Expression<Func<IFolder, object>>[] expressions)|
Batch
batch
Batch to add this request to |
|
Guid
folderId
The id of the folder to get. |
|
Expression<Func<IFolder, Object>>[]
expressions
Expressions needed to create the request |
|
IFolder
The folder to get |
Get a folder in the current web from its id via batch.
Task<IFolder> GetFolderByIdBatchAsync(Guid folderId, params Expression<Func<IFolder, object>>[] expressions)|
Guid
folderId
The id of the folder to get. |
|
Expression<Func<IFolder, Object>>[]
expressions
Expressions needed to create the request |
|
Task<IFolder>
The folder to get |
Get a folder in the current web from its id via batch.
Task<IFolder> GetFolderByIdBatchAsync(Batch batch, Guid folderId, params Expression<Func<IFolder, object>>[] expressions)|
Batch
batch
Batch to add this request to |
|
Guid
folderId
The id of the folder to get. |
|
Expression<Func<IFolder, Object>>[]
expressions
Expressions needed to create the request |
|
Task<IFolder>
The folder to get |
Get a folder in the current web from its server relative URL.
IFolder GetFolderByServerRelativeUrl(string serverRelativeUrl, params Expression<Func<IFolder, object>>[] expressions)|
String
serverRelativeUrl
The server relative URL of the folder to get. |
|
Expression<Func<IFolder, Object>>[]
expressions
Expressions needed to create the request |
|
IFolder
The folder to get |
Get a folder in the current web from its server relative URL.
Task<IFolder> GetFolderByServerRelativeUrlAsync(string serverRelativeUrl, params Expression<Func<IFolder, object>>[] expressions)|
String
serverRelativeUrl
The server relative URL of the folder to get. |
|
Expression<Func<IFolder, Object>>[]
expressions
Expressions needed to create the request |
|
Task<IFolder>
The folder to get |
Get a folder in the current web from its server relative URL via batch.
IFolder GetFolderByServerRelativeUrlBatch(Batch batch, string serverRelativeUrl, params Expression<Func<IFolder, object>>[] expressions)|
Batch
batch
Batch to add this request to |
|
String
serverRelativeUrl
The server relative URL of the folder to get. |
|
Expression<Func<IFolder, Object>>[]
expressions
Expressions needed to create the request |
|
IFolder
The folder to get |
Get a folder in the current web from its server relative URL via batch.
IFolder GetFolderByServerRelativeUrlBatch(string serverRelativeUrl, params Expression<Func<IFolder, object>>[] expressions)|
String
serverRelativeUrl
The server relative URL of the folder to get. |
|
Expression<Func<IFolder, Object>>[]
expressions
Expressions needed to create the request |
|
IFolder
The folder to get |
Get a folder in the current web from its server relative URL via batch.
Task<IFolder> GetFolderByServerRelativeUrlBatchAsync(Batch batch, string serverRelativeUrl, params Expression<Func<IFolder, object>>[] expressions)|
Batch
batch
Batch to add this request to |
|
String
serverRelativeUrl
The server relative URL of the folder to get. |
|
Expression<Func<IFolder, Object>>[]
expressions
Expressions needed to create the request |
|
Task<IFolder>
The folder to get |
Get a folder in the current web from its server relative URL via batch.
Task<IFolder> GetFolderByServerRelativeUrlBatchAsync(string serverRelativeUrl, params Expression<Func<IFolder, object>>[] expressions)|
String
serverRelativeUrl
The server relative URL of the folder to get. |
|
Expression<Func<IFolder, Object>>[]
expressions
Expressions needed to create the request |
|
Task<IFolder>
The folder to get |
Gets the modern pages of this site, optionally scoped down via a filter
List<IPage> GetPages(string pageName = null)|
String
pageName
Page name to filter on, uses a "starts with" filter |
|
PnP.Core.Model.SharePoint.List<IPage>
One of more modern pages |
Gets the modern pages of this site, optionally scoped down via a filter
Task<List<IPage>> GetPagesAsync(string pageName = null)|
String
pageName
Page name to filter on, uses a "starts with" filter |
|
Task<PnP.Core.Model.SharePoint.List<IPage>>
One of more modern pages |
Searches the recyclebin returning items based upon the passed search criteria
IRecycleBinItemCollection GetRecycleBinItemsByQuery(RecycleBinQueryOptions options)|
RecycleBinQueryOptions
options
Recycle bin search criteria |
|
IRecycleBinItemCollection
A list containing zero or more recycle bin items |
Searches the recyclebin returning items based upon the passed search criteria
Task<IRecycleBinItemCollection> GetRecycleBinItemsByQueryAsync(RecycleBinQueryOptions options)|
RecycleBinQueryOptions
options
Recycle bin search criteria |
|
Task<IRecycleBinItemCollection>
A list containing zero or more recycle bin items |
Searches the recyclebin returning items based upon the passed search criteria
IRecycleBinItemCollection GetRecycleBinItemsByQueryBatch(RecycleBinQueryOptions options)|
RecycleBinQueryOptions
options
Recycle bin search criteria |
|
IRecycleBinItemCollection
A list containing zero or more recycle bin items |
Searches the recyclebin returning items based upon the passed search criteria
IRecycleBinItemCollection GetRecycleBinItemsByQueryBatch(Batch batch, RecycleBinQueryOptions options)|
Batch
batch
Batch to add this request to |
|
RecycleBinQueryOptions
options
Recycle bin search criteria |
|
IRecycleBinItemCollection
A list containing zero or more recycle bin items |
Searches the recyclebin returning items based upon the passed search criteria
Task<IRecycleBinItemCollection> GetRecycleBinItemsByQueryBatchAsync(RecycleBinQueryOptions options)|
RecycleBinQueryOptions
options
Recycle bin search criteria |
|
Task<IRecycleBinItemCollection>
A list containing zero or more recycle bin items |
Searches the recyclebin returning items based upon the passed search criteria
Task<IRecycleBinItemCollection> GetRecycleBinItemsByQueryBatchAsync(Batch batch, RecycleBinQueryOptions options)|
Batch
batch
Batch to add this request to |
|
RecycleBinQueryOptions
options
Recycle bin search criteria |
|
Task<IRecycleBinItemCollection>
A list containing zero or more recycle bin items |
Gets the managed properties from the search configuration of this web
List<IManagedProperty> GetSearchConfigurationManagedProperties()|
PnP.Core.Model.SharePoint.List<IManagedProperty>
List of managed properties |
Gets the managed properties from the search configuration of this web
Task<List<IManagedProperty>> GetSearchConfigurationManagedPropertiesAsync()|
Task<PnP.Core.Model.SharePoint.List<IManagedProperty>>
List of managed properties |
Gets the search configuration of the web
string GetSearchConfigurationXml()|
String
Search configuration XML |
Gets the search configuration of the web
Task<string> GetSearchConfigurationXmlAsync()|
Task<String>
Search configuration XML |
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
ISharePointUser GetUserById(int userId)|
Int32
userId
Id of the user to get |
|
ISharePointUser
The found user as ISharePointPrincipal |
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
Task<ISharePointUser> GetUserByIdAsync(int userId)|
Int32
userId
Id of the user to get |
|
Task<ISharePointUser>
The found user as ISharePointPrincipal |
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
ISharePointUser GetUserByIdBatch(Batch batch, int userId)|
Batch
batch
Batch to add this request to |
|
Int32
userId
Id of the user to get |
|
ISharePointUser
The found user as ISharePointPrincipal |
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
ISharePointUser GetUserByIdBatch(int userId)|
Int32
userId
Id of the user to get |
|
ISharePointUser
The found user as ISharePointPrincipal |
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
Task<ISharePointUser> GetUserByIdBatchAsync(Batch batch, int userId)|
Batch
batch
Batch to add this request to |
|
Int32
userId
Id of the user to get |
|
Task<ISharePointUser>
The found user as ISharePointPrincipal |
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
Task<ISharePointUser> GetUserByIdBatchAsync(int userId)|
Int32
userId
Id of the user to get |
|
Task<ISharePointUser>
The found user as ISharePointPrincipal |
Gets the user effective permissions of a user for a web
IBasePermissions GetUserEffectivePermissions(string userPrincipalName)|
String
userPrincipalName
Login name of the user you wish to retrieve the permissions of |
|
IBasePermissions
Base permissions object that contains the High and the Low permissions |
Gets the user effective permissions of a user for a web
Task<IBasePermissions> GetUserEffectivePermissionsAsync(string userPrincipalName)|
String
userPrincipalName
Login name of the user you wish to retrieve the permissions of |
|
Task<IBasePermissions>
Base permissions object that contains the High and the Low permissions |
Gets Viva Connections dashboard. If there is no dashboard configured, returns null
IVivaDashboard GetVivaDashboard()|
IVivaDashboard
Viva Dashboard or null |
Gets Viva Connections dashboard. If there is no dashboard configured, returns null
Task<IVivaDashboard> GetVivaDashboardAsync()|
Task<IVivaDashboard>
Viva Dashboard or null |
Return a specific web template based by a name
IWebTemplate GetWebTemplateByName(string name, int lcid = 1033, bool includeCrossLanguage = false)|
String
name
Name of the template to retrieve |
|
Int32
lcid
Specifies the LCID of the site templates to be retrieved. |
|
Boolean
includeCrossLanguage
Specifies whether to include language-neutral site templates. |
|
IWebTemplate
The template with the specified name, if available |
Return a specific web template based by a name
Task<IWebTemplate> GetWebTemplateByNameAsync(string name, int lcid = 1033, bool includeCrossLanguage = false)|
String
name
Name of the template to retrieve |
|
Int32
lcid
Specifies the LCID of the site templates to be retrieved. |
|
Boolean
includeCrossLanguage
Specifies whether to include language-neutral site templates. |
|
Task<IWebTemplate>
The template with the specified name, if available |
Return a specific web template based by a name
IBatchSingleResult<IWebTemplate> GetWebTemplateByNameBatch(Batch batch, string name, int lcid = 1033, bool includeCrossLanguage = false)|
Batch
batch
Batch to add this request to |
|
String
name
Name of the template to retrieve |
|
Int32
lcid
Specifies the LCID of the site templates to be retrieved. |
|
Boolean
includeCrossLanguage
Specifies whether to include language-neutral site templates. |
|
IBatchSingleResult<IWebTemplate>
The template with the specified name, if available |
Return a specific web template based by a name
IBatchSingleResult<IWebTemplate> GetWebTemplateByNameBatch(string name, int lcid = 1033, bool includeCrossLanguage = false)|
String
name
Name of the template to retrieve |
|
Int32
lcid
Specifies the LCID of the site templates to be retrieved. |
|
Boolean
includeCrossLanguage
Specifies whether to include language-neutral site templates. |
|
IBatchSingleResult<IWebTemplate>
The template with the specified name, if available |
Return a specific web template based by a name
Task<IBatchSingleResult<IWebTemplate>> GetWebTemplateByNameBatchAsync(Batch batch, string name, int lcid = 1033, bool includeCrossLanguage = false)|
Batch
batch
Batch to add this request to |
|
String
name
Name of the template to retrieve |
|
Int32
lcid
Specifies the LCID of the site templates to be retrieved. |
|
Boolean
includeCrossLanguage
Specifies whether to include language-neutral site templates. |
|
Task<IBatchSingleResult<IWebTemplate>>
The template with the specified name, if available |
Return a specific web template based by a name
Task<IBatchSingleResult<IWebTemplate>> GetWebTemplateByNameBatchAsync(string name, int lcid = 1033, bool includeCrossLanguage = false)|
String
name
Name of the template to retrieve |
|
Int32
lcid
Specifies the LCID of the site templates to be retrieved. |
|
Boolean
includeCrossLanguage
Specifies whether to include language-neutral site templates. |
|
Task<IBatchSingleResult<IWebTemplate>>
The list of webtemplates available on the current web |
Returns a collection of site templates available for the site.
List<IWebTemplate> GetWebTemplates(int lcid = 1033, bool includeCrossLanguage = false)|
Int32
lcid
Specifies the LCID of the site templates to be retrieved. |
|
Boolean
includeCrossLanguage
Specifies whether to include language-neutral site templates. |
|
PnP.Core.Model.SharePoint.List<IWebTemplate>
The list of webtemplates available on the current web |
Returns a collection of site templates available for the site.
Task<List<IWebTemplate>> GetWebTemplatesAsync(int lcid = 1033, bool includeCrossLanguage = false)|
Int32
lcid
Specifies the LCID of the site templates to be retrieved. |
|
Boolean
includeCrossLanguage
Specifies whether to include language-neutral site templates. |
|
Task<PnP.Core.Model.SharePoint.List<IWebTemplate>>
The list of webtemplates available on the current web |
Returns a collection of site templates available for the site.
IEnumerableBatchResult<IWebTemplate> GetWebTemplatesBatch(Batch batch, int lcid = 1033, bool includeCrossLanguage = false)|
Batch
batch
Batch to add this request to |
|
Int32
lcid
Specifies the LCID of the site templates to be retrieved. |
|
Boolean
includeCrossLanguage
Specifies whether to include language-neutral site templates. |
|
IEnumerableBatchResult<IWebTemplate>
The list of webtemplates available on the current web |
Returns a collection of site templates available for the site.
IEnumerableBatchResult<IWebTemplate> GetWebTemplatesBatch(int lcid = 1033, bool includeCrossLanguage = false)|
Int32
lcid
Specifies the LCID of the site templates to be retrieved. |
|
Boolean
includeCrossLanguage
Specifies whether to include language-neutral site templates. |
|
IEnumerableBatchResult<IWebTemplate>
The list of webtemplates available on the current web |
Returns a collection of site templates available for the site.
Task<IEnumerableBatchResult<IWebTemplate>> GetWebTemplatesBatchAsync(Batch batch, int lcid = 1033, bool includeCrossLanguage = false)|
Batch
batch
Batch to add this request to |
|
Int32
lcid
Specifies the LCID of the site templates to be retrieved. |
|
Boolean
includeCrossLanguage
Specifies whether to include language-neutral site templates. |
|
Task<IEnumerableBatchResult<IWebTemplate>>
The list of webtemplates available on the current web |
Returns a collection of site templates available for the site.
Task<IEnumerableBatchResult<IWebTemplate>> GetWebTemplatesBatchAsync(int lcid = 1033, bool includeCrossLanguage = false)|
Int32
lcid
Specifies the LCID of the site templates to be retrieved. |
|
Boolean
includeCrossLanguage
Specifies whether to include language-neutral site templates. |
|
Task<IEnumerableBatchResult<IWebTemplate>>
The list of webtemplates available on the current web |
Returns the Id for a term if present in the TaxonomyHiddenList. Otherwise returns -1;
int GetWssIdForTerm(string termId)|
String
termId
Id of the term to lookup |
|
Int32
Id of the term in the taxonomy hidden list, otherwise -1 |
Returns the Id for a term if present in the TaxonomyHiddenList. Otherwise returns -1;
Task<int> GetWssIdForTermAsync(string termId)|
String
termId
Id of the term to lookup |
|
Task<Int32>
Id of the term in the taxonomy hidden list, otherwise -1 |
Does this web have the communication site features enabled?
bool HasCommunicationSiteFeatures()|
Boolean
True if enabled, false otherwise |
Does this web have the communication site features enabled?
Task<bool> HasCommunicationSiteFeaturesAsync()|
Task<Boolean>
True if enabled, false otherwise |
Checks if this web is configured for NoScript
bool IsNoScriptSite()|
Boolean
True if set to NoScript, false otherwise |
Checks if this web is configured for NoScript
Task<bool> IsNoScriptSiteAsync()|
Task<Boolean>
True if set to NoScript, false otherwise |
Checks if this web is a sub site
bool IsSubSite()|
Boolean
True if the web is a sub site |
Checks if this web is a sub site
Task<bool> IsSubSiteAsync()|
Task<Boolean>
True if the web is a sub site |
Is this web a Syntex Content Center
bool IsSyntexContentCenter()|
Boolean
True if this web is a Syntex Content Center, false otherwise |
Is this web a Syntex Content Center
Task<bool> IsSyntexContentCenterAsync()|
Task<Boolean>
True if this web is a Syntex Content Center, false otherwise |
Is the tenant enabled for SharePoint Syntex
bool IsSyntexEnabled()|
Boolean
True if SharePoint Syntex is enabled, false otherwise |
Is the tenant enabled for SharePoint Syntex
Task<bool> IsSyntexEnabledAsync()|
Task<Boolean>
True if SharePoint Syntex is enabled, false otherwise |
Is SharePoint Syntex enabled for the current user
bool IsSyntexEnabledForCurrentUser()|
Boolean
True if SharePoint Syntex is enabled for the current user, false otherwise |
Is SharePoint Syntex enabled for the current user
Task<bool> IsSyntexEnabledForCurrentUserAsync()|
Task<Boolean>
True if SharePoint Syntex is enabled for the current user, false otherwise |
Creates a new modern page
IPage NewPage(PageLayoutType pageLayoutType = default(PageLayoutType))|
PageLayoutType
pageLayoutType
Optionally specify the page type, defaults to Article |
|
IPage
Created modern page |
Creates a new modern page
Task<IPage> NewPageAsync(PageLayoutType pageLayoutType = default(PageLayoutType))|
PageLayoutType
pageLayoutType
Optionally specify the page type, defaults to Article |
|
Task<IPage>
Created modern page |
Reindexes this web
void ReIndex()Reindexes this web
Task ReIndexAsync()|
Task
|
Removes a web propetry from the indexed properties
bool RemoveIndexedProperty(string propertyName)|
String
propertyName
The property name |
|
Boolean
True if it was successfully removed otherwise false |
Removes a web propetry from the indexed properties
Task<bool> RemoveIndexedPropertyAsync(string propertyName)|
String
propertyName
The property name |
|
Task<Boolean>
True if it was successfully removed otherwise false |
Performs a search query
ISearchResult Search(SearchOptions query)|
SearchOptions
query
Search query to run |
|
ISearchResult
The results of the search query |
Performs a search query
Task<ISearchResult> SearchAsync(SearchOptions query)|
SearchOptions
query
Search query to run |
|
Task<ISearchResult>
The results of the search query |
Performs a search query
IBatchSingleResult<ISearchResult> SearchBatch(SearchOptions query)|
SearchOptions
query
Search query to run |
|
IBatchSingleResult<ISearchResult>
The results of the search query |
Performs a search query
IBatchSingleResult<ISearchResult> SearchBatch(Batch batch, SearchOptions query)|
Batch
batch
Batch to add this request to |
|
SearchOptions
query
Search query to run |
|
IBatchSingleResult<ISearchResult>
The results of the search query |
Performs a search query
Task<IBatchSingleResult<ISearchResult>> SearchBatchAsync(SearchOptions query)|
SearchOptions
query
Search query to run |
|
Task<IBatchSingleResult<ISearchResult>>
The results of the search query |
Performs a search query
Task<IBatchSingleResult<ISearchResult>> SearchBatchAsync(Batch batch, SearchOptions query)|
Batch
batch
Batch to add this request to |
|
SearchOptions
query
Search query to run |
|
Task<IBatchSingleResult<ISearchResult>>
The results of the search query |
Applies the access request settings
Task SetAccessRequest(AccessRequestOption operation, string email = null)|
AccessRequestOption
operation
The operation to be performed |
|
String
email
Applies the email address for the 'SpecificMail' operation |
|
Task
|
Applies the access request settings
Task SetAccessRequestAsync(AccessRequestOption operation, string email = null)|
AccessRequestOption
operation
The operation to be performed |
|
String
email
Applies the email address for the 'SpecificMail' operation |
|
Task
|
Sets the search configuration for the web
void SetSearchConfigurationXml(string configuration)|
String
configuration
Search configuration, obtained via GetSearchConfigurationXml() to apply |
Sets the search configuration for the web
Task SetSearchConfigurationXmlAsync(string configuration)|
String
configuration
Search configuration, obtained via GetSearchConfigurationXml() to apply |
|
Task
|
Sync the hub site theme from parent hub site
Task SyncHubSiteThemeAsync()|
Task
|
Takes in a sharing or regular SharePoint link and tries to provide relavant information about the resource behind the passed in link
IUnfurledResource UnfurlLink(string link, UnfurlOptions unfurlOptions = null)|
String
link
Link to resource to get information for |
|
UnfurlOptions
unfurlOptions
Options to control the unfurling data gathering |
|
IUnfurledResource
Data about the unfurled resource |
Takes in a sharing or regular SharePoint link and tries to provide relavant information about the resource behind the passed in link
Task<IUnfurledResource> UnfurlLinkAsync(string link, UnfurlOptions unfurlOptions = null)|
String
link
Link to resource to get information for |
|
UnfurlOptions
unfurlOptions
Options to control the unfurling data gathering |
|
Task<IUnfurledResource>
Data about the unfurled resource |
Checks if the provided list of user UPN's are valid users in Azure AD and returns the 'ensured' SharePoint user
IList<ISharePointUser> ValidateAndEnsureUsers(IList<string> userList)|
PnP.Core.Model.SharePoint.IList<String>
userList
List of user UPN's to validate in Azure AD |
|
PnP.Core.Model.SharePoint.IList<ISharePointUser>
The list of ISharePointUser that exist |
Checks if the provided list of user UPN's are valid users in Azure AD and returns the 'ensured' SharePoint user
Task<IList<ISharePointUser>> ValidateAndEnsureUsersAsync(IList<string> userList)|
PnP.Core.Model.SharePoint.IList<String>
userList
List of user UPN's to validate in Azure AD |
|
Task<PnP.Core.Model.SharePoint.IList<ISharePointUser>>
The list of ISharePointUser that exist |
Checks if the provided list of user UPN's are valid users in Azure AD
IList<string> ValidateUsers(IList<string> userList)|
PnP.Core.Model.SharePoint.IList<String>
userList
List of user UPN's to validate in Azure AD |
|
PnP.Core.Model.SharePoint.IList<String>
A list of users that were not found in Azure AD |
Checks if the provided list of user UPN's are valid users in Azure AD
Task<IList<string>> ValidateUsersAsync(IList<string> userList)|
PnP.Core.Model.SharePoint.IList<String>
userList
List of user UPN's to validate in Azure AD |
Task<PnP.Core.Model.SharePoint.IList<String>>
|