Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISiteQuery

ISiteQuery

Hierarchy

Index

Properties

Methods

Properties

Optional AllowCreateDeclarativeWorkflow

AllowCreateDeclarativeWorkflow: boolean

Optional AllowDesigner

AllowDesigner: boolean

Optional AllowExternalEmbeddingWrapper

AllowExternalEmbeddingWrapper: number

Optional AllowMasterPageEditing

AllowMasterPageEditing: boolean

Optional AllowRevertFromTemplate

AllowRevertFromTemplate: boolean

Optional AllowSaveDeclarativeWorkflowAsTemplate

AllowSaveDeclarativeWorkflowAsTemplate: boolean

Optional AllowSavePublishDeclarativeWorkflow

AllowSavePublishDeclarativeWorkflow: boolean

Optional AllowSelfServiceUpgrade

AllowSelfServiceUpgrade: boolean

Optional AllowSelfServiceUpgradeEvaluation

AllowSelfServiceUpgradeEvaluation: boolean

Audit

Audit: Audit & AuditCollections

Optional AuditLogTrimmingRetention

AuditLogTrimmingRetention: number

Optional CanSyncHubSitePermissions

CanSyncHubSitePermissions: boolean

Optional CanUpgrade

CanUpgrade: boolean

Optional Classification

Classification: string

Optional CommentsOnSitePagesDisabled

CommentsOnSitePagesDisabled: boolean

Optional CompatibilityLevel

CompatibilityLevel: number

Optional ComplianceAttribute

ComplianceAttribute: string

Optional CurrentChangeToken

CurrentChangeToken: ChangeToken

CustomScriptSafeDomains

CustomScriptSafeDomains: IBaseResults<ScriptSafeDomain> & ScriptSafeDomainCollectionMethods

Optional DisableAppViews

DisableAppViews: boolean

Optional DisableCompanyWideSharingLinks

DisableCompanyWideSharingLinks: boolean

Optional DisableFlows

DisableFlows: boolean

EventReceivers

EventReceivers: IBaseResults<EventReceiverDefinition> & EventReceiverDefinitionCollectionMethods

Optional ExternalSharingTipsEnabled

ExternalSharingTipsEnabled: boolean

Optional ExternalUserExpirationInDays

ExternalUserExpirationInDays: number

Features

Features: IBaseResults<Feature> & FeatureCollectionMethods

Optional GeoLocation

GeoLocation: string

Optional GroupId

GroupId: any

Optional HubSiteId

HubSiteId: any

HubSiteSynchronizableVisitorGroup

HubSiteSynchronizableVisitorGroup: Group & GroupCollections & GroupCollectionMethods

Optional Id

Id: any

Optional IsHubSite

IsHubSite: boolean

Optional LockIssue

LockIssue: string

Optional MaxItemsPerThrottledOperation

MaxItemsPerThrottledOperation: number

Optional NeedsB2BUpgrade

NeedsB2BUpgrade: boolean

Owner

Owner: User & UserCollections & UserCollectionMethods

Optional PrimaryUri

PrimaryUri: string

Optional ReadOnly

ReadOnly: boolean

RecycleBin

RecycleBin: IBaseResults<RecycleBinItem> & RecycleBinItemCollectionMethods

Optional RelatedGroupId

RelatedGroupId: any

Optional RequiredDesignerVersion

RequiredDesignerVersion: string

Optional ResourcePath

ResourcePath: ResourcePath

RootWeb

RootWeb: Web & WebCollections & WebCollectionMethods

Optional SandboxedCodeActivationCapability

SandboxedCodeActivationCapability: number

Optional SearchBoxInNavBar

SearchBoxInNavBar: number

Optional SearchBoxPlaceholderText

SearchBoxPlaceholderText: string

SecondaryContact

SecondaryContact: User & UserCollections & UserCollectionMethods

Optional SensitivityLabel

SensitivityLabel: any

Optional SensitivityLabelId

SensitivityLabelId: string

Optional ServerRelativePath

ServerRelativePath: ResourcePath

Optional ServerRelativeUrl

ServerRelativeUrl: string

Optional ShareByEmailEnabled

ShareByEmailEnabled: boolean

Optional ShareByLinkEnabled

ShareByLinkEnabled: boolean

Optional ShowPeoplePickerSuggestionsForGuestUsers

ShowPeoplePickerSuggestionsForGuestUsers: boolean

Optional ShowUrlStructure

ShowUrlStructure: boolean

Optional SocialBarOnSitePagesDisabled

SocialBarOnSitePagesDisabled: boolean

Optional StatusBarLink

StatusBarLink: string

Optional StatusBarText

StatusBarText: string

Optional ThicketSupportDisabled

ThicketSupportDisabled: boolean

Optional TrimAuditLog

TrimAuditLog: boolean

Optional UIVersionConfigurationEnabled

UIVersionConfigurationEnabled: boolean

Optional UpgradeInfo

UpgradeInfo: UpgradeInfo

Optional UpgradeReminderDate

UpgradeReminderDate: any

Optional UpgradeScheduled

UpgradeScheduled: boolean

Optional UpgradeScheduledDate

UpgradeScheduledDate: any

Optional Upgrading

Upgrading: boolean

Optional Url

Url: string

Optional Usage

Usage: UsageInfo

UserCustomActions

UserCustomActions: IBaseResults<UserCustomAction> & UserCustomActionCollectionMethods

existsFl

existsFl: boolean

True, if the object exists, false otherwise.

response

response: string

The response

Methods

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>

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>

extendUpgradeReminderDate

  • extendUpgradeReminderDate(): IBaseExecution<any>

getBringYourOwnKeySiteStatus

  • getBringYourOwnKeySiteStatus(): IBaseExecution<CustomerKeyStatusInfo>

getBringYourOwnKeyTenantStatus

  • getBringYourOwnKeyTenantStatus(): IBaseExecution<CustomerKeyStatusInfo>

getCatalog

getChanges

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

getCopyJobProgress

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

getHubSiteJoinApprovalCorrelationId

  • getHubSiteJoinApprovalCorrelationId(): IBaseExecution<string>

getMigrationJobStatus

  • getMigrationJobStatus(id?: any): 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>

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>

onHubSiteJoinRequestApproved

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

onHubSiteJoinRequestCanceled

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

onHubSiteJoinRequestStarted

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

onboardTenantForBringYourOwnKey

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

openWeb

openWebById

openWebUsingPath

provisionMigrationContainers

  • provisionMigrationContainers(): IBaseExecution<ProvisionedMigrationContainersInfo>

provisionMigrationQueue

  • provisionMigrationQueue(): IBaseExecution<ProvisionedMigrationQueueInfo>

recoverTenantForBringYourOwnKey

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

registerHubSite

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

rollTenantBringYourOwnKey

  • rollTenantBringYourOwnKey(keyType?: number, keyVaultInfo?: CustomerKeyVaultInfo): 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>

stringify

  • stringify(): string

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>

Generated using TypeDoc