Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Module

Hierarchy

Implements

Index

Constructors

constructor

Properties

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.

structureTypeName

structureTypeName: string

unit

unit:

Static structureTypeName

structureTypeName: string

Static versionInfo

Methods

allProperties

deepCopyInto

delete

  • delete(): void

Protected getContainerAs

  • getContainerAs<T>(containerType: any): T

loadedProperties

publicProperties

toJSON

traverse

  • traverse(visit: function): void

traverseFind

  • traverseFind<T>(visit: function): T | null

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