Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Module

Hierarchy

Implements

Index

Constructors

constructor

Properties

Private ___appStoreGuid

___appStoreGuid: any

Private ___appStoreVersion

___appStoreVersion: any

Private ___appStoreVersionGuid

___appStoreVersionGuid: any

Private ___domainModel

___domainModel: any

Private ___fromAppStore

___fromAppStore: any

Private ___moduleSecurity

___moduleSecurity: any

Private ___name

___name: any

Private ___sortIndex

___sortIndex: any

appStoreGuid

appStoreGuid: string

appStoreVersion

appStoreVersion: string

appStoreVersionGuid

appStoreVersionGuid: string

container

container: StructuralUnit

containerAsFolderBase

containerAsFolderBase: FolderBase

containerAsProject

containerAsProject: Project

documents

documents: IList<IDocument>

domainModel

domainModel: IDomainModel

folders

folders: IList<IFolder>

fromAppStore

fromAppStore: boolean

id

id: string

isLoaded

isLoaded: boolean

Checks whether all attributes are available at this instant; if false, a load is required to access these properties.

model

model: IModel

moduleSecurity

moduleSecurity: IModuleSecurity

name

name: string

sortIndex

sortIndex: number

The index of where this Module appears in the project. This property is required, and of type double. Also, its value needs to be unique among its siblings (meaning, in code: containerAsProject.modules) in the project. In other words: containerAsProject.modules.map(m => m.sortedIndex) (TS syntax) needs to be a list with unique values.

typeName

typeName: string

unit

unit:

versionInfo

Static typeName

typeName: string

Static versionInfo

Methods

Protected _scheduleDeltaAfterCreate

  • _scheduleDeltaAfterCreate(delta: IDelta): void

Protected _sendDeleteDelta

  • _sendDeleteDelta(): void

Protected _updateWithJsonImpl

allProperties

deepCopyInto

delete

  • delete(): void
  • Deletes a model from the model. This will automatically remove the item from its model parent, and update incoming references and send server changes.

    Returns void

Protected getContainerAs

toJSON

  • toJSON(): Object

traverse

  • traverse(visit: function): void

traversePublicParts

  • traversePublicParts(visit: function): void

Static createIn

  • Creates a new Module unit in the SDK and on the server. Expects one argument, the IProject in which this unit is contained.

    Parameters

    Returns Module

Generated using TypeDoc