Search Results for

    Show / Hide Table of Contents

    Interface IWeb

    Public interface to define a Web object of SharePoint Online

    Inherited Members
    IDataModel<IWeb>.Requested
    IDataModel<IWeb>.HasValue(String)
    IDataModel<IWeb>.HasChanged(String)
    IDataModel<IWeb>.IsPropertyAvailable(Expression<Func<IWeb, Object>>)
    IDataModel<IWeb>.ArePropertiesAvailable(Expression<Func<IWeb, Object>>[])
    IDataModel<IWeb>.EnsureProperties(Expression<Func<IWeb, Object>>[])
    IDataModel<IWeb>.EnsurePropertiesAsync(Expression<Func<IWeb, Object>>[])
    IDataModel<IWeb>.ExecuteRequestAsync(ApiRequest)
    IDataModel<IWeb>.ExecuteRequest(ApiRequest)
    IDataModel<IWeb>.ExecuteRequestBatchAsync(ApiRequest)
    IDataModel<IWeb>.ExecuteRequestBatch(ApiRequest)
    IDataModel<IWeb>.ExecuteRequestBatchAsync(Batch, ApiRequest)
    IDataModel<IWeb>.ExecuteRequestBatch(Batch, ApiRequest)
    IDataModelParent.Parent
    IDataModelWithContext.PnPContext
    IDataModelGet<IWeb>.GetBatchAsync(Batch, Expression<Func<IWeb, Object>>[])
    IDataModelGet<IWeb>.GetAsync(Expression<Func<IWeb, Object>>[])
    IDataModelLoad<IWeb>.LoadBatchAsync(Batch, Expression<Func<IWeb, Object>>[])
    IDataModelLoad<IWeb>.LoadAsync(Expression<Func<IWeb, Object>>[])
    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<IWeb>, IDataModelParent, IDataModelWithContext, ISupportModules<IWeb>, IDataModelGet<IWeb>, IDataModelLoad<IWeb>, 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
    String

    AccessRequestSiteDescription

    Gets or sets the description of the access request to this site.

    Declaration
    string AccessRequestSiteDescription { get; set; }
    Property Value
    String

    All

    A special property used to add an asterisk to a $select statement

    Declaration
    object All { get; }
    Property Value
    Object

    AllowAutomaticASPXPageIndexing

    Gets a value that specifies whether the automatic ASPX page indexed is allowed.

    Declaration
    bool AllowAutomaticASPXPageIndexing { get; set; }
    Property Value
    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
    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
    Boolean

    AllowMasterPageEditingForCurrentUser

    Gets a value that specifies whether the current user is allowed to edit the master page.

    Declaration
    bool AllowMasterPageEditingForCurrentUser { get; }
    Property Value
    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
    Boolean

    AllowRssFeeds

    Gets a value that specifies whether the site allows RSS feeds.

    Declaration
    bool AllowRssFeeds { get; }
    Property Value
    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
    Boolean

    AllowSavePublishDeclarativeWorkflowForCurrentUser

    Gets a value that specifies whether the current user is allowed to publish a declarative workflow.

    Declaration
    bool AllowSavePublishDeclarativeWorkflowForCurrentUser { get; }
    Property Value
    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
    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
    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
    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
    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
    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
    Boolean

    DisableFlows

    Defines whether disable flows for the current web

    Declaration
    bool DisableFlows { get; set; }
    Property Value
    Boolean

    DisableRecommendedItems

    Gets or sets whether the recommended items are disabled on this site.

    Declaration
    bool DisableRecommendedItems { get; set; }
    Property Value
    Boolean

    DocumentLibraryCalloutOfficeWebAppPreviewersDisabled

    Determines if the Document Library Callout's WAC previewers are enabled or not.

    Declaration
    bool DocumentLibraryCalloutOfficeWebAppPreviewersDisabled { get; }
    Property Value
    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
    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
    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
    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
    Boolean

    HorizontalQuickLaunch

    Defines whether to enable the Horizontal QuickLaunch for the current web

    Declaration
    bool HorizontalQuickLaunch { get; set; }
    Property Value
    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
    Boolean

    IsMultilingual

    Defines whether to enable Multilingual capabilities for the current web

    Declaration
    bool IsMultilingual { get; set; }
    Property Value
    Boolean

    IsProvisioningComplete

    Gets a value that indicates whether the provisioning is complete.

    Declaration
    bool IsProvisioningComplete { get; }
    Property Value
    Boolean

    IsRevertHomepageLinkHidden

    Gets or sets a value that specifies whether the link to revert homepage is hidden.

    Declaration
    bool IsRevertHomepageLinkHidden { get; set; }
    Property Value
    Boolean

    Language

    Gets a value that specifies the LCID for the language that is used on the site.

    Declaration
    int Language { get; }
    Property Value
    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
    String

    MegaMenuEnabled

    Gets or sets a value that specifies whether the megamenu is enabled on the site.

    Declaration
    bool MegaMenuEnabled { get; set; }
    Property Value
    Boolean

    MembersCanShare

    Defines whether members can share content from the current web

    Declaration
    bool MembersCanShare { get; set; }
    Property Value
    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
    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
    Boolean

    NoCrawl

    Defines whether the site has to be crawled or not

    Declaration
    bool NoCrawl { get; set; }
    Property Value
    Boolean

    NotificationsInOneDriveForBusinessEnabled

    Returns if true if the tenant allowed to send push notifications in OneDrive for Business.

    Declaration
    bool NotificationsInOneDriveForBusinessEnabled { get; }
    Property Value
    Boolean

    NotificationsInSharePointEnabled

    Returns if true if the tenant allowed to send push notifications in SharePoint.

    Declaration
    bool NotificationsInSharePointEnabled { get; }
    Property Value
    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
    Boolean

    OverwriteTranslationsOnChange

    Defines whether to OverwriteTranslationsOnChange on change for the current web

    Declaration
    bool OverwriteTranslationsOnChange { get; set; }
    Property Value
    Boolean

    PreviewFeaturesEnabled

    Indicates whether the tenant administrator has chosen to disable the Preview Features. Default is true.

    Declaration
    bool PreviewFeaturesEnabled { get; }
    Property Value
    Boolean

    PrimaryColor

    Gets or sets the primary color of the site.

    Declaration
    string PrimaryColor { get; }
    Property Value
    String

    QuickLaunchEnabled

    Enables or disables the QuickLaunch for the site

    Declaration
    bool QuickLaunchEnabled { get; set; }
    Property Value
    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
    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
    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
    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
    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
    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
    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
    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<int> SupportedUILanguageIds { get; }
    Property Value
    PnP.Core.Model.SharePoint.List<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
    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
    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
    Boolean

    Title

    The Title of the Site, optional attribute.

    Declaration
    string Title { get; set; }
    Property Value
    String

    TreeViewEnabled

    Gets or sets value that specifies whether the tree view is enabled on the site.

    Declaration
    bool TreeViewEnabled { get; set; }
    Property Value
    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
    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
    String

    WebTemplateConfiguration

    Gets the web template configuration of the site.

    Declaration
    string WebTemplateConfiguration { get; }
    Property Value
    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
    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
    String

    Methods

    AddIndexedProperty(String)

    Adds a web property as an indexed property

    Declaration
    bool AddIndexedProperty(string propertyName)
    Parameters
    String propertyName

    The property name

    Returns
    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<bool> AddIndexedPropertyAsync(string propertyName)
    Parameters
    String propertyName

    The property name

    Returns
    Task<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<ISyntexContentCenter> 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
    String userPrincipalName

    Login name of the user you wish to check if he has a specific permission

    PermissionKind permissionKind

    Permission kind to check

    Returns
    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<bool> CheckIfUserHasPermissionsAsync(string userPrincipalName, PermissionKind permissionKind)
    Parameters
    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<Boolean>

    Boolean that says if the user has permissions or not

    EnsureMultilingual(List<Int32>)

    Ensure a site can support multilingual (pages) for the passed along languages

    Declaration
    void EnsureMultilingual(List<int> requiredLanguageIds)
    Parameters
    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

    EnsureMultilingualAsync(List<Int32>)

    Ensure a site can support multilingual (pages) for the passed along languages

    Declaration
    Task EnsureMultilingualAsync(List<int> requiredLanguageIds)
    Parameters
    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

    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
    String userPrincipalName

    UserPrincipalName value of the user to verify

    Returns
    ISharePointUser

    The ensured ISharePointUser

    EnsureUserAsync(String)

    Ensures the given users exists

    Declaration
    Task<ISharePointUser> EnsureUserAsync(string userPrincipalName)
    Parameters
    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

    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
    String userPrincipalName

    UserPrincipalName value of the user to verify

    Returns
    ISharePointUser

    The ensured ISharePointUser

    EnsureUserBatchAsync(Batch, String)

    Ensures the given users exists

    Declaration
    Task<ISharePointUser> EnsureUserBatchAsync(Batch batch, string userPrincipalName)
    Parameters
    Batch batch

    Batch to add this request to

    String userPrincipalName

    UserPrincipalName value of the user to verify

    Returns
    Task<ISharePointUser>

    The ensured ISharePointUser

    EnsureUserBatchAsync(String)

    Ensures the given users exists

    Declaration
    Task<ISharePointUser> EnsureUserBatchAsync(string userPrincipalName)
    Parameters
    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<ISharePointUser> 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<ISharePointUser> GetCurrentUserBatchAsync()
    Returns
    Task<ISharePointUser>

    The current ISharePointUser

    GetCurrentUserBatchAsync(Batch)

    Get's the current logged on user making the request to SharePoint

    Declaration
    Task<ISharePointUser> GetCurrentUserBatchAsync(Batch batch)
    Parameters
    Batch batch

    Batch to add this request to

    Returns
    Task<ISharePointUser>

    The current ISharePointUser

    GetFileById(Guid, Expression<Func<IFile, Object>>[])

    Get a file in the current web from its unique id.

    Declaration
    IFile GetFileById(Guid uniqueFileId, params Expression<Func<IFile, object>>[] expressions)
    Parameters
    Guid uniqueFileId

    The unique id of the file to get.

    Expression<Func<IFile, Object>>[] expressions

    Properties to load for the requested IFile

    Returns
    IFile

    The file to get

    GetFileByIdAsync(Guid, Expression<Func<IFile, Object>>[])

    Get a file in the current web from its unique id.

    Declaration
    Task<IFile> GetFileByIdAsync(Guid uniqueFileId, params Expression<Func<IFile, object>>[] expressions)
    Parameters
    Guid uniqueFileId

    The unique id of the file to get.

    Expression<Func<IFile, Object>>[] expressions

    Properties to load for the requested IFile

    Returns
    Task<IFile>

    The file to get

    GetFileByIdBatch(Guid, Expression<Func<IFile, Object>>[])

    Get a file in the current web from its unique id via batch.

    Declaration
    IFile GetFileByIdBatch(Guid uniqueFileId, params Expression<Func<IFile, object>>[] expressions)
    Parameters
    Guid uniqueFileId

    The unique id of the file to get.

    Expression<Func<IFile, Object>>[] expressions

    Properties to load for the requested IFile

    Returns
    IFile

    The file to get

    GetFileByIdBatch(Batch, Guid, Expression<Func<IFile, Object>>[])

    Get a file in the current web from its unique id via batch.

    Declaration
    IFile GetFileByIdBatch(Batch batch, Guid uniqueFileId, params Expression<Func<IFile, object>>[] expressions)
    Parameters
    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

    Returns
    IFile

    The file to get

    GetFileByIdBatchAsync(Guid, Expression<Func<IFile, Object>>[])

    Get a file in the current web from its unique id via batch.

    Declaration
    Task<IFile> GetFileByIdBatchAsync(Guid uniqueFileId, params Expression<Func<IFile, object>>[] expressions)
    Parameters
    Guid uniqueFileId

    The unique id of the file to get.

    Expression<Func<IFile, Object>>[] expressions

    Properties to load for the requested IFile

    Returns
    Task<IFile>

    The file to get

    GetFileByIdBatchAsync(Batch, Guid, Expression<Func<IFile, Object>>[])

    Get a file in the current web from its unique id via batch.

    Declaration
    Task<IFile> GetFileByIdBatchAsync(Batch batch, Guid uniqueFileId, params Expression<Func<IFile, object>>[] expressions)
    Parameters
    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

    Returns
    Task<IFile>

    The file to get

    GetFileByLink(String, Expression<Func<IFile, Object>>[])

    Get's a file from a given link (sharing link, path to file)

    Declaration
    IFile GetFileByLink(string link, params Expression<Func<IFile, object>>[] expressions)
    Parameters
    String link

    Link pointing to a file

    Expression<Func<IFile, Object>>[] expressions

    Properties to load for the requested IFile

    Returns
    IFile

    IFile reference when the file could be found, exception otherwise

    GetFileByLinkAsync(String, Expression<Func<IFile, Object>>[])

    Get's a file from a given link (sharing link, path to file)

    Declaration
    Task<IFile> GetFileByLinkAsync(string link, params Expression<Func<IFile, object>>[] expressions)
    Parameters
    String link

    Link pointing to a file

    Expression<Func<IFile, 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<Func<IFile, Object>>[])

    Get a file in the current web from its server relative URL.

    Declaration
    IFile GetFileByServerRelativeUrl(string serverRelativeUrl, params Expression<Func<IFile, object>>[] expressions)
    Parameters
    String serverRelativeUrl

    The server relative URL of the file to get.

    Expression<Func<IFile, Object>>[] expressions

    Properties to load for the requested IFile

    Returns
    IFile

    The file to get

    GetFileByServerRelativeUrlAsync(String, Expression<Func<IFile, Object>>[])

    Get a file in the current web from its server relative URL.

    Declaration
    Task<IFile> GetFileByServerRelativeUrlAsync(string serverRelativeUrl, params Expression<Func<IFile, object>>[] expressions)
    Parameters
    String serverRelativeUrl

    The server relative URL of the file to get.

    Expression<Func<IFile, Object>>[] expressions

    Properties to load for the requested IFile

    Returns
    Task<IFile>

    The file to get

    GetFileByServerRelativeUrlBatch(Batch, String, Expression<Func<IFile, Object>>[])

    Get a file in the current web from its server relative URL via batch.

    Declaration
    IFile GetFileByServerRelativeUrlBatch(Batch batch, string serverRelativeUrl, params Expression<Func<IFile, object>>[] expressions)
    Parameters
    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

    Returns
    IFile

    The file to get

    GetFileByServerRelativeUrlBatch(String, Expression<Func<IFile, Object>>[])

    Get a file in the current web from its server relative URL via batch.

    Declaration
    IFile GetFileByServerRelativeUrlBatch(string serverRelativeUrl, params Expression<Func<IFile, object>>[] expressions)
    Parameters
    String serverRelativeUrl

    The server relative URL of the file to get.

    Expression<Func<IFile, Object>>[] expressions

    Properties to load for the requested IFile

    Returns
    IFile

    The file to get

    GetFileByServerRelativeUrlBatchAsync(Batch, String, Expression<Func<IFile, Object>>[])

    Get a file in the current web from its server relative URL via batch.

    Declaration
    Task<IFile> GetFileByServerRelativeUrlBatchAsync(Batch batch, string serverRelativeUrl, params Expression<Func<IFile, object>>[] expressions)
    Parameters
    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

    Returns
    Task<IFile>

    The file to get

    GetFileByServerRelativeUrlBatchAsync(String, Expression<Func<IFile, Object>>[])

    Get a file in the current web from its server relative URL via batch.

    Declaration
    Task<IFile> GetFileByServerRelativeUrlBatchAsync(string serverRelativeUrl, params Expression<Func<IFile, object>>[] expressions)
    Parameters
    String serverRelativeUrl

    The server relative URL of the file to get.

    Expression<Func<IFile, Object>>[] expressions

    Properties to load for the requested IFile

    Returns
    Task<IFile>

    The file to get

    GetFileByServerRelativeUrlOrDefault(String, Expression<Func<IFile, Object>>[])

    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<Func<IFile, object>>[] expressions)
    Parameters
    String serverRelativeUrl

    The server relative URL of the file to get.

    Expression<Func<IFile, 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<Func<IFile, Object>>[])

    Get a file in the current web from its server relative URL, it not available null will be returned

    Declaration
    Task<IFile> GetFileByServerRelativeUrlOrDefaultAsync(string serverRelativeUrl, params Expression<Func<IFile, object>>[] expressions)
    Parameters
    String serverRelativeUrl

    The server relative URL of the file to get.

    Expression<Func<IFile, 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<Func<IFolder, Object>>[])

    Get a folder in the current web from its id.

    Declaration
    IFolder GetFolderById(Guid folderId, params Expression<Func<IFolder, object>>[] expressions)
    Parameters
    Guid folderId

    The id of the folder to get.

    Expression<Func<IFolder, Object>>[] expressions

    Expressions needed to create the request

    Returns
    IFolder

    The folder to get

    GetFolderByIdAsync(Guid, Expression<Func<IFolder, Object>>[])

    Get a folder in the current web from its id.

    Declaration
    Task<IFolder> GetFolderByIdAsync(Guid folderId, params Expression<Func<IFolder, object>>[] expressions)
    Parameters
    Guid folderId

    The id of the folder to get.

    Expression<Func<IFolder, Object>>[] expressions

    Expressions needed to create the request

    Returns
    Task<IFolder>

    The folder to get

    GetFolderByIdBatch(Guid, Expression<Func<IFolder, Object>>[])

    Get a folder in the current web from its id via batch.

    Declaration
    IFolder GetFolderByIdBatch(Guid folderId, params Expression<Func<IFolder, object>>[] expressions)
    Parameters
    Guid folderId

    The id of the folder to get.

    Expression<Func<IFolder, Object>>[] expressions

    Expressions needed to create the request

    Returns
    IFolder

    The folder to get

    GetFolderByIdBatch(Batch, Guid, Expression<Func<IFolder, Object>>[])

    Get a folder in the current web from its id via batch.

    Declaration
    IFolder GetFolderByIdBatch(Batch batch, Guid folderId, params Expression<Func<IFolder, object>>[] expressions)
    Parameters
    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

    Returns
    IFolder

    The folder to get

    GetFolderByIdBatchAsync(Guid, Expression<Func<IFolder, Object>>[])

    Get a folder in the current web from its id via batch.

    Declaration
    Task<IFolder> GetFolderByIdBatchAsync(Guid folderId, params Expression<Func<IFolder, object>>[] expressions)
    Parameters
    Guid folderId

    The id of the folder to get.

    Expression<Func<IFolder, Object>>[] expressions

    Expressions needed to create the request

    Returns
    Task<IFolder>

    The folder to get

    GetFolderByIdBatchAsync(Batch, Guid, Expression<Func<IFolder, Object>>[])

    Get a folder in the current web from its id via batch.

    Declaration
    Task<IFolder> GetFolderByIdBatchAsync(Batch batch, Guid folderId, params Expression<Func<IFolder, object>>[] expressions)
    Parameters
    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

    Returns
    Task<IFolder>

    The folder to get

    GetFolderByServerRelativeUrl(String, Expression<Func<IFolder, Object>>[])

    Get a folder in the current web from its server relative URL.

    Declaration
    IFolder GetFolderByServerRelativeUrl(string serverRelativeUrl, params Expression<Func<IFolder, object>>[] expressions)
    Parameters
    String serverRelativeUrl

    The server relative URL of the folder to get.

    Expression<Func<IFolder, Object>>[] expressions

    Expressions needed to create the request

    Returns
    IFolder

    The folder to get

    GetFolderByServerRelativeUrlAsync(String, Expression<Func<IFolder, Object>>[])

    Get a folder in the current web from its server relative URL.

    Declaration
    Task<IFolder> GetFolderByServerRelativeUrlAsync(string serverRelativeUrl, params Expression<Func<IFolder, object>>[] expressions)
    Parameters
    String serverRelativeUrl

    The server relative URL of the folder to get.

    Expression<Func<IFolder, Object>>[] expressions

    Expressions needed to create the request

    Returns
    Task<IFolder>

    The folder to get

    GetFolderByServerRelativeUrlBatch(Batch, String, Expression<Func<IFolder, Object>>[])

    Get a folder in the current web from its server relative URL via batch.

    Declaration
    IFolder GetFolderByServerRelativeUrlBatch(Batch batch, string serverRelativeUrl, params Expression<Func<IFolder, object>>[] expressions)
    Parameters
    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

    Returns
    IFolder

    The folder to get

    GetFolderByServerRelativeUrlBatch(String, Expression<Func<IFolder, Object>>[])

    Get a folder in the current web from its server relative URL via batch.

    Declaration
    IFolder GetFolderByServerRelativeUrlBatch(string serverRelativeUrl, params Expression<Func<IFolder, object>>[] expressions)
    Parameters
    String serverRelativeUrl

    The server relative URL of the folder to get.

    Expression<Func<IFolder, Object>>[] expressions

    Expressions needed to create the request

    Returns
    IFolder

    The folder to get

    GetFolderByServerRelativeUrlBatchAsync(Batch, String, Expression<Func<IFolder, Object>>[])

    Get a folder in the current web from its server relative URL via batch.

    Declaration
    Task<IFolder> GetFolderByServerRelativeUrlBatchAsync(Batch batch, string serverRelativeUrl, params Expression<Func<IFolder, object>>[] expressions)
    Parameters
    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

    Returns
    Task<IFolder>

    The folder to get

    GetFolderByServerRelativeUrlBatchAsync(String, Expression<Func<IFolder, Object>>[])

    Get a folder in the current web from its server relative URL via batch.

    Declaration
    Task<IFolder> GetFolderByServerRelativeUrlBatchAsync(string serverRelativeUrl, params Expression<Func<IFolder, object>>[] expressions)
    Parameters
    String serverRelativeUrl

    The server relative URL of the folder to get.

    Expression<Func<IFolder, 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<IPage> GetPages(string pageName = null)
    Parameters
    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<List<IPage>> GetPagesAsync(string pageName = null)
    Parameters
    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<IRecycleBinItemCollection> 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<IRecycleBinItemCollection> 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<IRecycleBinItemCollection> 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<IManagedProperty> 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<List<IManagedProperty>> 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
    String

    Search configuration XML

    GetSearchConfigurationXmlAsync()

    Gets the search configuration of the web

    Declaration
    Task<string> GetSearchConfigurationXmlAsync()
    Returns
    Task<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
    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<ISharePointUser> GetUserByIdAsync(int userId)
    Parameters
    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

    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
    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<ISharePointUser> GetUserByIdBatchAsync(Batch batch, int userId)
    Parameters
    Batch batch

    Batch to add this request to

    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<ISharePointUser> GetUserByIdBatchAsync(int userId)
    Parameters
    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
    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<IBasePermissions> GetUserEffectivePermissionsAsync(string userPrincipalName)
    Parameters
    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<IVivaDashboard> 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
    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.

    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<IWebTemplate> GetWebTemplateByNameAsync(string name, int lcid = 1033, bool includeCrossLanguage = false)
    Parameters
    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.

    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<IWebTemplate> GetWebTemplateByNameBatch(Batch batch, string name, int lcid = 1033, bool includeCrossLanguage = false)
    Parameters
    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.

    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<IWebTemplate> GetWebTemplateByNameBatch(string name, int lcid = 1033, bool includeCrossLanguage = false)
    Parameters
    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.

    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<IBatchSingleResult<IWebTemplate>> GetWebTemplateByNameBatchAsync(Batch batch, string name, int lcid = 1033, bool includeCrossLanguage = false)
    Parameters
    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.

    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<IBatchSingleResult<IWebTemplate>> GetWebTemplateByNameBatchAsync(string name, int lcid = 1033, bool includeCrossLanguage = false)
    Parameters
    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.

    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<IWebTemplate> GetWebTemplates(int lcid = 1033, bool includeCrossLanguage = false)
    Parameters
    Int32 lcid

    Specifies the LCID of the site templates to be retrieved.

    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<List<IWebTemplate>> GetWebTemplatesAsync(int lcid = 1033, bool includeCrossLanguage = false)
    Parameters
    Int32 lcid

    Specifies the LCID of the site templates to be retrieved.

    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<IWebTemplate> GetWebTemplatesBatch(Batch batch, int lcid = 1033, bool includeCrossLanguage = false)
    Parameters
    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.

    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<IWebTemplate> GetWebTemplatesBatch(int lcid = 1033, bool includeCrossLanguage = false)
    Parameters
    Int32 lcid

    Specifies the LCID of the site templates to be retrieved.

    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<IEnumerableBatchResult<IWebTemplate>> GetWebTemplatesBatchAsync(Batch batch, int lcid = 1033, bool includeCrossLanguage = false)
    Parameters
    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.

    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<IEnumerableBatchResult<IWebTemplate>> GetWebTemplatesBatchAsync(int lcid = 1033, bool includeCrossLanguage = false)
    Parameters
    Int32 lcid

    Specifies the LCID of the site templates to be retrieved.

    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
    String termId

    Id of the term to lookup

    Returns
    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<int> GetWssIdForTermAsync(string termId)
    Parameters
    String termId

    Id of the term to lookup

    Returns
    Task<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
    Boolean

    True if enabled, false otherwise

    HasCommunicationSiteFeaturesAsync()

    Does this web have the communication site features enabled?

    Declaration
    Task<bool> HasCommunicationSiteFeaturesAsync()
    Returns
    Task<Boolean>

    True if enabled, false otherwise

    IsNoScriptSite()

    Checks if this web is configured for NoScript

    Declaration
    bool IsNoScriptSite()
    Returns
    Boolean

    True if set to NoScript, false otherwise

    IsNoScriptSiteAsync()

    Checks if this web is configured for NoScript

    Declaration
    Task<bool> IsNoScriptSiteAsync()
    Returns
    Task<Boolean>

    True if set to NoScript, false otherwise

    IsSubSite()

    Checks if this web is a sub site

    Declaration
    bool IsSubSite()
    Returns
    Boolean

    True if the web is a sub site

    IsSubSiteAsync()

    Checks if this web is a sub site

    Declaration
    Task<bool> IsSubSiteAsync()
    Returns
    Task<Boolean>

    True if the web is a sub site

    IsSyntexContentCenter()

    Is this web a Syntex Content Center

    Declaration
    bool IsSyntexContentCenter()
    Returns
    Boolean

    True if this web is a Syntex Content Center, false otherwise

    IsSyntexContentCenterAsync()

    Is this web a Syntex Content Center

    Declaration
    Task<bool> IsSyntexContentCenterAsync()
    Returns
    Task<Boolean>

    True if this web is a Syntex Content Center, false otherwise

    IsSyntexEnabled()

    Is the tenant enabled for SharePoint Syntex

    Declaration
    bool IsSyntexEnabled()
    Returns
    Boolean

    True if SharePoint Syntex is enabled, false otherwise

    IsSyntexEnabledAsync()

    Is the tenant enabled for SharePoint Syntex

    Declaration
    Task<bool> IsSyntexEnabledAsync()
    Returns
    Task<Boolean>

    True if SharePoint Syntex is enabled, false otherwise

    IsSyntexEnabledForCurrentUser()

    Is SharePoint Syntex enabled for the current user

    Declaration
    bool IsSyntexEnabledForCurrentUser()
    Returns
    Boolean

    True if SharePoint Syntex is enabled for the current user, false otherwise

    IsSyntexEnabledForCurrentUserAsync()

    Is SharePoint Syntex enabled for the current user

    Declaration
    Task<bool> IsSyntexEnabledForCurrentUserAsync()
    Returns
    Task<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<IPage> 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
    String propertyName

    The property name

    Returns
    Boolean

    True if it was successfully removed otherwise false

    RemoveIndexedPropertyAsync(String)

    Removes a web propetry from the indexed properties

    Declaration
    Task<bool> RemoveIndexedPropertyAsync(string propertyName)
    Parameters
    String propertyName

    The property name

    Returns
    Task<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<ISearchResult> 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<ISearchResult> 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<ISearchResult> 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<IBatchSingleResult<ISearchResult>> 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<IBatchSingleResult<ISearchResult>> 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

    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

    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
    String configuration

    Search configuration, obtained via GetSearchConfigurationXml() to apply

    SetSearchConfigurationXmlAsync(String)

    Sets the search configuration for the web

    Declaration
    Task SetSearchConfigurationXmlAsync(string configuration)
    Parameters
    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
    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<IUnfurledResource> UnfurlLinkAsync(string link, UnfurlOptions unfurlOptions = null)
    Parameters
    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<String>)

    Checks if the provided list of user UPN's are valid users in Azure AD and returns the 'ensured' SharePoint user

    Declaration
    IList<ISharePointUser> ValidateAndEnsureUsers(IList<string> userList)
    Parameters
    PnP.Core.Model.SharePoint.IList<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<String>)

    Checks if the provided list of user UPN's are valid users in Azure AD and returns the 'ensured' SharePoint user

    Declaration
    Task<IList<ISharePointUser>> ValidateAndEnsureUsersAsync(IList<string> userList)
    Parameters
    PnP.Core.Model.SharePoint.IList<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<String>)

    Checks if the provided list of user UPN's are valid users in Azure AD

    Declaration
    IList<string> ValidateUsers(IList<string> userList)
    Parameters
    PnP.Core.Model.SharePoint.IList<String> userList

    List of user UPN's to validate in Azure AD

    Returns
    PnP.Core.Model.SharePoint.IList<String>

    A list of users that were not found in Azure AD

    ValidateUsersAsync(IList<String>)

    Checks if the provided list of user UPN's are valid users in Azure AD

    Declaration
    Task<IList<string>> ValidateUsersAsync(IList<string> userList)
    Parameters
    PnP.Core.Model.SharePoint.IList<String> userList

    List of user UPN's to validate in Azure AD

    Returns
    Task<PnP.Core.Model.SharePoint.IList<String>>

    A list of users that were not found in Azure AD

    Extension Methods

    DataModelGetExtensions.GetBatchAsync<TModel>(IDataModelGet<TModel>, Expression<Func<TModel, Object>>[])
    DataModelGetExtensions.GetBatchAsync<TModel>(IDataModelGet<TModel>, Batch, Expression<Func<TModel, Object>>[])
    DataModelGetExtensions.GetBatch<TModel>(IDataModelGet<TModel>, Batch, Expression<Func<TModel, Object>>[])
    DataModelGetExtensions.GetBatch<TModel>(IDataModelGet<TModel>, Expression<Func<TModel, Object>>[])
    DataModelGetExtensions.Get<TModel>(IDataModelGet<TModel>, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.LoadBatchAsync<TModel>(IDataModelLoad<TModel>, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.LoadBatchAsync<TModel>(IDataModelLoad<TModel>, Batch, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.LoadBatch<TModel>(IDataModelLoad<TModel>, Batch, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.LoadBatch<TModel>(IDataModelLoad<TModel>, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.Load<TModel>(IDataModelLoad<TModel>, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.QueryProperties<TModel>(IDataModelLoad<TModel>, Expression<Func<TModel, Object>>[])
    RequestModuleExtensions.WithHeaders<TModel>(ISupportModules<TModel>, Dictionary<String, String>, Action<Dictionary<String, String>>)
    Back to top PnP Core SDK
    Generated by DocFX with Material UI
    spacer