Web | gd-sprest

Web

Hierarchy

Index

Properties

Methods

Properties

Optional AccessRequestListUrl

AccessRequestListUrl: string

Optional AccessRequestSiteDescription

AccessRequestSiteDescription: string

Optional AllowAutomaticASPXPageIndexing

AllowAutomaticASPXPageIndexing: boolean

Optional AllowCreateDeclarativeWorkflowForCurrentUser

AllowCreateDeclarativeWorkflowForCurrentUser: boolean

Optional AllowDesignerForCurrentUser

AllowDesignerForCurrentUser: boolean

Optional AllowMasterPageEditingForCurrentUser

AllowMasterPageEditingForCurrentUser: boolean

Optional AllowRevertFromTemplateForCurrentUser

AllowRevertFromTemplateForCurrentUser: boolean

Optional AllowRssFeeds

AllowRssFeeds: boolean

Optional AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser

AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser: boolean

Optional AllowSavePublishDeclarativeWorkflowForCurrentUser

AllowSavePublishDeclarativeWorkflowForCurrentUser: boolean

Optional AlternateCssUrl

AlternateCssUrl: string

Optional AppInstanceId

AppInstanceId: any

Optional ClassicWelcomePage

ClassicWelcomePage: string

Optional CommentsOnSitePagesDisabled

CommentsOnSitePagesDisabled: boolean

Optional Configuration

Configuration: number

Optional ContainsConfidentialInfo

ContainsConfidentialInfo: boolean

Optional Created

Created: any

Optional CurrentChangeToken

CurrentChangeToken: ChangeToken

Optional CustomMasterUrl

CustomMasterUrl: string

Optional CustomSiteActionsDisabled

CustomSiteActionsDisabled: boolean

Optional Description

Description: string

Optional DesignPackageId

DesignPackageId: any

Optional DesignerDownloadUrlForCurrentUser

DesignerDownloadUrlForCurrentUser: string

Optional DisableAppViews

DisableAppViews: boolean

Optional DisableFlows

DisableFlows: boolean

Optional DisableRecommendedItems

DisableRecommendedItems: boolean

Optional DocumentLibraryCalloutOfficeWebAppPreviewersDisabled

DocumentLibraryCalloutOfficeWebAppPreviewersDisabled: boolean

Optional EffectiveBasePermissions

EffectiveBasePermissions: BasePermissions

Optional EnableMinimalDownload

EnableMinimalDownload: boolean

Optional ExcludeFromOfflineClient

ExcludeFromOfflineClient: boolean

Optional FooterEmphasis

FooterEmphasis: number

Optional FooterEnabled

FooterEnabled: boolean

Optional FooterLayout

FooterLayout: number

Optional HasUniqueRoleAssignments

HasUniqueRoleAssignments: boolean

Optional HeaderEmphasis

HeaderEmphasis: number

Optional HeaderLayout

HeaderLayout: number

Optional HorizontalQuickLaunch

HorizontalQuickLaunch: boolean

Optional Id

Id: any

Optional IsHomepageModernized

IsHomepageModernized: boolean

Optional IsMultilingual

IsMultilingual: boolean

Optional IsProvisioningComplete

IsProvisioningComplete: boolean

Optional IsRevertHomepageLinkHidden

IsRevertHomepageLinkHidden: boolean

Optional Language

Language: number

Optional LastItemModifiedDate

LastItemModifiedDate: any

Optional LastItemUserModifiedDate

LastItemUserModifiedDate: any

Optional MasterUrl

MasterUrl: string

Optional MegaMenuEnabled

MegaMenuEnabled: boolean

Optional MembersCanShare

MembersCanShare: boolean

Optional NavAudienceTargetingEnabled

NavAudienceTargetingEnabled: boolean

Optional NoCrawl

NoCrawl: boolean

Optional NotificationsInOneDriveForBusinessEnabled

NotificationsInOneDriveForBusinessEnabled: boolean

Optional NotificationsInSharePointEnabled

NotificationsInSharePointEnabled: boolean

Optional ObjectCacheEnabled

ObjectCacheEnabled: boolean

Optional OverwriteTranslationsOnChange

OverwriteTranslationsOnChange: boolean

Optional PreviewFeaturesEnabled

PreviewFeaturesEnabled: boolean

Optional PrimaryColor

PrimaryColor: string

Optional QuickLaunchEnabled

QuickLaunchEnabled: boolean

Optional RecycleBinEnabled

RecycleBinEnabled: boolean

Optional RequestAccessEmail

RequestAccessEmail: string

Optional ResourcePath

ResourcePath: ResourcePath

Optional SaveSiteAsTemplateEnabled

SaveSiteAsTemplateEnabled: boolean

Optional SearchBoxInNavBar

SearchBoxInNavBar: number

Optional SearchBoxPlaceholderText

SearchBoxPlaceholderText: string

Optional SearchScope

SearchScope: number

Optional ServerRelativePath

ServerRelativePath: ResourcePath

Optional ServerRelativeUrl

ServerRelativeUrl: string

Optional ShowUrlStructureForCurrentUser

ShowUrlStructureForCurrentUser: boolean

Optional SiteLogoDescription

SiteLogoDescription: string

Optional SiteLogoUrl

SiteLogoUrl: string

Optional SupportedUILanguageIds

SupportedUILanguageIds: { results: Array<number> }

Type declaration

results: Array<number>

Optional SyndicationEnabled

SyndicationEnabled: boolean

Optional TenantAdminMembersCanShare

TenantAdminMembersCanShare: number

Optional TenantTagPolicyEnabled

TenantTagPolicyEnabled: boolean

Optional ThemeData

ThemeData: string

Optional ThemedCssFolderUrl

ThemedCssFolderUrl: string

Optional ThirdPartyMdmEnabled

ThirdPartyMdmEnabled: boolean

Optional Title

Title: string

Optional TreeViewEnabled

TreeViewEnabled: boolean

Optional UIVersion

UIVersion: number

Optional UIVersionConfigurationEnabled

UIVersionConfigurationEnabled: boolean

Optional Url

Url: string

Optional UseAccessRequestDefault

UseAccessRequestDefault: boolean

Optional WebTemplate

WebTemplate: string

Optional WelcomePage

WelcomePage: string

existsFl

existsFl: boolean

True, if the object exists, false otherwise.

response

response: string

The response

Methods

Activities

Activities(): IBaseCollection<SPActivityEntity>
Activities(id: string | number): SecurableObjectCollections & IBaseQuery<SPActivityEntity> & SPActivityEntityCollections

Inherited from IWeb.Activities
- Defined in lib/SP/entitytypes.d.ts:3034
Returns IBaseCollection<SPActivityEntity>
Inherited from IWeb.Activities
- Defined in lib/SP/entitytypes.d.ts:3035
Parameters
- id: string | number
Returns SecurableObjectCollections & IBaseQuery<SPActivityEntity> & SPActivityEntityCollections

ActivityLogger

ActivityLogger(): IBaseExecution<ActivityLogger> & ActivityLoggerCollections & ActivityLoggerMethods

Inherited from IWeb.ActivityLogger
- Defined in lib/SP/entitytypes.d.ts:3008
Returns IBaseExecution<ActivityLogger> & ActivityLoggerCollections & ActivityLoggerMethods

Alerts

Alerts(): IBaseCollection<Alert, AlertOData, IBaseExecution & AlertCollectionMethods> & IBaseExecution & AlertCollectionMethods
Alerts(id: string | number): SecurableObjectCollections & IBaseQuery<Alert, AlertOData> & AlertCollections & AlertMethods

Inherited from IWeb.Alerts
- Defined in lib/SP/entitytypes.d.ts:3036
Returns IBaseCollection<Alert, AlertOData, IBaseExecution & AlertCollectionMethods> & IBaseExecution & AlertCollectionMethods
Inherited from IWeb.Alerts
- Defined in lib/SP/entitytypes.d.ts:3037
Parameters
- id: string | number
Returns SecurableObjectCollections & IBaseQuery<Alert, AlertOData> & AlertCollections & AlertMethods

AllProperties

AllProperties(): IBaseExecution<PropertyValues> & PropertyValuesCollections

Inherited from IWeb.AllProperties
- Defined in lib/SP/entitytypes.d.ts:3009
Returns IBaseExecution<PropertyValues> & PropertyValuesCollections

AppTiles

AppTiles(): IBaseCollection<AppTile>
AppTiles(id: string | number): SecurableObjectCollections & IBaseQuery<AppTile> & AppTileCollections

Inherited from IWeb.AppTiles
- Defined in lib/SP/entitytypes.d.ts:3038
Returns IBaseCollection<AppTile>
Inherited from IWeb.AppTiles
- Defined in lib/SP/entitytypes.d.ts:3039
Parameters
- id: string | number
Returns SecurableObjectCollections & IBaseQuery<AppTile> & AppTileCollections

AssociatedMemberGroup

AssociatedMemberGroup(): IBaseQuery<Group, GroupOData> & GroupCollections & GroupMethods

Inherited from IWeb.AssociatedMemberGroup
- Defined in lib/SP/entitytypes.d.ts:3010
Returns IBaseQuery<Group, GroupOData> & GroupCollections & GroupMethods

AssociatedOwnerGroup

AssociatedOwnerGroup(): IBaseQuery<Group, GroupOData> & GroupCollections & GroupMethods

Inherited from IWeb.AssociatedOwnerGroup
- Defined in lib/SP/entitytypes.d.ts:3011
Returns IBaseQuery<Group, GroupOData> & GroupCollections & GroupMethods

AssociatedVisitorGroup

AssociatedVisitorGroup(): IBaseQuery<Group, GroupOData> & GroupCollections & GroupMethods

Inherited from IWeb.AssociatedVisitorGroup
- Defined in lib/SP/entitytypes.d.ts:3012
Returns IBaseQuery<Group, GroupOData> & GroupCollections & GroupMethods

Author

Author(): IBaseQuery<User, UserOData> & UserCollections & UserMethods

Inherited from IWeb.Author
- Defined in lib/SP/entitytypes.d.ts:3013
Returns IBaseQuery<User, UserOData> & UserCollections & UserMethods

AvailableContentTypes

AvailableContentTypes(): IBaseCollection<ContentType, ContentTypeOData, IBaseExecution & ContentTypeCollectionMethods> & IBaseExecution & ContentTypeCollectionMethods
AvailableContentTypes(id: string | number): SecurableObjectCollections & IBaseQuery<ContentType, ContentTypeOData> & ContentTypeCollections & ContentTypeMethods

Inherited from IWeb.AvailableContentTypes
- Defined in lib/SP/entitytypes.d.ts:3040
Returns IBaseCollection<ContentType, ContentTypeOData, IBaseExecution & ContentTypeCollectionMethods> & IBaseExecution & ContentTypeCollectionMethods
Inherited from IWeb.AvailableContentTypes
- Defined in lib/SP/entitytypes.d.ts:3041
Parameters
- id: string | number
Returns SecurableObjectCollections & IBaseQuery<ContentType, ContentTypeOData> & ContentTypeCollections & ContentTypeMethods

AvailableFields

AvailableFields(): IBaseCollection<Field, FieldOData, IBaseExecution & FieldCollectionMethods> & IBaseExecution & FieldCollectionMethods
AvailableFields(id: string | number): SecurableObjectCollections & IBaseQuery<Field, FieldOData> & FieldCollections & FieldMethods

Inherited from IWeb.AvailableFields
- Defined in lib/SP/entitytypes.d.ts:3042
Returns IBaseCollection<Field, FieldOData, IBaseExecution & FieldCollectionMethods> & IBaseExecution & FieldCollectionMethods
Inherited from IWeb.AvailableFields
- Defined in lib/SP/entitytypes.d.ts:3043
Parameters
- id: string | number
Returns SecurableObjectCollections & IBaseQuery<Field, FieldOData> & FieldCollections & FieldMethods

ClientWebParts

ClientWebParts(): IBaseCollection<ClientWebPart> & ClientWebPartCollectionMethods
ClientWebParts(id: string | number): SecurableObjectCollections & IBaseQuery<ClientWebPart> & ClientWebPartCollections & ClientWebPartMethods

Inherited from IWeb.ClientWebParts
- Defined in lib/SP/entitytypes.d.ts:3044
Returns IBaseCollection<ClientWebPart> & ClientWebPartCollectionMethods
Inherited from IWeb.ClientWebParts
- Defined in lib/SP/entitytypes.d.ts:3045
Parameters
- id: string | number
Returns SecurableObjectCollections & IBaseQuery<ClientWebPart> & ClientWebPartCollections & ClientWebPartMethods

ContentTypes

ContentTypes(): IBaseCollection<ContentType, ContentTypeOData, IBaseExecution & ContentTypeCollectionMethods> & IBaseExecution & ContentTypeCollectionMethods
ContentTypes(id: string | number): SecurableObjectCollections & IBaseQuery<ContentType, ContentTypeOData> & ContentTypeCollections & ContentTypeMethods

Inherited from IWeb.ContentTypes
- Defined in lib/SP/entitytypes.d.ts:3046
Returns IBaseCollection<ContentType, ContentTypeOData, IBaseExecution & ContentTypeCollectionMethods> & IBaseExecution & ContentTypeCollectionMethods
Inherited from IWeb.ContentTypes
- Defined in lib/SP/entitytypes.d.ts:3047
Parameters
- id: string | number
Returns SecurableObjectCollections & IBaseQuery<ContentType, ContentTypeOData> & ContentTypeCollections & ContentTypeMethods

CurrentUser

CurrentUser(): IBaseQuery<User, UserOData> & UserCollections & UserMethods

Inherited from IWeb.CurrentUser
- Defined in lib/SP/entitytypes.d.ts:3014
Returns IBaseQuery<User, UserOData> & UserCollections & UserMethods

DataLeakagePreventionStatusInfo

DataLeakagePreventionStatusInfo(): IBaseExecution<SPDataLeakagePreventionStatusInfo> & SPDataLeakagePreventionStatusInfoCollections

Inherited from IWeb.DataLeakagePreventionStatusInfo
- Defined in lib/SP/entitytypes.d.ts:3015
Returns IBaseExecution<SPDataLeakagePreventionStatusInfo> & SPDataLeakagePreventionStatusInfoCollections

DescriptionResource

DescriptionResource(): IBaseExecution<UserResource> & UserResourceCollections & UserResourceMethods

Inherited from IWeb.DescriptionResource
- Defined in lib/SP/entitytypes.d.ts:3016
Returns IBaseExecution<UserResource> & UserResourceCollections & UserResourceMethods

EventReceivers

EventReceivers(): IBaseCollection<EventReceiverDefinition> & EventReceiverDefinitionCollectionMethods
EventReceivers(id: string | number): SecurableObjectCollections & IBaseQuery<EventReceiverDefinition> & EventReceiverDefinitionCollections & EventReceiverDefinitionMethods

Inherited from IWeb.EventReceivers
- Defined in lib/SP/entitytypes.d.ts:3048
Returns IBaseCollection<EventReceiverDefinition> & EventReceiverDefinitionCollectionMethods
Inherited from IWeb.EventReceivers
- Defined in lib/SP/entitytypes.d.ts:3049
Parameters
- id: string | number
Returns SecurableObjectCollections & IBaseQuery<EventReceiverDefinition> & EventReceiverDefinitionCollections & EventReceiverDefinitionMethods

Features

Features(): IBaseCollection<Feature> & FeatureCollectionMethods
Features(id: string | number): SecurableObjectCollections & IBaseQuery<Feature> & FeatureCollections

Inherited from IWeb.Features
- Defined in lib/SP/entitytypes.d.ts:3050
Returns IBaseCollection<Feature> & FeatureCollectionMethods
Inherited from IWeb.Features
- Defined in lib/SP/entitytypes.d.ts:3051
Parameters
- id: string | number
Returns SecurableObjectCollections & IBaseQuery<Feature> & FeatureCollections

Fields

Fields(): IBaseCollection<Field, FieldOData, IBaseExecution & FieldCollectionMethods> & IBaseExecution & FieldCollectionMethods
Fields(id: string | number): SecurableObjectCollections & IBaseQuery<Field, FieldOData> & FieldCollections & FieldMethods

Inherited from IWeb.Fields
- Defined in lib/SP/entitytypes.d.ts:3052
Returns IBaseCollection<Field, FieldOData, IBaseExecution & FieldCollectionMethods> & IBaseExecution & FieldCollectionMethods
Inherited from IWeb.Fields
- Defined in lib/SP/entitytypes.d.ts:3053
Parameters
- id: string | number
Returns SecurableObjectCollections & IBaseQuery<Field, FieldOData> & FieldCollections & FieldMethods

FirstUniqueAncestorSecurableObject

FirstUniqueAncestorSecurableObject(): IBaseQuery<SecurableObject, SecurableObjectOData> & SecurableObjectCollections & SecurableObjectMethods

Inherited from ISecurableObject.FirstUniqueAncestorSecurableObject
- Defined in lib/SP/entitytypes.d.ts:913
Returns IBaseQuery<SecurableObject, SecurableObjectOData> & SecurableObjectCollections & SecurableObjectMethods

Folders

Folders(): IBaseCollection<Folder, FolderOData, IBaseExecution & FolderCollectionMethods> & IBaseExecution & FolderCollectionMethods
Folders(id: string | number): SecurableObjectCollections & IBaseQuery<Folder, FolderOData> & FolderCollections & FolderMethods

Inherited from IWeb.Folders
- Defined in lib/SP/entitytypes.d.ts:3054
Returns IBaseCollection<Folder, FolderOData, IBaseExecution & FolderCollectionMethods> & IBaseExecution & FolderCollectionMethods
Inherited from IWeb.Folders
- Defined in lib/SP/entitytypes.d.ts:3055
Parameters
- id: string | number
Returns SecurableObjectCollections & IBaseQuery<Folder, FolderOData> & FolderCollections & FolderMethods

HostedApps

HostedApps(): IBaseExecution<HostedAppsManager> & HostedAppsManagerCollections & HostedAppsManagerMethods

Inherited from IWeb.HostedApps
- Defined in lib/SP/entitytypes.d.ts:3017
Returns IBaseExecution<HostedAppsManager> & HostedAppsManagerCollections & HostedAppsManagerMethods

ListTemplates

ListTemplates(): IBaseCollection<ListTemplate> & ListTemplateCollectionMethods
ListTemplates(id: string | number): SecurableObjectCollections & IBaseQuery<ListTemplate> & ListTemplateCollections & ListTemplateMethods

Inherited from IWeb.ListTemplates
- Defined in lib/SP/entitytypes.d.ts:3058
Returns IBaseCollection<ListTemplate> & ListTemplateCollectionMethods
Inherited from IWeb.ListTemplates
- Defined in lib/SP/entitytypes.d.ts:3059
Parameters
- id: string | number
Returns SecurableObjectCollections & IBaseQuery<ListTemplate> & ListTemplateCollections & ListTemplateMethods

Lists

Lists(): IBaseCollection<List, ListOData, IBaseExecution & ListCollectionMethods> & IBaseExecution & ListCollectionMethods
Lists(id: string | number): SecurableObjectCollections & IBaseQuery<List, ListOData> & ListCollections & ListMethods

Inherited from IWeb.Lists
- Defined in lib/SP/entitytypes.d.ts:3056
Returns IBaseCollection<List, ListOData, IBaseExecution & ListCollectionMethods> & IBaseExecution & ListCollectionMethods
Inherited from IWeb.Lists
- Defined in lib/SP/entitytypes.d.ts:3057
Parameters
- id: string | number
Returns SecurableObjectCollections & IBaseQuery<List, ListOData> & ListCollections & ListMethods

MultilingualSettings

MultilingualSettings(): IBaseQuery<MultilingualSettings, MultilingualSettingsOData> & MultilingualSettingsCollections & MultilingualSettingsMethods

Inherited from IWeb.MultilingualSettings
- Defined in lib/SP/entitytypes.d.ts:3018
Returns IBaseQuery<MultilingualSettings, MultilingualSettingsOData> & MultilingualSettingsCollections & MultilingualSettingsMethods

Navigation

Navigation(): IBaseQuery<Navigation, NavigationOData> & NavigationCollections & NavigationMethods

Inherited from IWeb.Navigation
- Defined in lib/SP/entitytypes.d.ts:3019
Returns IBaseQuery<Navigation, NavigationOData> & NavigationCollections & NavigationMethods

OneDriveSharedItems

OneDriveSharedItems(): IBaseCollection<SharedDocumentInfo>
OneDriveSharedItems(id: string | number): SecurableObjectCollections & IBaseQuery<SharedDocumentInfo> & SharedDocumentInfoCollections

Inherited from IWeb.OneDriveSharedItems
- Defined in lib/SP/entitytypes.d.ts:3060
Returns IBaseCollection<SharedDocumentInfo>
Inherited from IWeb.OneDriveSharedItems
- Defined in lib/SP/entitytypes.d.ts:3061
Parameters
- id: string | number
Returns SecurableObjectCollections & IBaseQuery<SharedDocumentInfo> & SharedDocumentInfoCollections

ParentWeb

ParentWeb(): IBaseExecution<WebInformation> & WebInformationCollections

Inherited from IWeb.ParentWeb
- Defined in lib/SP/entitytypes.d.ts:3020
Returns IBaseExecution<WebInformation> & WebInformationCollections

PushNotificationSubscribers

PushNotificationSubscribers(): IBaseCollection<PushNotificationSubscriber, PushNotificationSubscriberOData, IBaseExecution & PushNotificationSubscriberCollectionMethods> & IBaseExecution & PushNotificationSubscriberCollectionMethods
PushNotificationSubscribers(id: string | number): SecurableObjectCollections & IBaseQuery<PushNotificationSubscriber, PushNotificationSubscriberOData> & PushNotificationSubscriberCollections & PushNotificationSubscriberMethods

Inherited from IWeb.PushNotificationSubscribers
- Defined in lib/SP/entitytypes.d.ts:3062
Returns IBaseCollection<PushNotificationSubscriber, PushNotificationSubscriberOData, IBaseExecution & PushNotificationSubscriberCollectionMethods> & IBaseExecution & PushNotificationSubscriberCollectionMethods
Inherited from IWeb.PushNotificationSubscribers
- Defined in lib/SP/entitytypes.d.ts:3063
Parameters
- id: string | number
Returns SecurableObjectCollections & IBaseQuery<PushNotificationSubscriber, PushNotificationSubscriberOData> & PushNotificationSubscriberCollections & PushNotificationSubscriberMethods

RecycleBin

RecycleBin(): IBaseCollection<RecycleBinItem, RecycleBinItemOData, IBaseExecution & RecycleBinItemCollectionMethods> & IBaseExecution & RecycleBinItemCollectionMethods
RecycleBin(id: string | number): SecurableObjectCollections & IBaseQuery<RecycleBinItem, RecycleBinItemOData> & RecycleBinItemCollections & RecycleBinItemMethods

Inherited from IWeb.RecycleBin
- Defined in lib/SP/entitytypes.d.ts:3064
Returns IBaseCollection<RecycleBinItem, RecycleBinItemOData, IBaseExecution & RecycleBinItemCollectionMethods> & IBaseExecution & RecycleBinItemCollectionMethods
Inherited from IWeb.RecycleBin
- Defined in lib/SP/entitytypes.d.ts:3065
Parameters
- id: string | number
Returns SecurableObjectCollections & IBaseQuery<RecycleBinItem, RecycleBinItemOData> & RecycleBinItemCollections & RecycleBinItemMethods

RegionalSettings

RegionalSettings(): IBaseQuery<RegionalSettings, RegionalSettingsOData> & RegionalSettingsCollections & RegionalSettingsMethods

Inherited from IWeb.RegionalSettings
- Defined in lib/SP/entitytypes.d.ts:3021
Returns IBaseQuery<RegionalSettings, RegionalSettingsOData> & RegionalSettingsCollections & RegionalSettingsMethods

RoleAssignments

RoleAssignments(): IBaseCollection<RoleAssignment, RoleAssignmentOData, IBaseExecution & RoleAssignmentCollectionMethods> & IBaseExecution & RoleAssignmentCollectionMethods
RoleAssignments(id: string | number): IBaseQuery<RoleAssignment, RoleAssignmentOData> & RoleAssignmentCollections & RoleAssignmentMethods

Inherited from ISecurableObject.RoleAssignments
- Defined in lib/SP/entitytypes.d.ts:920
Returns IBaseCollection<RoleAssignment, RoleAssignmentOData, IBaseExecution & RoleAssignmentCollectionMethods> & IBaseExecution & RoleAssignmentCollectionMethods
Inherited from ISecurableObject.RoleAssignments
- Defined in lib/SP/entitytypes.d.ts:921
Parameters
- id: string | number
Returns IBaseQuery<RoleAssignment, RoleAssignmentOData> & RoleAssignmentCollections & RoleAssignmentMethods

RoleDefinitions

RoleDefinitions(): IBaseCollection<RoleDefinition> & RoleDefinitionCollectionMethods
RoleDefinitions(id: string | number): SecurableObjectCollections & IBaseQuery<RoleDefinition> & RoleDefinitionCollections & RoleDefinitionMethods

Inherited from IWeb.RoleDefinitions
- Defined in lib/SP/entitytypes.d.ts:3066
Returns IBaseCollection<RoleDefinition> & RoleDefinitionCollectionMethods
Inherited from IWeb.RoleDefinitions
- Defined in lib/SP/entitytypes.d.ts:3067
Parameters
- id: string | number
Returns SecurableObjectCollections & IBaseQuery<RoleDefinition> & RoleDefinitionCollections & RoleDefinitionMethods

RootFolder

RootFolder(): IBaseQuery<Folder, FolderOData> & FolderCollections & FolderMethods

Inherited from IWeb.RootFolder
- Defined in lib/SP/entitytypes.d.ts:3022
Returns IBaseQuery<Folder, FolderOData> & FolderCollections & FolderMethods

SiteCollectionAppCatalog

SiteCollectionAppCatalog(): IBaseQuery<SiteCollectionCorporateCatalogAccessor, SiteCollectionCorporateCatalogAccessorOData> & SiteCollectionCorporateCatalogAccessorCollections & SiteCollectionCorporateCatalogAccessorMethods

Inherited from IWeb.SiteCollectionAppCatalog
- Defined in lib/SP/entitytypes.d.ts:3023
Returns IBaseQuery<SiteCollectionCorporateCatalogAccessor, SiteCollectionCorporateCatalogAccessorOData> & SiteCollectionCorporateCatalogAccessorCollections & SiteCollectionCorporateCatalogAccessorMethods

SiteGroups

SiteGroups(): IBaseCollection<Group, GroupOData, IBaseExecution & GroupCollectionMethods> & IBaseExecution & GroupCollectionMethods
SiteGroups(id: string | number): SecurableObjectCollections & IBaseQuery<Group, GroupOData> & GroupCollections & GroupMethods

Inherited from IWeb.SiteGroups
- Defined in lib/SP/entitytypes.d.ts:3068
Returns IBaseCollection<Group, GroupOData, IBaseExecution & GroupCollectionMethods> & IBaseExecution & GroupCollectionMethods
Inherited from IWeb.SiteGroups
- Defined in lib/SP/entitytypes.d.ts:3069
Parameters
- id: string | number
Returns SecurableObjectCollections & IBaseQuery<Group, GroupOData> & GroupCollections & GroupMethods

SiteUserInfoList

SiteUserInfoList(): IBaseQuery<List, ListOData> & ListCollections & ListMethods

Inherited from IWeb.SiteUserInfoList
- Defined in lib/SP/entitytypes.d.ts:3024
Returns IBaseQuery<List, ListOData> & ListCollections & ListMethods

SiteUsers

SiteUsers(): IBaseCollection<User, UserOData, IBaseExecution & UserCollectionMethods> & IBaseExecution & UserCollectionMethods
SiteUsers(id: string | number): SecurableObjectCollections & IBaseQuery<User, UserOData> & UserCollections & UserMethods

Inherited from IWeb.SiteUsers
- Defined in lib/SP/entitytypes.d.ts:3070
Returns IBaseCollection<User, UserOData, IBaseExecution & UserCollectionMethods> & IBaseExecution & UserCollectionMethods
Inherited from IWeb.SiteUsers
- Defined in lib/SP/entitytypes.d.ts:3071
Parameters
- id: string | number
Returns SecurableObjectCollections & IBaseQuery<User, UserOData> & UserCollections & UserMethods

TenantAppCatalog

TenantAppCatalog(): IBaseQuery<TenantCorporateCatalogAccessor, TenantCorporateCatalogAccessorOData> & TenantCorporateCatalogAccessorCollections & TenantCorporateCatalogAccessorMethods

Inherited from IWeb.TenantAppCatalog
- Defined in lib/SP/entitytypes.d.ts:3025
Returns IBaseQuery<TenantCorporateCatalogAccessor, TenantCorporateCatalogAccessorOData> & TenantCorporateCatalogAccessorCollections & TenantCorporateCatalogAccessorMethods

ThemeInfo

ThemeInfo(): IBaseExecution<ThemeInfo> & ThemeInfoCollections & ThemeInfoMethods

Inherited from IWeb.ThemeInfo
- Defined in lib/SP/entitytypes.d.ts:3026
Returns IBaseExecution<ThemeInfo> & ThemeInfoCollections & ThemeInfoMethods

TitleResource

TitleResource(): IBaseExecution<UserResource> & UserResourceCollections & UserResourceMethods

Inherited from IWeb.TitleResource
- Defined in lib/SP/entitytypes.d.ts:3027
Returns IBaseExecution<UserResource> & UserResourceCollections & UserResourceMethods

UserCustomActions

UserCustomActions(): IBaseCollection<UserCustomAction, UserCustomActionOData, IBaseExecution & UserCustomActionCollectionMethods> & IBaseExecution & UserCustomActionCollectionMethods
UserCustomActions(id: string | number): SecurableObjectCollections & IBaseQuery<UserCustomAction, UserCustomActionOData> & UserCustomActionCollections & UserCustomActionMethods

Inherited from IWeb.UserCustomActions
- Defined in lib/SP/entitytypes.d.ts:3072
Returns IBaseCollection<UserCustomAction, UserCustomActionOData, IBaseExecution & UserCustomActionCollectionMethods> & IBaseExecution & UserCustomActionCollectionMethods
Inherited from IWeb.UserCustomActions
- Defined in lib/SP/entitytypes.d.ts:3073
Parameters
- id: string | number
Returns SecurableObjectCollections & IBaseQuery<UserCustomAction, UserCustomActionOData> & UserCustomActionCollections & UserCustomActionMethods

WebInfos

WebInfos(): IBaseCollection<WebInformation> & WebInformationCollectionMethods
WebInfos(id: string | number): SecurableObjectCollections & IBaseQuery<WebInformation> & WebInformationCollections

Inherited from IWeb.WebInfos
- Defined in lib/SP/entitytypes.d.ts:3076
Returns IBaseCollection<WebInformation> & WebInformationCollectionMethods
Inherited from IWeb.WebInfos
- Defined in lib/SP/entitytypes.d.ts:3077
Parameters
- id: string | number
Returns SecurableObjectCollections & IBaseQuery<WebInformation> & WebInformationCollections

Webs

Webs(): IBaseCollection<Web, WebOData, IBaseExecution & WebCollectionMethods> & IBaseExecution & WebCollectionMethods
Webs(id: string | number): SecurableObjectCollections & IBaseQuery<Web, WebOData> & WebCollections & WebMethods

Inherited from IWeb.Webs
- Defined in lib/SP/entitytypes.d.ts:3074
Returns IBaseCollection<Web, WebOData, IBaseExecution & WebCollectionMethods> & IBaseExecution & WebCollectionMethods
Inherited from IWeb.Webs
- Defined in lib/SP/entitytypes.d.ts:3075
Parameters
- id: string | number
Returns SecurableObjectCollections & IBaseQuery<Web, WebOData> & WebCollections & WebMethods

WorkflowAssociations

WorkflowAssociations(): IBaseCollection<WorkflowAssociation> & WorkflowAssociationCollectionMethods
WorkflowAssociations(id: string | number): SecurableObjectCollections & IBaseQuery<WorkflowAssociation> & WorkflowAssociationCollections & WorkflowAssociationMethods

Inherited from IWeb.WorkflowAssociations
- Defined in lib/SP/entitytypes.d.ts:3078
Returns IBaseCollection<WorkflowAssociation> & WorkflowAssociationCollectionMethods
Inherited from IWeb.WorkflowAssociations
- Defined in lib/SP/entitytypes.d.ts:3079
Parameters
- id: string | number
Returns SecurableObjectCollections & IBaseQuery<WorkflowAssociation> & WorkflowAssociationCollections & WorkflowAssociationMethods

WorkflowTemplates

WorkflowTemplates(): IBaseCollection<WorkflowTemplate> & WorkflowTemplateCollectionMethods
WorkflowTemplates(id: string | number): SecurableObjectCollections & IBaseQuery<WorkflowTemplate> & WorkflowTemplateCollections

Inherited from IWeb.WorkflowTemplates
- Defined in lib/SP/entitytypes.d.ts:3080
Returns IBaseCollection<WorkflowTemplate> & WorkflowTemplateCollectionMethods
Inherited from IWeb.WorkflowTemplates
- Defined in lib/SP/entitytypes.d.ts:3081
Parameters
- id: string | number
Returns SecurableObjectCollections & IBaseQuery<WorkflowTemplate> & WorkflowTemplateCollections

addCrossFarmMessage

addCrossFarmMessage(messagePayloadBase64?: string): IBaseExecution<boolean>

Inherited from IWeb.addCrossFarmMessage
- Defined in lib/SP/entitytypes.d.ts:3147
Parameters
- Optional messagePayloadBase64: string
Returns IBaseExecution<boolean>

addSupportedUILanguage

addSupportedUILanguage(lcid?: number): IBaseExecution<any>

Inherited from IWeb.addSupportedUILanguage
- Defined in lib/SP/entitytypes.d.ts:3148
Parameters
- Optional lcid: number
Returns IBaseExecution<any>

applyTheme

applyTheme(colorPaletteUrl?: string, fontSchemeUrl?: string, backgroundImageUrl?: string, shareGenerated?: boolean): IBaseExecution<any>

Inherited from IWeb.applyTheme
- Defined in lib/SP/entitytypes.d.ts:3149
Parameters
- Optional colorPaletteUrl: string
- Optional fontSchemeUrl: string
- Optional backgroundImageUrl: string
- Optional shareGenerated: boolean
Returns IBaseExecution<any>

applyWebTemplate

applyWebTemplate(webTemplate?: string): IBaseExecution<any>

Inherited from IWeb.applyWebTemplate
- Defined in lib/SP/entitytypes.d.ts:3150
Parameters
- Optional webTemplate: string
Returns IBaseExecution<any>

breakRoleInheritance

breakRoleInheritance(copyRoleAssignments?: boolean, clearSubscopes?: boolean): IBaseExecution<any>

Inherited from ISecurableObject.breakRoleInheritance

Overrides IWeb.breakRoleInheritance
- Defined in lib/SP/entitytypes.d.ts:936
Parameters
- Optional copyRoleAssignments: boolean
- Optional clearSubscopes: boolean
Returns IBaseExecution<any>

createDefaultAssociatedGroups

createDefaultAssociatedGroups(userLogin?: string, userLogin2?: string, groupNameSeed?: string): IBaseExecution<any>

Inherited from IWeb.createDefaultAssociatedGroups
- Defined in lib/SP/entitytypes.d.ts:3151
Parameters
- Optional userLogin: string
- Optional userLogin2: string
- Optional groupNameSeed: string
Returns IBaseExecution<any>

defaultDocumentLibrary

defaultDocumentLibrary(): IBaseQuery<List, ListOData> & ListCollections & ListMethods

Inherited from IWeb.defaultDocumentLibrary
- Defined in lib/SP/entitytypes.d.ts:3152
Returns IBaseQuery<List, ListOData> & ListCollections & ListMethods

delete

delete(): IBaseExecution<any>

Inherited from IWeb.delete
- Defined in lib/SP/entitytypes.d.ts:3153
Returns IBaseExecution<any>

doesPushNotificationSubscriberExist

doesPushNotificationSubscriberExist(deviceAppInstanceId?: any): IBaseExecution<boolean>

Inherited from IWeb.doesPushNotificationSubscriberExist
- Defined in lib/SP/entitytypes.d.ts:3154
Parameters
- Optional deviceAppInstanceId: any
Returns IBaseExecution<boolean>

doesUserHavePermissions

doesUserHavePermissions(high?: number, low?: number): IBaseExecution<boolean>

Inherited from IWeb.doesUserHavePermissions
- Defined in lib/SP/entitytypes.d.ts:3228
Parameters
- Optional high: number
- Optional low: number
Returns IBaseExecution<boolean>

ensureUser

ensureUser(logonName?: string): IBaseQuery<User, UserOData> & UserCollections & UserMethods

Inherited from IWeb.ensureUser
- Defined in lib/SP/entitytypes.d.ts:3156
Parameters
- Optional logonName: string
Returns IBaseQuery<User, UserOData> & UserCollections & UserMethods

executeRemoteLOB

executeRemoteLOB(inputStream?: any): IBaseExecution<any>

Inherited from IWeb.executeRemoteLOB
- Defined in lib/SP/entitytypes.d.ts:3157
Parameters
- Optional inputStream: any
Returns IBaseExecution<any>

getAllClientSideComponents

getAllClientSideComponents(): IBaseExecution<string>

Inherited from IWeb.getAllClientSideComponents
- Defined in lib/SP/entitytypes.d.ts:3158
Returns IBaseExecution<string>

getAppBdcCatalog

getAppBdcCatalog(): IBaseExecution<AppBdcCatalog>

Inherited from IWeb.getAppBdcCatalog
- Defined in lib/SP/entitytypes.d.ts:3159
Returns IBaseExecution<AppBdcCatalog>

getAppBdcCatalogForAppInstance

getAppBdcCatalogForAppInstance(appInstanceId?: any): IBaseExecution<AppBdcCatalog>

Inherited from IWeb.getAppBdcCatalogForAppInstance
- Defined in lib/SP/entitytypes.d.ts:3160
Parameters
- Optional appInstanceId: any
Returns IBaseExecution<AppBdcCatalog>

getAppInstanceById

getAppInstanceById(appInstanceId?: any): IBaseExecution<AppInstance>

Inherited from IWeb.getAppInstanceById
- Defined in lib/SP/entitytypes.d.ts:3161
Parameters
- Optional appInstanceId: any
Returns IBaseExecution<AppInstance>

getAppInstancesByProductId

getAppInstancesByProductId(productId?: any): IBaseCollection<AppInstance>

Inherited from IWeb.getAppInstancesByProductId
- Defined in lib/SP/entitytypes.d.ts:3162
Parameters
- Optional productId: any
Returns IBaseCollection<AppInstance>

getAvailableWebTemplates

getAvailableWebTemplates(lcid?: number, doIncludeCrossLanguage?: boolean): IBaseCollection<WebTemplate> & WebTemplateCollectionMethods

Inherited from IWeb.getAvailableWebTemplates
- Defined in lib/SP/entitytypes.d.ts:3163
Parameters
- Optional lcid: number
- Optional doIncludeCrossLanguage: boolean
Returns IBaseCollection<WebTemplate> & WebTemplateCollectionMethods

getCatalog

getCatalog(typeCatalog?: number): IBaseQuery<List, ListOData> & ListCollections & ListMethods

Inherited from IWeb.getCatalog
- Defined in lib/SP/entitytypes.d.ts:3164
Parameters
- Optional typeCatalog: number
Returns IBaseQuery<List, ListOData> & ListCollections & ListMethods

getChanges

getChanges(query?: ChangeQuery): IBaseCollection<Change>

Inherited from IWeb.getChanges
- Defined in lib/SP/entitytypes.d.ts:3165
Parameters
- Optional query: ChangeQuery
Returns IBaseCollection<Change>

getClientSideComponents

getClientSideComponents(components?: Array<SPClientSideComponentIdentifier>): IBaseCollection<SPClientSideComponentQueryResult>

Inherited from IWeb.getClientSideComponents
- Defined in lib/SP/entitytypes.d.ts:3166
Parameters
- Optional components: Array<SPClientSideComponentIdentifier>
Returns IBaseCollection<SPClientSideComponentQueryResult>

getClientSideComponentsById

getClientSideComponentsById(componentIds?: Array<any>): IBaseCollection<SPClientSideComponentQueryResult>

Inherited from IWeb.getClientSideComponentsById
- Defined in lib/SP/entitytypes.d.ts:3167
Parameters
- Optional componentIds: Array<any>
Returns IBaseCollection<SPClientSideComponentQueryResult>

getClientSideWebParts

getClientSideWebParts(includeErrors?: boolean): IBaseCollection<SPClientSideComponentQueryResult>

Inherited from IWeb.getClientSideWebParts
- Defined in lib/SP/entitytypes.d.ts:3168
Parameters
- Optional includeErrors: boolean
Returns IBaseCollection<SPClientSideComponentQueryResult>

getCustomListTemplates

getCustomListTemplates(): IBaseCollection<ListTemplate> & ListTemplateCollectionMethods

Inherited from IWeb.getCustomListTemplates
- Defined in lib/SP/entitytypes.d.ts:3169
Returns IBaseCollection<ListTemplate> & ListTemplateCollectionMethods

getEntity

getEntity(namespace?: string, name?: string): IBaseExecution<Entity>

Inherited from IWeb.getEntity
- Defined in lib/SP/entitytypes.d.ts:3170
Parameters
- Optional namespace: string
- Optional name: string
Returns IBaseExecution<Entity>

getFileByGuestUrl

getFileByGuestUrl(guestUrl?: string): IBaseQuery<File, FileOData> & FileCollections & FileMethods

Inherited from IWeb.getFileByGuestUrl
- Defined in lib/SP/entitytypes.d.ts:3171
Parameters
- Optional guestUrl: string
Returns IBaseQuery<File, FileOData> & FileCollections & FileMethods

getFileByGuestUrlEnsureAccess

getFileByGuestUrlEnsureAccess(guestUrl?: string, ensureAccess?: boolean): IBaseQuery<File, FileOData> & FileCollections & FileMethods

Inherited from IWeb.getFileByGuestUrlEnsureAccess
- Defined in lib/SP/entitytypes.d.ts:3172
Parameters
- Optional guestUrl: string
- Optional ensureAccess: boolean
Returns IBaseQuery<File, FileOData> & FileCollections & FileMethods

getFileByGuestUrlExtended

getFileByGuestUrlExtended(guestUrl?: string, requestSettings?: SharingLinkAccessRequest): IBaseQuery<File, FileOData> & FileCollections & FileMethods

Inherited from IWeb.getFileByGuestUrlExtended
- Defined in lib/SP/entitytypes.d.ts:3173
Parameters
- Optional guestUrl: string
- Optional requestSettings: SharingLinkAccessRequest
Returns IBaseQuery<File, FileOData> & FileCollections & FileMethods

getFileById

getFileById(uniqueId?: any): IBaseQuery<File, FileOData> & FileCollections & FileMethods

Inherited from IWeb.getFileById
- Defined in lib/SP/entitytypes.d.ts:3174
Parameters
- Optional uniqueId: any
Returns IBaseQuery<File, FileOData> & FileCollections & FileMethods

getFileByLinkingUrl

getFileByLinkingUrl(linkingUrl?: string): IBaseQuery<File, FileOData> & FileCollections & FileMethods

Inherited from IWeb.getFileByLinkingUrl
- Defined in lib/SP/entitytypes.d.ts:3175
Parameters
- Optional linkingUrl: string
Returns IBaseQuery<File, FileOData> & FileCollections & FileMethods

getFileByServerRelativePath

getFileByServerRelativePath(DecodedUrl?: string): IBaseQuery<File, FileOData> & FileCollections & FileMethods

Inherited from IWeb.getFileByServerRelativePath
- Defined in lib/SP/entitytypes.d.ts:3176
Parameters
- Optional DecodedUrl: string
Returns IBaseQuery<File, FileOData> & FileCollections & FileMethods

getFileByServerRelativeUrl

getFileByServerRelativeUrl(serverRelativeUrl?: string): IBaseQuery<File, FileOData> & FileCollections & FileMethods

Inherited from IWeb.getFileByServerRelativeUrl
- Defined in lib/SP/entitytypes.d.ts:3177
Parameters
- Optional serverRelativeUrl: string
Returns IBaseQuery<File, FileOData> & FileCollections & FileMethods

getFileByUrl

getFileByUrl(fileUrl?: string): IBaseQuery<File, FileOData> & FileCollections & FileMethods

Inherited from IWeb.getFileByUrl
- Defined in lib/SP/entitytypes.d.ts:3178
Parameters
- Optional fileUrl: string
Returns IBaseQuery<File, FileOData> & FileCollections & FileMethods

getFileByWOPIFrameUrl

getFileByWOPIFrameUrl(wopiFrameUrl?: string): IBaseQuery<File, FileOData> & FileCollections & FileMethods

Inherited from IWeb.getFileByWOPIFrameUrl
- Defined in lib/SP/entitytypes.d.ts:3179
Parameters
- Optional wopiFrameUrl: string
Returns IBaseQuery<File, FileOData> & FileCollections & FileMethods

getFolderByGuestUrl

getFolderByGuestUrl(guestUrl?: string, ensureAccess?: boolean): IBaseQuery<Folder, FolderOData> & FolderCollections & FolderMethods

Inherited from IWeb.getFolderByGuestUrl
- Defined in lib/SP/entitytypes.d.ts:3180
Parameters
- Optional guestUrl: string
- Optional ensureAccess: boolean
Returns IBaseQuery<Folder, FolderOData> & FolderCollections & FolderMethods

getFolderByGuestUrlExtended

getFolderByGuestUrlExtended(guestUrl?: string, requestSettings?: SharingLinkAccessRequest): IBaseQuery<Folder, FolderOData> & FolderCollections & FolderMethods

Inherited from IWeb.getFolderByGuestUrlExtended
- Defined in lib/SP/entitytypes.d.ts:3181
Parameters
- Optional guestUrl: string
- Optional requestSettings: SharingLinkAccessRequest
Returns IBaseQuery<Folder, FolderOData> & FolderCollections & FolderMethods

getFolderById

getFolderById(uniqueId?: any): IBaseQuery<Folder, FolderOData> & FolderCollections & FolderMethods

Inherited from IWeb.getFolderById
- Defined in lib/SP/entitytypes.d.ts:3182
Parameters
- Optional uniqueId: any
Returns IBaseQuery<Folder, FolderOData> & FolderCollections & FolderMethods

getFolderByServerRelativePath

getFolderByServerRelativePath(DecodedUrl?: string): IBaseQuery<Folder, FolderOData> & FolderCollections & FolderMethods

Inherited from IWeb.getFolderByServerRelativePath
- Defined in lib/SP/entitytypes.d.ts:3183
Parameters
- Optional DecodedUrl: string
Returns IBaseQuery<Folder, FolderOData> & FolderCollections & FolderMethods

getFolderByServerRelativeUrl

getFolderByServerRelativeUrl(serverRelativeUrl?: string): IBaseQuery<Folder, FolderOData> & FolderCollections & FolderMethods

Inherited from IWeb.getFolderByServerRelativeUrl
- Defined in lib/SP/entitytypes.d.ts:3184
Parameters
- Optional serverRelativeUrl: string
Returns IBaseQuery<Folder, FolderOData> & FolderCollections & FolderMethods

getList

getList(strUrl?: string): IBaseQuery<List, ListOData> & ListCollections & ListMethods

Inherited from IWeb.getList
- Defined in lib/SP/entitytypes.d.ts:3185
Parameters
- Optional strUrl: string
Returns IBaseQuery<List, ListOData> & ListCollections & ListMethods

getListItem

getListItem(strUrl?: string): IBaseQuery<ListItem, ListItemOData> & ListItemCollections & ListItemMethods

Inherited from IWeb.getListItem
- Defined in lib/SP/entitytypes.d.ts:3186
Parameters
- Optional strUrl: string
Returns IBaseQuery<ListItem, ListItemOData> & ListItemCollections & ListItemMethods

getListItemByResourceId

getListItemByResourceId(resourceId?: string): IBaseQuery<ListItem, ListItemOData> & ListItemCollections & ListItemMethods

Inherited from IWeb.getListItemByResourceId
- Defined in lib/SP/entitytypes.d.ts:3187
Parameters
- Optional resourceId: string
Returns IBaseQuery<ListItem, ListItemOData> & ListItemCollections & ListItemMethods

getListItemUsingPath

getListItemUsingPath(DecodedUrl?: string): IBaseQuery<ListItem, ListItemOData> & ListItemCollections & ListItemMethods

Inherited from IWeb.getListItemUsingPath
- Defined in lib/SP/entitytypes.d.ts:3188
Parameters
- Optional DecodedUrl: string
Returns IBaseQuery<ListItem, ListItemOData> & ListItemCollections & ListItemMethods

getListUsingPath

getListUsingPath(DecodedUrl?: string): IBaseQuery<List, ListOData> & ListCollections & ListMethods

Inherited from IWeb.getListUsingPath
- Defined in lib/SP/entitytypes.d.ts:3189
Parameters
- Optional DecodedUrl: string
Returns IBaseQuery<List, ListOData> & ListCollections & ListMethods

getNewsList

getNewsList(allowCreate?: boolean): IBaseQuery<List, ListOData> & ListCollections & ListMethods

Inherited from IWeb.getNewsList
- Defined in lib/SP/entitytypes.d.ts:3190
Parameters
- Optional allowCreate: boolean
Returns IBaseQuery<List, ListOData> & ListCollections & ListMethods

getRecycleBinItems

getRecycleBinItems(pagingInfo?: string, rowLimit?: number, isAscending?: boolean, orderBy?: number, itemState?: number): IBaseCollection<RecycleBinItem, RecycleBinItemOData, IBaseExecution & RecycleBinItemCollectionMethods> & IBaseExecution & RecycleBinItemCollectionMethods

Inherited from IWeb.getRecycleBinItems
- Defined in lib/SP/entitytypes.d.ts:3194
Parameters
- Optional pagingInfo: string
- Optional rowLimit: number
- Optional isAscending: boolean
- Optional orderBy: number
- Optional itemState: number
Returns IBaseCollection<RecycleBinItem, RecycleBinItemOData, IBaseExecution & RecycleBinItemCollectionMethods> & IBaseExecution & RecycleBinItemCollectionMethods

getRecycleBinItemsByQueryInfo

getRecycleBinItemsByQueryInfo(IsAscending?: boolean, ItemState?: number, OrderBy?: number, PagingInfo?: string, RowLimit?: number, ShowOnlyMyItems?: boolean): IBaseCollection<RecycleBinItem, RecycleBinItemOData, IBaseExecution & RecycleBinItemCollectionMethods> & IBaseExecution & RecycleBinItemCollectionMethods

Inherited from IWeb.getRecycleBinItemsByQueryInfo
- Defined in lib/SP/entitytypes.d.ts:3195
Parameters
- Optional IsAscending: boolean
- Optional ItemState: number
- Optional OrderBy: number
- Optional PagingInfo: string
- Optional RowLimit: number
- Optional ShowOnlyMyItems: boolean
Returns IBaseCollection<RecycleBinItem, RecycleBinItemOData, IBaseExecution & RecycleBinItemCollectionMethods> & IBaseExecution & RecycleBinItemCollectionMethods

getRegionalDateTimeSchema

getRegionalDateTimeSchema(): IBaseExecution<string>

Inherited from IWeb.getRegionalDateTimeSchema
- Defined in lib/SP/entitytypes.d.ts:3196
Returns IBaseExecution<string>

getSPAppContextAsStream

getSPAppContextAsStream(): IBaseExecution<any>

Inherited from IWeb.getSPAppContextAsStream
- Defined in lib/SP/entitytypes.d.ts:3198
Returns IBaseExecution<any>

getSharingLinkData

getSharingLinkData(linkUrl?: string): IBaseExecution<SharingLinkData>

Inherited from IWeb.getSharingLinkData
- Defined in lib/SP/entitytypes.d.ts:3197
Parameters
- Optional linkUrl: string
Returns IBaseExecution<SharingLinkData>

getStorageEntity

getStorageEntity(key?: string): IBaseExecution<StorageEntity>

Inherited from IWeb.getStorageEntity
- Defined in lib/SP/entitytypes.d.ts:3199
Parameters
- Optional key: string
Returns IBaseExecution<StorageEntity>

getSubwebsFilteredForCurrentUser

getSubwebsFilteredForCurrentUser(nWebTemplateFilter?: number, nConfigurationFilter?: number): IBaseCollection<WebInformation> & WebInformationCollectionMethods

Inherited from IWeb.getSubwebsFilteredForCurrentUser
- Defined in lib/SP/entitytypes.d.ts:3200
Parameters
- Optional nWebTemplateFilter: number
- Optional nConfigurationFilter: number
Returns IBaseCollection<WebInformation> & WebInformationCollectionMethods

getUserById

getUserById(userId?: number): IBaseQuery<User, UserOData> & UserCollections & UserMethods

Inherited from IWeb.getUserById
- Defined in lib/SP/entitytypes.d.ts:3201
Parameters
- Optional userId: number
Returns IBaseQuery<User, UserOData> & UserCollections & UserMethods

getUserEffectivePermissions

getUserEffectivePermissions(userName?: string): IBaseExecution<BasePermissions>

Inherited from IWeb.getUserEffectivePermissions
- Defined in lib/SP/entitytypes.d.ts:3202
Parameters
- Optional userName: string
Returns IBaseExecution<BasePermissions>

getViewFromPath

getViewFromPath(DecodedUrl?: string): IBaseQuery<View, ViewOData> & ViewCollections & ViewMethods

Inherited from IWeb.getViewFromPath
- Defined in lib/SP/entitytypes.d.ts:3203
Parameters
- Optional DecodedUrl: string
Returns IBaseQuery<View, ViewOData> & ViewCollections & ViewMethods

getViewFromUrl

getViewFromUrl(listUrl?: string): IBaseQuery<View, ViewOData> & ViewCollections & ViewMethods

Inherited from IWeb.getViewFromUrl
- Defined in lib/SP/entitytypes.d.ts:3204
Parameters
- Optional listUrl: string
Returns IBaseQuery<View, ViewOData> & ViewCollections & ViewMethods

hubSiteData

hubSiteData(forceRefresh?: boolean): IBaseExecution<string>

Inherited from IWeb.hubSiteData
- Defined in lib/SP/entitytypes.d.ts:3205
Parameters
- Optional forceRefresh: boolean
Returns IBaseExecution<string>

hubSiteDataAsStream

hubSiteDataAsStream(forceRefresh?: boolean): IBaseExecution<any>

Inherited from IWeb.hubSiteDataAsStream
- Defined in lib/SP/entitytypes.d.ts:3206
Parameters
- Optional forceRefresh: boolean
Returns IBaseExecution<any>

incrementSiteClientTag

incrementSiteClientTag(): IBaseExecution<any>

Inherited from IWeb.incrementSiteClientTag
- Defined in lib/SP/entitytypes.d.ts:3207
Returns IBaseExecution<any>

loadAndInstallApp

loadAndInstallApp(appPackageStream?: any): IBaseExecution<AppInstance>

Inherited from IWeb.loadAndInstallApp
- Defined in lib/SP/entitytypes.d.ts:3208
Parameters
- Optional appPackageStream: any
Returns IBaseExecution<AppInstance>

loadAndInstallAppInSpecifiedLocale

loadAndInstallAppInSpecifiedLocale(appPackageStream?: any, installationLocaleLCID?: number): IBaseExecution<AppInstance>

Inherited from IWeb.loadAndInstallAppInSpecifiedLocale
- Defined in lib/SP/entitytypes.d.ts:3209
Parameters
- Optional appPackageStream: any
- Optional installationLocaleLCID: number
Returns IBaseExecution<AppInstance>

loadApp

loadApp(appPackageStream?: any, installationLocaleLCID?: number): IBaseExecution<AppInstance>

Inherited from IWeb.loadApp
- Defined in lib/SP/entitytypes.d.ts:3210
Parameters
- Optional appPackageStream: any
- Optional installationLocaleLCID: number
Returns IBaseExecution<AppInstance>

mapToIcon

mapToIcon(fileName?: string, progId?: string, size?: number): IBaseExecution<string>

Inherited from IWeb.mapToIcon
- Defined in lib/SP/entitytypes.d.ts:3211
Parameters
- Optional fileName: string
- Optional progId: string
- Optional size: number
Returns IBaseExecution<string>

pageContextCore

pageContextCore(): IBaseExecution<any>

Inherited from IWeb.pageContextCore
- Defined in lib/SP/entitytypes.d.ts:3212
Returns IBaseExecution<any>

pageContextInfo

pageContextInfo(includeODBSettings?: boolean, emitNavigationInfo?: boolean): IBaseExecution<any>

Inherited from IWeb.pageContextInfo
- Defined in lib/SP/entitytypes.d.ts:3213
Parameters
- Optional includeODBSettings: boolean
- Optional emitNavigationInfo: boolean
Returns IBaseExecution<any>

parseDateTime

parseDateTime(value?: string, displayFormat?: number, calendarType?: number): IBaseExecution<string>

Inherited from IWeb.parseDateTime
- Defined in lib/SP/entitytypes.d.ts:3214
Parameters
- Optional value: string
- Optional displayFormat: number
- Optional calendarType: number
Returns IBaseExecution<string>

processExternalNotification

processExternalNotification(stream?: any): IBaseExecution<string>

Inherited from IWeb.processExternalNotification
- Defined in lib/SP/entitytypes.d.ts:3215
Parameters
- Optional stream: any
Returns IBaseExecution<string>

registerPushNotificationSubscriber

registerPushNotificationSubscriber(deviceAppInstanceId?: any, serviceToken?: string): IBaseQuery<PushNotificationSubscriber, PushNotificationSubscriberOData> & PushNotificationSubscriberCollections & PushNotificationSubscriberMethods

Inherited from IWeb.registerPushNotificationSubscriber
- Defined in lib/SP/entitytypes.d.ts:3216
Parameters
- Optional deviceAppInstanceId: any
- Optional serviceToken: string
Returns IBaseQuery<PushNotificationSubscriber, PushNotificationSubscriberOData> & PushNotificationSubscriberCollections & PushNotificationSubscriberMethods

removeStorageEntity

removeStorageEntity(key?: string): IBaseExecution<any>

Inherited from IWeb.removeStorageEntity
- Defined in lib/SP/entitytypes.d.ts:3217
Parameters
- Optional key: string
Returns IBaseExecution<any>

removeSupportedUILanguage

removeSupportedUILanguage(lcid?: number): IBaseExecution<any>

Inherited from IWeb.removeSupportedUILanguage
- Defined in lib/SP/entitytypes.d.ts:3218
Parameters
- Optional lcid: number
Returns IBaseExecution<any>

resetRoleInheritance

resetRoleInheritance(): IBaseExecution<any>

Inherited from ISecurableObject.resetRoleInheritance

Overrides IWeb.resetRoleInheritance
- Defined in lib/SP/entitytypes.d.ts:937
Returns IBaseExecution<any>

setAccessRequestSiteDescriptionAndUpdate

setAccessRequestSiteDescriptionAndUpdate(description?: string): IBaseExecution<any>

Inherited from IWeb.setAccessRequestSiteDescriptionAndUpdate
- Defined in lib/SP/entitytypes.d.ts:3219
Parameters
- Optional description: string
Returns IBaseExecution<any>

setStorageEntity

setStorageEntity(key?: string, value?: string, description?: string, comments?: string): IBaseExecution<any>

Inherited from IWeb.setStorageEntity
- Defined in lib/SP/entitytypes.d.ts:3220
Parameters
- Optional key: string
- Optional value: string
- Optional description: string
- Optional comments: string
Returns IBaseExecution<any>

setUseAccessRequestDefaultAndUpdate

setUseAccessRequestDefaultAndUpdate(useAccessRequestDefault?: boolean): IBaseExecution<any>

Inherited from IWeb.setUseAccessRequestDefaultAndUpdate
- Defined in lib/SP/entitytypes.d.ts:3221
Parameters
- Optional useAccessRequestDefault: boolean
Returns IBaseExecution<any>

stringify

stringify(): string

Inherited from IApiMetadataCollection.stringify

Overrides IApiMetadataCollection.stringify
- Defined in lib/base.d.ts:97
Method to stringify the object.

Returns string

syncFlowInstances

syncFlowInstances(targetWebUrl?: string): IBaseExecution<FlowSynchronizationResult>

Inherited from IWeb.syncFlowInstances
- Defined in lib/SP/entitytypes.d.ts:3222
Parameters
- Optional targetWebUrl: string
Returns IBaseExecution<FlowSynchronizationResult>

syncFlowTemplates

syncFlowTemplates(category?: string): IBaseExecution<FlowSynchronizationResult>

Inherited from IWeb.syncFlowTemplates
- Defined in lib/SP/entitytypes.d.ts:3223
Parameters
- Optional category: string
Returns IBaseExecution<FlowSynchronizationResult>

syncHubSiteTheme

syncHubSiteTheme(): IBaseExecution<any>

Inherited from IWeb.syncHubSiteTheme
- Defined in lib/SP/entitytypes.d.ts:3224
Returns IBaseExecution<any>

unregisterPushNotificationSubscriber

unregisterPushNotificationSubscriber(deviceAppInstanceId?: any): IBaseExecution<any>

Inherited from IWeb.unregisterPushNotificationSubscriber
- Defined in lib/SP/entitytypes.d.ts:3225
Parameters
- Optional deviceAppInstanceId: any
Returns IBaseExecution<any>

update

update(properties?: any): IBaseExecution<any>

Inherited from IWeb.update
- Defined in lib/SP/entitytypes.d.ts:3229
Parameters
- Optional properties: any
Returns IBaseExecution<any>

uploadImage

uploadImage(listTitle?: string, imageName?: string, contentStream?: any): IBaseQuery<File, FileOData> & FileCollections & FileMethods

Inherited from IWeb.uploadImage
- Defined in lib/SP/entitytypes.d.ts:3227
Parameters
- Optional listTitle: string
- Optional imageName: string
- Optional contentStream: any
Returns IBaseQuery<File, FileOData> & FileCollections & FileMethods