Class Web

Hierarchy

Index

Methods

Methods

public applyTheme(colorPaletteUrl: string, fontSchemeUrl: string, backgroundImageUrl: string, shareGenerated: boolean)

Parameters

  • colorPaletteUrl: string
  • fontSchemeUrl: string
  • backgroundImageUrl: string
  • shareGenerated: boolean

public applyWebTemplate(webTemplate: string)

Parameters

  • webTemplate: string

public breakRoleInheritance(copyRoleAssignments: boolean, clearSubscopes: boolean)

Parameters

  • copyRoleAssignments: boolean
  • clearSubscopes: boolean

public customFromJson(initValue: any): boolean

Parameters

  • initValue: any

Returns

boolean

public deleteObject()

public doesPushNotificationSubscriberExist(deviceAppInstanceId: Guid): BooleanResult

Parameters

  • deviceAppInstanceId: Guid

Returns

BooleanResult

public doesUserHavePermissions(permissionMask: BasePermissions): BooleanResult

Parameters

Returns

BooleanResult

public ensureUser(logonName: string): User

Parameters

  • logonName: string

Returns

User

public fromJson(initValue: any)

Parameters

  • initValue: any

public getAppBdcCatalog(): AppBdcCatalog

Returns

AppBdcCatalog

public getAppBdcCatalogForAppInstance(appInstanceId: Guid): AppBdcCatalog

Parameters

  • appInstanceId: Guid

Returns

AppBdcCatalog

public getAppInstanceById(appInstanceId: Guid): AppInstance

Parameters

  • appInstanceId: Guid

Returns

AppInstance

public getAppInstancesByProductId(productId: Guid): ClientObjectList

Parameters

Returns

ClientObjectList

public getAvailableWebTemplates(lcid: number, doIncludeCrossLanguage: boolean): WebTemplateCollection

Parameters

  • lcid: number
  • doIncludeCrossLanguage: boolean

Returns

WebTemplateCollection

public getCatalog(typeCatalog: number): List

Parameters

  • typeCatalog: number

Returns

List

public getChanges(query: ChangeQuery): ChangeCollection

Parameters

Returns

ChangeCollection

public getEntity(namespace: string, name: string): Entity

Parameters

  • namespace: string
  • name: string

Returns

Entity

public getFileByServerRelativeUrl(serverRelativeUrl: string): File

Parameters

  • serverRelativeUrl: string

Returns

File

public getFolderByServerRelativeUrl(serverRelativeUrl: string): Folder

Parameters

  • serverRelativeUrl: string

Returns

Folder

public getPushNotificationSubscriber(deviceAppInstanceId: Guid): PushNotificationSubscriber

Parameters

  • deviceAppInstanceId: Guid

Returns

PushNotificationSubscriber

public getPushNotificationSubscribersByArgs(customArgs: string): PushNotificationSubscriberCollection

Parameters

  • customArgs: string

Returns

PushNotificationSubscriberCollection

public getPushNotificationSubscribersByUser(userName: string): PushNotificationSubscriberCollection

Parameters

  • userName: string

Returns

PushNotificationSubscriberCollection

public getSubwebsForCurrentUser(query: SubwebQuery): WebCollection

Parameters

Returns

WebCollection

public getUserById(userId: number): User

Parameters

  • userId: number

Returns

User

public getUserEffectivePermissions(userName: string): BasePermissions

Parameters

  • userName: string

Returns

BasePermissions

public get_allProperties(): PropertyValues

Returns

PropertyValues

public get_allowDesignerForCurrentUser(): boolean

Returns

boolean

public get_allowMasterPageEditingForCurrentUser(): boolean

Returns

boolean

public get_allowRevertFromTemplateForCurrentUser(): boolean

Returns

boolean

public get_allowRssFeeds(): boolean

Returns

boolean

public get_appInstanceId(): Guid

Returns

Guid

public get_associatedMemberGroup(): Group

Returns

Group

public get_associatedOwnerGroup(): Group

Returns

Group

public get_associatedVisitorGroup(): Group

Returns

Group

public get_availableContentTypes(): ContentTypeCollection

Returns

ContentTypeCollection

public get_availableFields(): FieldCollection

Returns

FieldCollection

public get_configuration(): number

Returns

number

public get_contentTypes(): ContentTypeCollection

Returns

ContentTypeCollection

public get_context(): ClientRuntimeContext

Returns

ClientRuntimeContext

public get_created(): Date

Returns

Date

public get_currentUser(): User

Returns

User

public get_customMasterUrl(): string

Returns

string

public get_description(): string

Returns

string

public get_documentLibraryCalloutOfficeWebAppPreviewersDisabled(): boolean

Returns

boolean

public get_effectiveBasePermissions(): BasePermissions

Returns

BasePermissions

public get_enableMinimalDownload(): boolean

Returns

boolean

public get_eventReceivers(): EventReceiverDefinitionCollection

Returns

EventReceiverDefinitionCollection

public get_features(): FeatureCollection

Returns

FeatureCollection

public get_fields(): FieldCollection

Returns

FieldCollection

public get_firstUniqueAncestorSecurableObject(): SecurableObject

Returns

SecurableObject

public get_folders(): FolderCollection

Returns

FolderCollection

public get_hasUniqueRoleAssignments(): boolean

Returns

boolean

public get_id(): Guid

Returns

Guid

public get_language(): number

Returns

number

public get_lastItemModifiedDate(): Date

Returns

Date

public get_listTemplates(): ListTemplateCollection

Returns

ListTemplateCollection

public get_lists(): ListCollection

Returns

ListCollection

public get_masterUrl(): string

Returns

string

public get_navigation(): Navigation

Returns

Navigation

public get_objectVersion(): string

Returns

string

public get_parentWeb(): WebInformation

Returns

WebInformation

public get_path(): ObjectPath

Returns

ObjectPath

public get_pushNotificationSubscribers(): PushNotificationSubscriberCollection

Returns

PushNotificationSubscriberCollection

public get_quickLaunchEnabled(): boolean

Returns

boolean

public get_recycleBin(): RecycleBinItemCollection

Returns

RecycleBinItemCollection

public get_recycleBinEnabled(): boolean

Returns

boolean

public get_regionalSettings(): RegionalSettings

Returns

RegionalSettings

public get_roleAssignments(): RoleAssignmentCollection

Returns

RoleAssignmentCollection

public get_roleDefinitions(): RoleDefinitionCollection

Returns

RoleDefinitionCollection

public get_rootFolder(): Folder

Returns

Folder

public get_saveSiteAsTemplateEnabled(): boolean

Returns

boolean

public get_serverObjectIsNull(): boolean

Returns

boolean

public get_serverRelativeUrl(): string

Returns

string

public get_showUrlStructureForCurrentUser(): boolean

Returns

boolean

public get_siteGroups(): GroupCollection

Returns

GroupCollection

public get_siteUserInfoList(): List

Returns

List

public get_siteUsers(): UserCollection

Returns

UserCollection

public get_supportedUILanguageIds(): Array<number>

Returns

Array<number>

public get_syndicationEnabled(): boolean

Returns

boolean

public get_themeInfo(): ThemeInfo

Returns

ThemeInfo

public get_title(): string

Returns

string

public get_treeViewEnabled(): boolean

Returns

boolean

public get_typedObject(): ClientObject

Returns

ClientObject

public get_uIVersion(): number

Returns

number

public get_uIVersionConfigurationEnabled(): boolean

Returns

boolean

public get_url(): string

Returns

string

public get_userCustomActions(): UserCustomActionCollection

Returns

UserCustomActionCollection

public get_webTemplate(): string

Returns

string

public get_webs(): WebCollection

Returns

WebCollection

public get_workflowAssociations(): WorkflowAssociationCollection

Returns

WorkflowAssociationCollection

public get_workflowTemplates(): WorkflowTemplateCollection

Returns

WorkflowTemplateCollection

public isObjectPropertyInstantiated(propertyName: string): boolean

Parameters

  • propertyName: string

Returns

boolean

public isPropertyAvailable(propertyName: string): boolean

Parameters

  • propertyName: string

Returns

boolean

public loadAndInstallApp(appPackageStream: Array<any>): AppInstance

Parameters

  • appPackageStream: Array<any>

Returns

AppInstance

public loadAndInstallAppInSpecifiedLocale(appPackageStream: Array<any>, installationLocaleLCID: number): AppInstance

Parameters

  • appPackageStream: Array<any>
  • installationLocaleLCID: number

Returns

AppInstance

public loadApp(appPackageStream: Array<any>, installationLocaleLCID: number): AppInstance

Parameters

  • appPackageStream: Array<any>
  • installationLocaleLCID: number

Returns

AppInstance

public mapToIcon(fileName: string, progId: string, size: IconSize): StringResult

Parameters

  • fileName: string
  • progId: string
  • size: IconSize

Returns

StringResult

public refreshLoad()

public registerPushNotificationSubscriber(deviceAppInstanceId: Guid, serviceToken: string): PushNotificationSubscriber

Parameters

  • deviceAppInstanceId: Guid
  • serviceToken: string

Returns

PushNotificationSubscriber

public resetRoleInheritance()

public retrieve()

public retrieve(propertyNames: Array<string>)

Parameters

  • propertyNames: Array<string>

public set_associatedMemberGroup(value: Group)

Parameters

public set_associatedOwnerGroup(value: Group)

Parameters

public set_associatedVisitorGroup(value: Group)

Parameters

public set_customMasterUrl(value: string)

Parameters

  • value: string

public set_description(value: string)

Parameters

  • value: string

public set_enableMinimalDownload(value: boolean)

Parameters

  • value: boolean

public set_masterUrl(value: string)

Parameters

  • value: string

public set_objectVersion(value: string)

Parameters

  • value: string

public set_quickLaunchEnabled(value: boolean)

Parameters

  • value: boolean

public set_saveSiteAsTemplateEnabled(value: boolean)

Parameters

  • value: boolean

public set_serverRelativeUrl(value: string)

Parameters

  • value: string

public set_syndicationEnabled(value: boolean)

Parameters

  • value: boolean

public set_title(value: string)

Parameters

  • value: string

public set_treeViewEnabled(value: boolean)

Parameters

  • value: boolean

public set_uIVersion(value: number)

Parameters

  • value: number

public set_uIVersionConfigurationEnabled(value: boolean)

Parameters

  • value: boolean

public unregisterPushNotificationSubscriber(deviceAppInstanceId: Guid)

Parameters

  • deviceAppInstanceId: Guid

public update()