Interface SiteMethods

SiteMethods

Hierarchy

SiteMethods
- ISite
- ISiteQuery
- Site
- SiteOData

Index

Methods

Methods

createCopyJob

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

- Defined in lib/SP/entitytypes.d.ts:242
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>

- Defined in lib/SP/entitytypes.d.ts:243
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>

- Defined in lib/SP/entitytypes.d.ts:244
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>

- Defined in lib/SP/entitytypes.d.ts:245
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>

- Defined in lib/SP/entitytypes.d.ts:246
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>

- Defined in lib/SP/entitytypes.d.ts:247
Parameters
- Optional upgrade: boolean
- Optional sendemail: boolean
Returns IBaseExecution<any>

createSPAsyncReadJob

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

- Defined in lib/SP/entitytypes.d.ts:248
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>

- Defined in lib/SP/entitytypes.d.ts:249
Parameters
- Optional id: any
Returns IBaseExecution<boolean>

extendUpgradeReminderDate

extendUpgradeReminderDate(): IBaseExecution<any>

- Defined in lib/SP/entitytypes.d.ts:250
Returns IBaseExecution<any>

getBringYourOwnKeySiteStatus

getBringYourOwnKeySiteStatus(): IBaseExecution<CustomerKeyStatusInfo>

- Defined in lib/SP/entitytypes.d.ts:251
Returns IBaseExecution<CustomerKeyStatusInfo>

getBringYourOwnKeyTenantStatus

getBringYourOwnKeyTenantStatus(): IBaseExecution<CustomerKeyStatusInfo>

- Defined in lib/SP/entitytypes.d.ts:252
Returns IBaseExecution<CustomerKeyStatusInfo>

getCatalog

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

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

getChanges

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

- Defined in lib/SP/entitytypes.d.ts:254
Parameters
- Optional query: ChangeQuery
Returns IBaseCollection<Change>

getCopyJobProgress

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

- Defined in lib/SP/entitytypes.d.ts:255
Parameters
- Optional copyJobInfo: CopyMigrationInfo
Returns IBaseExecution<CopyJobProgress>

getHubSiteJoinApprovalCorrelationId

getHubSiteJoinApprovalCorrelationId(): IBaseExecution<string>

- Defined in lib/SP/entitytypes.d.ts:256
Returns IBaseExecution<string>

getMigrationJobStatus

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

- Defined in lib/SP/entitytypes.d.ts:257
Parameters
- Optional id: any
Returns IBaseExecution<number>

getMigrationStatus

getMigrationStatus(): IBaseCollection<SPMigrationJobStatus>

- Defined in lib/SP/entitytypes.d.ts:258
Returns IBaseCollection<SPMigrationJobStatus>

getRecycleBinItems

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

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

getWebPath

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

- Defined in lib/SP/entitytypes.d.ts:260
Parameters
- Optional siteId: any
- Optional webId: any
Returns IBaseExecution<ResourcePath>

getWebTemplates

getWebTemplates(LCID?: number, overrideCompatLevel?: number): IBaseCollection<WebTemplate> & WebTemplateCollectionMethods

- Defined in lib/SP/entitytypes.d.ts:261
Parameters
- Optional LCID: number
- Optional overrideCompatLevel: number
Returns IBaseCollection<WebTemplate> & WebTemplateCollectionMethods

invalidate

invalidate(): IBaseExecution<any>

- Defined in lib/SP/entitytypes.d.ts:262
Returns IBaseExecution<any>

joinHubSite

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

- Defined in lib/SP/entitytypes.d.ts:263
Parameters
- Optional hubSiteId: any
- Optional approvalToken: string
- Optional approvalCorrelationId: string
Returns IBaseExecution<any>

multiGeoCopyJob

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

- Defined in lib/SP/entitytypes.d.ts:264
Parameters
- Optional jobId: any
- Optional userId: number
- Optional binaryPayload: any
Returns IBaseExecution<any>

needsUpgradeByType

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

- Defined in lib/SP/entitytypes.d.ts:265
Parameters
- Optional versionUpgrade: boolean
- Optional recursive: boolean
Returns IBaseExecution<boolean>

onHubSiteJoinRequestApproved

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

- Defined in lib/SP/entitytypes.d.ts:267
Parameters
- Optional joiningSiteId: any
Returns IBaseExecution<string>

onHubSiteJoinRequestCanceled

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

- Defined in lib/SP/entitytypes.d.ts:268
Parameters
- Optional approvalCorrelationId: string
Returns IBaseExecution<any>

onHubSiteJoinRequestStarted

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

- Defined in lib/SP/entitytypes.d.ts:269
Parameters
- Optional approvalCorrelationId: string
Returns IBaseExecution<any>

onboardTenantForBringYourOwnKey

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

- Defined in lib/SP/entitytypes.d.ts:266
Parameters
- Optional keyInfo: CustomerKeyInfo
Returns IBaseExecution<CustomerKeyStatusInfo>

openWeb

openWeb(strUrl?: string): IBaseQuery<Web, WebOData> & WebCollections & WebMethods

- Defined in lib/SP/entitytypes.d.ts:270
Parameters
- Optional strUrl: string
Returns IBaseQuery<Web, WebOData> & WebCollections & WebMethods

openWebById

openWebById(gWebId?: any): IBaseQuery<Web, WebOData> & WebCollections & WebMethods

- Defined in lib/SP/entitytypes.d.ts:271
Parameters
- Optional gWebId: any
Returns IBaseQuery<Web, WebOData> & WebCollections & WebMethods

openWebUsingPath

openWebUsingPath(path?: ResourcePath): IBaseQuery<Web, WebOData> & WebCollections & WebMethods

- Defined in lib/SP/entitytypes.d.ts:272
Parameters
- Optional path: ResourcePath
Returns IBaseQuery<Web, WebOData> & WebCollections & WebMethods

provisionMigrationContainers

provisionMigrationContainers(): IBaseExecution<ProvisionedMigrationContainersInfo>

- Defined in lib/SP/entitytypes.d.ts:273
Returns IBaseExecution<ProvisionedMigrationContainersInfo>

provisionMigrationQueue

provisionMigrationQueue(): IBaseExecution<ProvisionedMigrationQueueInfo>

- Defined in lib/SP/entitytypes.d.ts:274
Returns IBaseExecution<ProvisionedMigrationQueueInfo>

recoverTenantForBringYourOwnKey

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

- Defined in lib/SP/entitytypes.d.ts:275
Parameters
- Optional keyInfo: CustomerKeyInfo
Returns IBaseExecution<CustomerKeyStatusInfo>

registerHubSite

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

- Defined in lib/SP/entitytypes.d.ts:276
Parameters
- Optional creationInformation: HubSiteCreationInformation
Returns IBaseExecution<HubSite>

rollTenantBringYourOwnKey

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

- Defined in lib/SP/entitytypes.d.ts:277
Parameters
- Optional keyType: number
- Optional keyVaultInfo: CustomerKeyVaultInfo
Returns IBaseExecution<CustomerKeyStatusInfo>

runHealthCheck

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

- Defined in lib/SP/entitytypes.d.ts:278
Parameters
- Optional ruleId: any
- Optional bRepair: boolean
- Optional bRunAlways: boolean
Returns IBaseExecution<SiteHealthSummary>

runUpgradeSiteSession

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

- Defined in lib/SP/entitytypes.d.ts:279
Parameters
- Optional versionUpgrade: boolean
- Optional queueOnly: boolean
- Optional sendEmail: boolean
Returns IBaseExecution<any>

unregisterHubSite

unregisterHubSite(): IBaseExecution<any>

- Defined in lib/SP/entitytypes.d.ts:280
Returns IBaseExecution<any>

update

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

- Defined in lib/SP/entitytypes.d.ts:283
Parameters
- Optional properties: any
Returns IBaseExecution<any>

updateClientObjectModelUseRemoteAPIsPermissionSetting

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

- Defined in lib/SP/entitytypes.d.ts:281
Parameters
- Optional requireUseRemoteAPIs: boolean
Returns IBaseExecution<any>

validateHubSiteJoinApprovalToken

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

- Defined in lib/SP/entitytypes.d.ts:282
Parameters
- Optional joiningSiteId: any
- Optional approvalToken: string
Returns IBaseExecution<boolean>

Generated using TypeDoc