Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISite<Result>

ISite

Type parameters

  • Result

Hierarchy

Index

Properties

Methods

Properties

Optional query

query: (query: IODataQuery) => IBaseExecution<ISiteQuery>

Queries the collection.

param

The OData information.

Type declaration

    • (query: IODataQuery): IBaseExecution<ISiteQuery>

    • Parameters

      • query: IODataQuery

      Returns IBaseExecution<ISiteQuery>

Methods

Audit

CustomScriptSafeDomains

EventReceivers

Features

HubSiteSynchronizableVisitorGroup

Owner

RecycleBin

RootWeb

SecondaryContact

UserCustomActions

batch

  • batch(resolve: (value?: Result) => void): Site
  • batch(appendFl?: boolean): Site
  • batch(resolve: (value?: Result) => void, appendFl?: boolean): Site

  • Method to execute the request as a batch. Currently available in SharePoint Online only.

    Parameters

    • resolve: (value?: Result) => void

      The method to be executed after the request completes.

        • (value?: Result): void

        • Parameters

          • Optional value: Result

          Returns void

    Returns Site

  • Method to execute the request as a batch. Currently available in SharePoint Online only.

    Parameters

    • Optional appendFl: boolean

      Flag to execute the request as part of a change set.

    Returns Site

  • Method to execute the request as a batch. Currently available in SharePoint Online only.

    Parameters

    • resolve: (value?: Result) => void

      The method to be executed after the request completes.

        • (value?: Result): void

        • Parameters

          • Optional value: Result

          Returns void

    • Optional appendFl: boolean

      Flag to execute the request as part of a change set.

    Returns Site

createCopyJob

  • createCopyJob(exportObjectUris?: Array<string>, destinationUri?: string, options?: CopyMigrationOptions): IBaseExecution<CopyMigrationInfo>

  • Parameters

    • Optional exportObjectUris: Array<string>
    • Optional destinationUri: string
    • Optional options: CopyMigrationOptions

    Returns IBaseExecution<CopyMigrationInfo>

createCopyJobs

  • createCopyJobs(exportObjectUris?: Array<string>, destinationUri?: string, options?: CopyMigrationOptions): IBaseCollection<CopyMigrationInfo>

  • Parameters

    • Optional exportObjectUris: Array<string>
    • Optional destinationUri: string
    • Optional options: CopyMigrationOptions

    Returns IBaseCollection<CopyMigrationInfo>

createMigrationIngestionJob

  • createMigrationIngestionJob(gWebId?: any, azureContainerSourceUri?: string, azureContainerManifestUri?: string, azureQueueReportUri?: string, ingestionTaskKey?: IngestionTaskKey): IBaseExecution<any>

  • Parameters

    • Optional gWebId: any
    • Optional azureContainerSourceUri: string
    • Optional azureContainerManifestUri: string
    • Optional azureQueueReportUri: string
    • Optional ingestionTaskKey: IngestionTaskKey

    Returns IBaseExecution<any>

createMigrationJob

  • createMigrationJob(gWebId?: any, azureContainerSourceUri?: string, azureContainerManifestUri?: string, azureQueueReportUri?: string): IBaseExecution<any>

  • Parameters

    • Optional gWebId: any
    • Optional azureContainerSourceUri: string
    • Optional azureContainerManifestUri: string
    • Optional azureQueueReportUri: string

    Returns IBaseExecution<any>

createMigrationJobEncrypted

  • createMigrationJobEncrypted(gWebId?: any, azureContainerSourceUri?: string, azureContainerManifestUri?: string, azureQueueReportUri?: string, options?: EncryptionOption): IBaseExecution<any>

  • Parameters

    • Optional gWebId: any
    • Optional azureContainerSourceUri: string
    • Optional azureContainerManifestUri: string
    • Optional azureQueueReportUri: string
    • Optional options: EncryptionOption

    Returns IBaseExecution<any>

createPreviewSPSite

  • createPreviewSPSite(upgrade?: boolean, sendemail?: boolean): IBaseExecution<any>

  • Parameters

    • Optional upgrade: boolean
    • Optional sendemail: boolean

    Returns IBaseExecution<any>

createSPAsyncReadJob

  • createSPAsyncReadJob(url?: string, readOptions?: AsyncReadOptions, encryptionOption?: EncryptionOption, azureContainerManifestUri?: string, azureQueueReportUri?: string): IBaseExecution<AsyncReadJobInfo>

  • Parameters

    • Optional url: string
    • Optional readOptions: AsyncReadOptions
    • Optional encryptionOption: EncryptionOption
    • Optional azureContainerManifestUri: string
    • Optional azureQueueReportUri: string

    Returns IBaseExecution<AsyncReadJobInfo>

deleteMigrationJob

  • deleteMigrationJob(id?: any): IBaseExecution<boolean>

  • Parameters

    • Optional id: any

    Returns IBaseExecution<boolean>

done

  • done<T>(resolve: (value?: T) => void): any

  • Method to wait for the requests to complete.

    Type parameters

    • T

    Parameters

    • resolve: (value?: T) => void

      The method to be executed after the request completes.

        • (value?: T): void

        • Parameters

          • Optional value: T

          Returns void

    Returns any

execute

  • execute(waitFl: boolean): Site
  • execute(resolve?: (value?: Result) => void, waitFl?: boolean): Site
  • execute(resolve?: (value?: Result) => void, reject?: (value?: Result) => void, waitFl?: boolean): Site

  • Method to execute the request.

    Parameters

    • waitFl: boolean

      Flag to execute the request, after the previous requests have completed.

    Returns Site

  • Method to execute the request.

    Parameters

    • Optional resolve: (value?: Result) => void

      The method to be executed if the request is successful.

        • (value?: Result): void

        • Parameters

          • Optional value: Result

          Returns void

    • Optional waitFl: boolean

      Flag to execute the request, after the previous requests have completed.

    Returns Site

  • Method to execute the request.

    Parameters

    • Optional resolve: (value?: Result) => void

      The method to be executed if the request is successful.

        • (value?: Result): void

        • Parameters

          • Optional value: Result

          Returns void

    • Optional reject: (value?: Result) => void

      The method to be executed if the request fails.

        • (value?: Result): void

        • Parameters

          • Optional value: Result

          Returns void

    • Optional waitFl: boolean

      Flag to execute the request, after the previous requests have completed.

    Returns Site

executeAndWait

  • executeAndWait(): Result

  • Method to execute the request synchronously.

    Returns Result

executeMethod

  • executeMethod(methodName: string, methodConfig: IMethodInfo, args?: any): any

  • Method to execute the request. (This is an internal method, but can be used for dev purposes.)

    Parameters

    • methodName: string

      The method name to execute.

    • methodConfig: IMethodInfo

      The configuration to pass with the request.

    • Optional args: any

      The optional arguments for the request.

    Returns any

extendUpgradeReminderDate

  • extendUpgradeReminderDate(): IBaseExecution<any>

getBringYourOwnKeySiteStatus

  • getBringYourOwnKeySiteStatus(): IBaseExecution<CustomerKeyStatusInfo>

getBringYourOwnKeyTenantStatus

  • getBringYourOwnKeyTenantStatus(): IBaseExecution<CustomerKeyStatusInfo>

getCatalog

getChanges

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

  • Parameters

    • Optional query: ChangeQuery

    Returns IBaseCollection<Change>

getCopyJobProgress

  • getCopyJobProgress(copyJobInfo?: CopyMigrationInfo): IBaseExecution<CopyJobProgress>

  • Parameters

    • Optional copyJobInfo: CopyMigrationInfo

    Returns IBaseExecution<CopyJobProgress>

getHubSiteJoinApprovalCorrelationId

  • getHubSiteJoinApprovalCorrelationId(): IBaseExecution<string>

getInfo

  • getInfo(): IRequestInfo

  • Method to get the request information.

    Returns IRequestInfo

getMigrationJobStatus

  • getMigrationJobStatus(id?: any): IBaseExecution<number>

  • Parameters

    • Optional id: any

    Returns IBaseExecution<number>

getMigrationStatus

getRecycleBinItems

getWebPath

  • getWebPath(siteId?: any, webId?: any): IBaseExecution<ResourcePath>

  • Parameters

    • Optional siteId: any
    • Optional webId: any

    Returns IBaseExecution<ResourcePath>

getWebTemplates

invalidate

  • invalidate(): IBaseExecution<any>

  • Returns IBaseExecution<any>

joinHubSite

  • joinHubSite(hubSiteId?: any, approvalToken?: string, approvalCorrelationId?: string): IBaseExecution<any>

  • Parameters

    • Optional hubSiteId: any
    • Optional approvalToken: string
    • Optional approvalCorrelationId: string

    Returns IBaseExecution<any>

multiGeoCopyJob

  • multiGeoCopyJob(jobId?: any, userId?: number, binaryPayload?: any): IBaseExecution<any>

  • Parameters

    • Optional jobId: any
    • Optional userId: number
    • Optional binaryPayload: any

    Returns IBaseExecution<any>

needsUpgradeByType

  • needsUpgradeByType(versionUpgrade?: boolean, recursive?: boolean): IBaseExecution<boolean>

  • Parameters

    • Optional versionUpgrade: boolean
    • Optional recursive: boolean

    Returns IBaseExecution<boolean>

onHubSiteJoinRequestApproved

  • onHubSiteJoinRequestApproved(joiningSiteId?: any): IBaseExecution<string>

onHubSiteJoinRequestCanceled

  • onHubSiteJoinRequestCanceled(approvalCorrelationId?: string): IBaseExecution<any>

  • Parameters

    • Optional approvalCorrelationId: string

    Returns IBaseExecution<any>

onHubSiteJoinRequestStarted

  • onHubSiteJoinRequestStarted(approvalCorrelationId?: string): IBaseExecution<any>

  • Parameters

    • Optional approvalCorrelationId: string

    Returns IBaseExecution<any>

onboardTenantForBringYourOwnKey

  • onboardTenantForBringYourOwnKey(keyInfo?: CustomerKeyInfo): IBaseExecution<CustomerKeyStatusInfo>

  • Parameters

    • Optional keyInfo: CustomerKeyInfo

    Returns IBaseExecution<CustomerKeyStatusInfo>

openWeb

openWebById

openWebUsingPath

provisionMigrationContainers

  • provisionMigrationContainers(): IBaseExecution<ProvisionedMigrationContainersInfo>

provisionMigrationQueue

  • provisionMigrationQueue(): IBaseExecution<ProvisionedMigrationQueueInfo>

recoverTenantForBringYourOwnKey

  • recoverTenantForBringYourOwnKey(keyInfo?: CustomerKeyInfo): IBaseExecution<CustomerKeyStatusInfo>

  • Parameters

    • Optional keyInfo: CustomerKeyInfo

    Returns IBaseExecution<CustomerKeyStatusInfo>

registerHubSite

  • registerHubSite(creationInformation?: HubSiteCreationInformation): IBaseExecution<HubSite>

  • Parameters

    • Optional creationInformation: HubSiteCreationInformation

    Returns IBaseExecution<HubSite>

rollTenantBringYourOwnKey

  • rollTenantBringYourOwnKey(keyType?: number, keyVaultInfo?: CustomerKeyVaultInfo): IBaseExecution<CustomerKeyStatusInfo>

  • Parameters

    • Optional keyType: number
    • Optional keyVaultInfo: CustomerKeyVaultInfo

    Returns IBaseExecution<CustomerKeyStatusInfo>

runHealthCheck

  • runHealthCheck(ruleId?: any, bRepair?: boolean, bRunAlways?: boolean): IBaseExecution<SiteHealthSummary>

  • Parameters

    • Optional ruleId: any
    • Optional bRepair: boolean
    • Optional bRunAlways: boolean

    Returns IBaseExecution<SiteHealthSummary>

runUpgradeSiteSession

  • runUpgradeSiteSession(versionUpgrade?: boolean, queueOnly?: boolean, sendEmail?: boolean): IBaseExecution<any>

  • Parameters

    • Optional versionUpgrade: boolean
    • Optional queueOnly: boolean
    • Optional sendEmail: boolean

    Returns IBaseExecution<any>

unregisterHubSite

  • unregisterHubSite(): IBaseExecution<any>

update

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

  • Parameters

    • Optional properties: any

    Returns IBaseExecution<any>

updateClientObjectModelUseRemoteAPIsPermissionSetting

  • updateClientObjectModelUseRemoteAPIsPermissionSetting(requireUseRemoteAPIs?: boolean): IBaseExecution<any>

validateHubSiteJoinApprovalToken

  • validateHubSiteJoinApprovalToken(joiningSiteId?: any, approvalToken?: string): IBaseExecution<boolean>

  • Parameters

    • Optional joiningSiteId: any
    • Optional approvalToken: string

    Returns IBaseExecution<boolean>

Generated using TypeDoc