Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Folder

See: relevant section in reference guide

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Accessors

container

containerAsFolderBase

containerAsProject

documents

folders

isLoadable

  • get (): boolean

isLoaded

  • get (): boolean

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

    Returns boolean

isReadOnly

  • get (): boolean

model

name

  • get (): string
  • set (newValue: string): any

  • Returns string

  • Parameters

    • newValue: string

    Returns any

unit

  • get (): this

Methods

allProperties

  • allProperties(): AbstractProperty<any, any>[]

deepCopyInto

delete

  • delete(): void

Protected getContainerAs

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

loadedProperties

  • loadedProperties(): AbstractProperty<any, any>[]

publicProperties

  • publicProperties(): AbstractProperty<any, any>[]

toJSON

traverse

  • traverse(visit: function): void

traverseFind

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

traversePublicParts

  • traversePublicParts(visit: function): void

Static createIn

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

    Parameters

    Returns Folder

Generated using TypeDoc