Class Site

Hierarchy

Index

Methods

Methods

public createPreviewSPSite(upgrade: boolean, sendemail: boolean)

Parameters

  • upgrade: boolean
  • sendemail: boolean

public customFromJson(initValue: any): boolean

Parameters

  • initValue: any

Returns

boolean

public extendUpgradeReminderDate()

public fromJson(initValue: any)

Parameters

  • initValue: any

public getCatalog(typeCatalog: number): List

Parameters

  • typeCatalog: number

Returns

List

public getChanges(query: ChangeQuery): ChangeCollection

Parameters

Returns

ChangeCollection

public getCustomListTemplates(web: Web): ListTemplateCollection

Parameters

Returns

ListTemplateCollection

public getWebTemplates(LCID: number, overrideCompatLevel: number): WebTemplateCollection

Parameters

  • LCID: number
  • overrideCompatLevel: number

Returns

WebTemplateCollection

public get_allowDesigner(): boolean

Returns

boolean

public get_allowMasterPageEditing(): boolean

Returns

boolean

public get_allowRevertFromTemplate(): boolean

Returns

boolean

public get_allowSelfServiceUpgrade(): boolean

Returns

boolean

public get_allowSelfServiceUpgradeEvaluation(): boolean

Returns

boolean

public get_canUpgrade(): boolean

Returns

boolean

public get_compatibilityLevel(): number

Returns

number

public get_context(): ClientRuntimeContext

Returns

ClientRuntimeContext

public get_eventReceivers(): EventReceiverDefinitionCollection

Returns

EventReceiverDefinitionCollection

public get_features(): FeatureCollection

Returns

FeatureCollection

public get_id(): Guid

Returns

Guid

public get_lockIssue(): string

Returns

string

public get_maxItemsPerThrottledOperation(): number

Returns

number

public get_objectVersion(): string

Returns

string

public get_owner(): User

Returns

User

public get_path(): ObjectPath

Returns

ObjectPath

public get_primaryUri(): string

Returns

string

public get_readOnly(): boolean

Returns

boolean

public get_recycleBin(): RecycleBinItemCollection

Returns

RecycleBinItemCollection

public get_rootWeb(): Web

Returns

Web

public get_serverObjectIsNull(): boolean

Returns

boolean

public get_serverRelativeUrl(): string

Returns

string

public get_shareByLinkEnabled(): boolean

Returns

boolean

public get_showUrlStructure(): boolean

Returns

boolean

public get_typedObject(): ClientObject

Returns

ClientObject

public get_uIVersionConfigurationEnabled(): boolean

Returns

boolean

public get_upgradeInfo(): UpgradeInfo

Returns

UpgradeInfo

public get_upgradeReminderDate(): Date

Returns

Date

public get_upgrading(): boolean

Returns

boolean

public get_url(): string

Returns

string

public get_usage(): UsageInfo

Returns

UsageInfo

public get_userCustomActions(): UserCustomActionCollection

Returns

UserCustomActionCollection

public invalidate()

public isObjectPropertyInstantiated(propertyName: string): boolean

Parameters

  • propertyName: string

Returns

boolean

public isPropertyAvailable(propertyName: string): boolean

Parameters

  • propertyName: string

Returns

boolean

public needsUpgradeByType(versionUpgrade: boolean, recursive: boolean): BooleanResult

Parameters

  • versionUpgrade: boolean
  • recursive: boolean

Returns

BooleanResult

public openWeb(strUrl: string): Web

Parameters

  • strUrl: string

Returns

Web

public openWebById(gWebId: Guid): Web

Parameters

Returns

Web

public refreshLoad()

public retrieve()

public retrieve(propertyNames: Array<string>)

Parameters

  • propertyNames: Array<string>

public runHealthCheck(ruleId: Guid, bRepair: boolean, bRunAlways: boolean): SiteHealthSummary

Parameters

  • ruleId: Guid
  • bRepair: boolean
  • bRunAlways: boolean

Returns

SiteHealthSummary

public runUpgradeSiteSession(versionUpgrade: boolean, queueOnly: boolean, sendEmail: boolean)

Parameters

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

public set_allowDesigner(value: boolean)

Parameters

  • value: boolean

public set_allowMasterPageEditing(value: boolean)

Parameters

  • value: boolean

public set_allowRevertFromTemplate(value: boolean)

Parameters

  • value: boolean

public set_allowSelfServiceUpgrade(value: boolean)

Parameters

  • value: boolean

public set_allowSelfServiceUpgradeEvaluation(value: boolean)

Parameters

  • value: boolean

public set_objectVersion(value: string)

Parameters

  • value: string

public set_owner(value: User)

Parameters

public set_showUrlStructure(value: boolean)

Parameters

  • value: boolean

public set_uIVersionConfigurationEnabled(value: boolean)

Parameters

  • value: boolean

public updateClientObjectModelUseRemoteAPIsPermissionSetting(requireUseRemoteAPIs: boolean)

Parameters

  • requireUseRemoteAPIs: boolean