Options
All
  • Public
  • Public/Protected
  • All
Menu

WebMethods

Hierarchy

Index

Methods

Methods

addCrossFarmMessage

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

    • Optional messagePayloadBase64: string

    Returns IBaseExecution<boolean>

addSupportedUILanguage

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

    • Optional lcid: number

    Returns 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>
  • Parameters

    • Optional webTemplate: string

    Returns IBaseExecution<any>

breakRoleInheritance

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

    • Optional copyRoleAssignments: boolean
    • Optional clearSubscopes: boolean

    Returns IBaseExecution<any>

createDefaultAssociatedGroups

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

    • Optional userLogin: string
    • Optional userLogin2: string
    • Optional groupNameSeed: string

    Returns IBaseExecution<any>

defaultDocumentLibrary

delete

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

doesPushNotificationSubscriberExist

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

    • Optional deviceAppInstanceId: any

    Returns IBaseExecution<boolean>

doesUserHavePermissions

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

    • Optional high: number
    • Optional low: number

    Returns IBaseExecution<boolean>

ensureUser

executeRemoteLOB

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

    • Optional inputStream: any

    Returns IBaseExecution<any>

getAllClientSideComponents

  • getAllClientSideComponents(): IBaseExecution<string>
  • Returns IBaseExecution<string>

getAppBdcCatalog

  • getAppBdcCatalog(): IBaseExecution<AppBdcCatalog>
  • Returns IBaseExecution<AppBdcCatalog>

getAppBdcCatalogForAppInstance

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

    • Optional appInstanceId: any

    Returns IBaseExecution<AppBdcCatalog>

getAppInstanceById

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

    • Optional appInstanceId: any

    Returns IBaseExecution<AppInstance>

getAppInstancesByProductId

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

    • Optional productId: any

    Returns IBaseCollection<AppInstance>

getAvailableWebTemplates

getCatalog

getChanges

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

    • Optional query: ChangeQuery

    Returns IBaseCollection<Change>

getClientSideComponents

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

    • Optional components: Array<SPClientSideComponentIdentifier>

    Returns IBaseCollection<SPClientSideComponentQueryResult>

getClientSideComponentsById

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

    • Optional componentIds: Array<any>

    Returns IBaseCollection<SPClientSideComponentQueryResult>

getClientSideWebParts

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

    • Optional includeErrors: boolean

    Returns IBaseCollection<SPClientSideComponentQueryResult>

getCustomListTemplates

getEntity

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

    • Optional namespace: string
    • Optional name: string

    Returns IBaseExecution<Entity>

getFileByGuestUrl

getFileByGuestUrlEnsureAccess

getFileByGuestUrlExtended

  • Parameters

    • Optional guestUrl: string
    • Optional requestSettings: SharingLinkAccessRequest

    Returns IBaseQuery<File, FileOData> & FileCollections & FileMethods

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>
  • Returns IBaseExecution<string>

getSPAppContextAsStream

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

getSharingLinkData

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

    • Optional linkUrl: string

    Returns IBaseExecution<SharingLinkData>

getStorageEntity

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

    • Optional key: string

    Returns IBaseExecution<StorageEntity>

getSubwebsFilteredForCurrentUser

getUserById

getUserEffectivePermissions

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

    • Optional userName: string

    Returns IBaseExecution<BasePermissions>

getViewFromPath

getViewFromUrl

hubSiteData

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

    • Optional forceRefresh: boolean

    Returns IBaseExecution<string>

hubSiteDataAsStream

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

    • Optional forceRefresh: boolean

    Returns IBaseExecution<any>

incrementSiteClientTag

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

loadAndInstallApp

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

    • Optional appPackageStream: any

    Returns IBaseExecution<AppInstance>

loadAndInstallAppInSpecifiedLocale

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

    • Optional appPackageStream: any
    • Optional installationLocaleLCID: number

    Returns 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>
  • Returns 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>
  • Parameters

    • Optional stream: any

    Returns IBaseExecution<string>

registerPushNotificationSubscriber

removeStorageEntity

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

    • Optional key: string

    Returns IBaseExecution<any>

removeSupportedUILanguage

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

    • Optional lcid: number

    Returns IBaseExecution<any>

resetRoleInheritance

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

setAccessRequestSiteDescriptionAndUpdate

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

    • Optional description: string

    Returns 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>
  • Parameters

    • Optional useAccessRequestDefault: boolean

    Returns IBaseExecution<any>

syncFlowInstances

  • Parameters

    • Optional targetWebUrl: string

    Returns IBaseExecution<FlowSynchronizationResult>

syncFlowTemplates

  • Parameters

    • Optional category: string

    Returns IBaseExecution<FlowSynchronizationResult>

syncHubSiteTheme

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

unregisterPushNotificationSubscriber

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

    • Optional deviceAppInstanceId: any

    Returns IBaseExecution<any>

update

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

    • Optional properties: any

    Returns IBaseExecution<any>

uploadImage

  • Parameters

    • Optional listTitle: string
    • Optional imageName: string
    • Optional contentStream: any

    Returns IBaseQuery<File, FileOData> & FileCollections & FileMethods

Generated using TypeDoc