Options
All
  • Public
  • Public/Protected
  • All
Menu

IWebQuery

Hierarchy

Index

Properties

Methods

Properties

Optional AccessRequestListUrl

AccessRequestListUrl: string

Optional AccessRequestSiteDescription

AccessRequestSiteDescription: string

Activities

Activities: IBaseResults<SPActivityEntity>

ActivityLogger

ActivityLogger: ActivityLogger & ActivityLoggerCollections

Alerts

Alerts: IBaseResults<Alert> & AlertCollectionMethods

AllProperties

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

AppTiles

AppTiles: IBaseResults<AppTile>

AssociatedMemberGroup

AssociatedMemberGroup: Group & GroupCollections & GroupCollectionMethods

AssociatedOwnerGroup

AssociatedVisitorGroup

AssociatedVisitorGroup: Group & GroupCollections & GroupCollectionMethods

Author

AvailableContentTypes

AvailableContentTypes: IBaseResults<ContentType> & ContentTypeCollectionMethods

AvailableFields

AvailableFields: IBaseResults<Field> & FieldCollectionMethods

Optional ClassicWelcomePage

ClassicWelcomePage: string

ClientWebParts

ClientWebParts: IBaseResults<ClientWebPart> & ClientWebPartCollectionMethods

Optional CommentsOnSitePagesDisabled

CommentsOnSitePagesDisabled: boolean

Optional Configuration

Configuration: number

Optional ContainsConfidentialInfo

ContainsConfidentialInfo: boolean

ContentTypes

ContentTypes: IBaseResults<ContentType> & ContentTypeCollectionMethods

Optional Created

Created: any

Optional CurrentChangeToken

CurrentChangeToken: ChangeToken

CurrentUser

Optional CustomMasterUrl

CustomMasterUrl: string

Optional CustomSiteActionsDisabled

CustomSiteActionsDisabled: boolean

DataLeakagePreventionStatusInfo

Optional Description

Description: string

DescriptionResource

DescriptionResource: UserResource & UserResourceCollections

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

EventReceivers

Optional ExcludeFromOfflineClient

ExcludeFromOfflineClient: boolean

Features

Features: IBaseResults<Feature> & FeatureCollectionMethods

Fields

Fields: IBaseResults<Field> & FieldCollectionMethods

FirstUniqueAncestorSecurableObject

FirstUniqueAncestorSecurableObject: SecurableObject & SecurableObjectCollections

Folders

Folders: IBaseResults<Folder> & FolderCollectionMethods

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

HostedApps

HostedApps: HostedAppsManager & HostedAppsManagerCollections

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

ListTemplates

ListTemplates: IBaseResults<ListTemplate> & ListTemplateCollectionMethods

Lists

Lists: IBaseResults<List> & ListCollectionMethods

Optional MasterUrl

MasterUrl: string

Optional MegaMenuEnabled

MegaMenuEnabled: boolean

Optional MembersCanShare

MembersCanShare: boolean

MultilingualSettings

Optional NavAudienceTargetingEnabled

NavAudienceTargetingEnabled: boolean

Navigation

Optional NoCrawl

NoCrawl: boolean

Optional NotificationsInOneDriveForBusinessEnabled

NotificationsInOneDriveForBusinessEnabled: boolean

Optional NotificationsInSharePointEnabled

NotificationsInSharePointEnabled: boolean

Optional ObjectCacheEnabled

ObjectCacheEnabled: boolean

OneDriveSharedItems

OneDriveSharedItems: IBaseResults<SharedDocumentInfo>

Optional OverwriteTranslationsOnChange

OverwriteTranslationsOnChange: boolean

ParentWeb

Optional PreviewFeaturesEnabled

PreviewFeaturesEnabled: boolean

Optional PrimaryColor

PrimaryColor: string

PushNotificationSubscribers

PushNotificationSubscribers: IBaseResults<PushNotificationSubscriber> & PushNotificationSubscriberCollectionMethods

Optional QuickLaunchEnabled

QuickLaunchEnabled: boolean

RecycleBin

Optional RecycleBinEnabled

RecycleBinEnabled: boolean

RegionalSettings

Optional RequestAccessEmail

RequestAccessEmail: string

Optional ResourcePath

ResourcePath: ResourcePath

RoleAssignments

RoleAssignments: IBaseResults<RoleAssignment> & RoleAssignmentCollectionMethods

RoleDefinitions

RoleDefinitions: IBaseResults<RoleDefinition> & RoleDefinitionCollectionMethods

RootFolder

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

SiteCollectionAppCatalog

SiteCollectionAppCatalog: SiteCollectionCorporateCatalogAccessor & SiteCollectionCorporateCatalogAccessorCollections

SiteGroups

SiteGroups: IBaseResults<Group> & GroupCollectionMethods

Optional SiteLogoDescription

SiteLogoDescription: string

Optional SiteLogoUrl

SiteLogoUrl: string

SiteUserInfoList

SiteUsers

SiteUsers: IBaseResults<User> & UserCollectionMethods

Optional SupportedUILanguageIds

SupportedUILanguageIds: { results: Array<number> }

Type declaration

  • results: Array<number>

Optional SyndicationEnabled

SyndicationEnabled: boolean

Optional TenantAdminMembersCanShare

TenantAdminMembersCanShare: number

TenantAppCatalog

TenantAppCatalog: TenantCorporateCatalogAccessor & TenantCorporateCatalogAccessorCollections

Optional TenantTagPolicyEnabled

TenantTagPolicyEnabled: boolean

Optional ThemeData

ThemeData: string

ThemeInfo

Optional ThemedCssFolderUrl

ThemedCssFolderUrl: string

Optional ThirdPartyMdmEnabled

ThirdPartyMdmEnabled: boolean

Optional Title

Title: string

TitleResource

Optional TreeViewEnabled

TreeViewEnabled: boolean

Optional UIVersion

UIVersion: number

Optional UIVersionConfigurationEnabled

UIVersionConfigurationEnabled: boolean

Optional Url

Url: string

Optional UseAccessRequestDefault

UseAccessRequestDefault: boolean

UserCustomActions

UserCustomActions: IBaseResults<UserCustomAction> & UserCustomActionCollectionMethods

WebInfos

Optional WebTemplate

WebTemplate: string

Webs

Webs: IBaseResults<Web> & WebCollectionMethods

Optional WelcomePage

WelcomePage: string

WorkflowAssociations

WorkflowAssociations: IBaseResults<WorkflowAssociation> & WorkflowAssociationCollectionMethods

WorkflowTemplates

WorkflowTemplates: IBaseResults<WorkflowTemplate> & WorkflowTemplateCollectionMethods

existsFl

existsFl: boolean

True, if the object exists, false otherwise.

response

response: string

The response

Methods

addCrossFarmMessage

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

addSupportedUILanguage

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

applyTheme

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

    • Optional colorPaletteUrl: string
    • Optional fontSchemeUrl: string
    • Optional backgroundImageUrl: string
    • Optional shareGenerated: boolean

    Returns IBaseExecution<any>

applyWebTemplate

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

breakRoleInheritance

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

createDefaultAssociatedGroups

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

defaultDocumentLibrary

delete

  • delete(): IBaseExecution<any>
  • Returns IBaseExecution<any>

doesPushNotificationSubscriberExist

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

doesUserHavePermissions

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

ensureUser

executeRemoteLOB

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

getAllClientSideComponents

  • getAllClientSideComponents(): IBaseExecution<string>

getAppBdcCatalog

  • getAppBdcCatalog(): IBaseExecution<AppBdcCatalog>

getAppBdcCatalogForAppInstance

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

getAppInstanceById

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

getAppInstancesByProductId

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

getAvailableWebTemplates

getCatalog

getChanges

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

getClientSideComponents

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

getClientSideComponentsById

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

getClientSideWebParts

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

getCustomListTemplates

getEntity

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

    • Optional namespace: string
    • Optional name: string

    Returns IBaseExecution<Entity>

getFileByGuestUrl

getFileByGuestUrlEnsureAccess

getFileByGuestUrlExtended

getFileById

getFileByLinkingUrl

getFileByServerRelativePath

getFileByServerRelativeUrl

getFileByUrl

getFileByWOPIFrameUrl

getFolderByGuestUrl

getFolderByGuestUrlExtended

getFolderById

getFolderByServerRelativePath

getFolderByServerRelativeUrl

getList

getListItem

getListItemByResourceId

getListItemUsingPath

getListUsingPath

getNewsList

getPushNotificationSubscriber

getPushNotificationSubscribersByArgs

getPushNotificationSubscribersByUser

getRecycleBinItems

getRecycleBinItemsByQueryInfo

getRegionalDateTimeSchema

  • getRegionalDateTimeSchema(): IBaseExecution<string>

getSPAppContextAsStream

  • getSPAppContextAsStream(): IBaseExecution<any>

getSharingLinkData

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

getStorageEntity

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

getSubwebsFilteredForCurrentUser

getUserById

getUserEffectivePermissions

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

getViewFromPath

getViewFromUrl

hubSiteData

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

    • Optional forceRefresh: boolean

    Returns IBaseExecution<string>

hubSiteDataAsStream

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

incrementSiteClientTag

  • incrementSiteClientTag(): IBaseExecution<any>

loadAndInstallApp

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

loadAndInstallAppInSpecifiedLocale

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

loadApp

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

    • Optional appPackageStream: any
    • Optional installationLocaleLCID: number

    Returns IBaseExecution<AppInstance>

mapToIcon

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

    • Optional fileName: string
    • Optional progId: string
    • Optional size: number

    Returns IBaseExecution<string>

pageContextCore

  • pageContextCore(): IBaseExecution<any>

pageContextInfo

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

    • Optional includeODBSettings: boolean
    • Optional emitNavigationInfo: boolean

    Returns IBaseExecution<any>

parseDateTime

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

    • Optional value: string
    • Optional displayFormat: number
    • Optional calendarType: number

    Returns IBaseExecution<string>

processExternalNotification

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

registerPushNotificationSubscriber

removeStorageEntity

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

removeSupportedUILanguage

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

resetRoleInheritance

  • resetRoleInheritance(): IBaseExecution<any>

setAccessRequestSiteDescriptionAndUpdate

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

setStorageEntity

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

    • Optional key: string
    • Optional value: string
    • Optional description: string
    • Optional comments: string

    Returns IBaseExecution<any>

setUseAccessRequestDefaultAndUpdate

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

stringify

  • stringify(): string

syncFlowInstances

syncFlowTemplates

syncHubSiteTheme

  • syncHubSiteTheme(): IBaseExecution<any>

unregisterPushNotificationSubscriber

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

update

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

    • Optional properties: any

    Returns IBaseExecution<any>

uploadImage

Generated using TypeDoc